SDK for PHP 3.x

AWS CodeStar Notifications 2019-10-15

Client: Aws\CodeStarNotifications\CodeStarNotificationsClient
Service ID: codestar-notifications
Version: 2019-10-15

This page describes the parameters and results for the operations of the AWS CodeStar Notifications (2019-10-15), and shows how to use the Aws\CodeStarNotifications\CodeStarNotificationsClient object to call the described operations. This documentation is specific to the 2019-10-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateNotificationRule ( array $params = [] )
Creates a notification rule for a resource.
DeleteNotificationRule ( array $params = [] )
Deletes a notification rule for a resource.
DeleteTarget ( array $params = [] )
Deletes a specified target for notifications.
DescribeNotificationRule ( array $params = [] )
Returns information about a specified notification rule.
ListEventTypes ( array $params = [] )
Returns information about the event types available for configuring notifications.
ListNotificationRules ( array $params = [] )
Returns a list of the notification rules for an Amazon Web Services account.
ListTagsForResource ( array $params = [] )
Returns a list of the tags associated with a notification rule.
ListTargets ( array $params = [] )
Returns a list of the notification rule targets for an Amazon Web Services account.
Subscribe ( array $params = [] )
Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.
TagResource ( array $params = [] )
Associates a set of provided tags with a notification rule.
Unsubscribe ( array $params = [] )
Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
UntagResource ( array $params = [] )
Removes the association between one or more provided tags and a notification rule.
UpdateNotificationRule ( array $params = [] )
Updates a notification rule for a resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEventTypes
ListNotificationRules
ListTargets

Operations

CreateNotificationRule 

$result = $client->createNotificationRule([/* ... */]);
$promise = $client->createNotificationRuleAsync([/* ... */]);

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.

Parameter Syntax

$result = $client->createNotificationRule([
    'ClientRequestToken' => '<string>',
    'DetailType' => 'BASIC|FULL', // REQUIRED
    'EventTypeIds' => ['<string>', ...], // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Resource' => '<string>', // REQUIRED
    'Status' => 'ENABLED|DISABLED',
    'Tags' => ['<string>', ...],
    'Targets' => [ // REQUIRED
        [
            'TargetAddress' => '<string>',
            'TargetType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

DetailType
Required: Yes
Type: string

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

EventTypeIds
Required: Yes
Type: Array of strings

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

Name
Required: Yes
Type: string

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

Resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

Status
Type: string

The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to apply to this notification rule. Key names cannot start with "aws".

Targets
Required: Yes
Type: Array of Target structures

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the notification rule.

Errors

ResourceAlreadyExistsException:

A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.

ValidationException:

One or more parameter values are not valid.

LimitExceededException:

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

ConfigurationException:

Some or all of the configuration is incomplete, missing, or not valid.

ConcurrentModificationException:

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

AccessDeniedException:

AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.

DeleteNotificationRule 

$result = $client->deleteNotificationRule([/* ... */]);
$promise = $client->deleteNotificationRuleAsync([/* ... */]);

Deletes a notification rule for a resource.

Parameter Syntax

$result = $client->deleteNotificationRule([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule you want to delete.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the deleted notification rule.

Errors

ValidationException:

One or more parameter values are not valid.

LimitExceededException:

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

ConcurrentModificationException:

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

DeleteTarget 

$result = $client->deleteTarget([/* ... */]);
$promise = $client->deleteTargetAsync([/* ... */]);

Deletes a specified target for notifications.

Parameter Syntax

$result = $client->deleteTarget([
    'ForceUnsubscribeAll' => true || false,
    'TargetAddress' => '<string>', // REQUIRED
]);

Parameter Details

Members
ForceUnsubscribeAll
Type: boolean

A Boolean value that can be used to delete all associations with this Chatbot topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your Amazon Web Services account are deleted.

TargetAddress
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

One or more parameter values are not valid.

DescribeNotificationRule 

$result = $client->describeNotificationRule([/* ... */]);
$promise = $client->describeNotificationRuleAsync([/* ... */]);

Returns information about a specified notification rule.

Parameter Syntax

$result = $client->describeNotificationRule([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedBy' => '<string>',
    'CreatedTimestamp' => <DateTime>,
    'DetailType' => 'BASIC|FULL',
    'EventTypes' => [
        [
            'EventTypeId' => '<string>',
            'EventTypeName' => '<string>',
            'ResourceType' => '<string>',
            'ServiceName' => '<string>',
        ],
        // ...
    ],
    'LastModifiedTimestamp' => <DateTime>,
    'Name' => '<string>',
    'Resource' => '<string>',
    'Status' => 'ENABLED|DISABLED',
    'Tags' => ['<string>', ...],
    'Targets' => [
        [
            'TargetAddress' => '<string>',
            'TargetStatus' => 'PENDING|ACTIVE|UNREACHABLE|INACTIVE|DEACTIVATED',
            'TargetType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule.

CreatedBy
Type: string

The name or email alias of the person who created the notification rule.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the notification rule was created, in timestamp format.

DetailType
Type: string

The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

EventTypes
Type: Array of EventTypeSummary structures

A list of the event types associated with the notification rule.

LastModifiedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the notification rule was most recently updated, in timestamp format.

Name
Type: string

The name of the notification rule.

Resource
Type: string

The Amazon Resource Name (ARN) of the resource associated with the notification rule.

Status
Type: string

The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the notification rule.

Targets
Type: Array of TargetSummary structures

A list of the Chatbot topics and Chatbot clients associated with the notification rule.

Errors

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

ValidationException:

One or more parameter values are not valid.

ListEventTypes 

$result = $client->listEventTypes([/* ... */]);
$promise = $client->listEventTypesAsync([/* ... */]);

Returns information about the event types available for configuring notifications.

Parameter Syntax

$result = $client->listEventTypes([
    'Filters' => [
        [
            'Name' => 'RESOURCE_TYPE|SERVICE_NAME', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of ListEventTypesFilter structures

The filters to use to return information by service or resource type.

MaxResults
Type: int

A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of results that can be returned is 100.

NextToken
Type: string

An enumeration token that, when provided in a request, returns the next batch of the results.

Result Syntax

[
    'EventTypes' => [
        [
            'EventTypeId' => '<string>',
            'EventTypeName' => '<string>',
            'ResourceType' => '<string>',
            'ServiceName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
EventTypes
Type: Array of EventTypeSummary structures

Information about each event, including service name, resource type, event ID, and event name.

NextToken
Type: string

An enumeration token that can be used in a request to return the next batch of the results.

Errors

InvalidNextTokenException:

The value for the enumeration token used in the request to return the next batch of the results is not valid.

ValidationException:

One or more parameter values are not valid.

ListNotificationRules 

$result = $client->listNotificationRules([/* ... */]);
$promise = $client->listNotificationRulesAsync([/* ... */]);

Returns a list of the notification rules for an Amazon Web Services account.

Parameter Syntax

$result = $client->listNotificationRules([
    'Filters' => [
        [
            'Name' => 'EVENT_TYPE_ID|CREATED_BY|RESOURCE|TARGET_ADDRESS', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of ListNotificationRulesFilter structures

The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter.

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

MaxResults
Type: int

A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

NextToken
Type: string

An enumeration token that, when provided in a request, returns the next batch of the results.

Result Syntax

[
    'NextToken' => '<string>',
    'NotificationRules' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

An enumeration token that can be used in a request to return the next batch of the results.

NotificationRules
Type: Array of NotificationRuleSummary structures

The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID.

Errors

InvalidNextTokenException:

The value for the enumeration token used in the request to return the next batch of the results is not valid.

ValidationException:

One or more parameter values are not valid.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of the tags associated with a notification rule.

Parameter Syntax

$result = $client->listTagsForResource([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the notification rule.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the notification rule.

Errors

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

ValidationException:

One or more parameter values are not valid.

ListTargets 

$result = $client->listTargets([/* ... */]);
$promise = $client->listTargetsAsync([/* ... */]);

Returns a list of the notification rule targets for an Amazon Web Services account.

Parameter Syntax

$result = $client->listTargets([
    'Filters' => [
        [
            'Name' => 'TARGET_TYPE|TARGET_ADDRESS|TARGET_STATUS', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of ListTargetsFilter structures

The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

MaxResults
Type: int

A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

NextToken
Type: string

An enumeration token that, when provided in a request, returns the next batch of the results.

Result Syntax

[
    'NextToken' => '<string>',
    'Targets' => [
        [
            'TargetAddress' => '<string>',
            'TargetStatus' => 'PENDING|ACTIVE|UNREACHABLE|INACTIVE|DEACTIVATED',
            'TargetType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

An enumeration token that can be used in a request to return the next batch of results.

Targets
Type: Array of TargetSummary structures

The list of notification rule targets.

Errors

InvalidNextTokenException:

The value for the enumeration token used in the request to return the next batch of the results is not valid.

ValidationException:

One or more parameter values are not valid.

Subscribe 

$result = $client->subscribe([/* ... */]);
$promise = $client->subscribeAsync([/* ... */]);

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.

Parameter Syntax

$result = $client->subscribe([
    'Arn' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'Target' => [ // REQUIRED
        'TargetAddress' => '<string>',
        'TargetType' => '<string>',
    ],
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

ClientRequestToken
Type: string

An enumeration token that, when provided in a request, returns the next batch of the results.

Target
Required: Yes
Type: Target structure

Information about the Chatbot topics or Chatbot clients associated with a notification rule.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

Errors

ValidationException:

One or more parameter values are not valid.

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

ConfigurationException:

Some or all of the configuration is incomplete, missing, or not valid.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates a set of provided tags with a notification rule.

Parameter Syntax

$result = $client->tagResource([
    'Arn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule to tag.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags to associate with the resource. Tag key names cannot start with "aws".

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags associated with the resource.

Errors

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

LimitExceededException:

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

ValidationException:

One or more parameter values are not valid.

ConcurrentModificationException:

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

Unsubscribe 

$result = $client->unsubscribe([/* ... */]);
$promise = $client->unsubscribeAsync([/* ... */]);

Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.

Parameter Syntax

$result = $client->unsubscribe([
    'Arn' => '<string>', // REQUIRED
    'TargetAddress' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule.

TargetAddress
Required: Yes
Type: string

The ARN of the Chatbot topic to unsubscribe from the notification rule.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.

Errors

ValidationException:

One or more parameter values are not valid.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the association between one or more provided tags and a notification rule.

Parameter Syntax

$result = $client->untagResource([
    'Arn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.

TagKeys
Required: Yes
Type: Array of strings

The key names of the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

LimitExceededException:

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

ValidationException:

One or more parameter values are not valid.

ConcurrentModificationException:

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

UpdateNotificationRule 

$result = $client->updateNotificationRule([/* ... */]);
$promise = $client->updateNotificationRuleAsync([/* ... */]);

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

Parameter Syntax

$result = $client->updateNotificationRule([
    'Arn' => '<string>', // REQUIRED
    'DetailType' => 'BASIC|FULL',
    'EventTypeIds' => ['<string>', ...],
    'Name' => '<string>',
    'Status' => 'ENABLED|DISABLED',
    'Targets' => [
        [
            'TargetAddress' => '<string>',
            'TargetType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the notification rule.

DetailType
Type: string

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

EventTypeIds
Type: Array of strings

A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

Name
Type: string

The name of the notification rule.

Status
Type: string

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

Targets
Type: Array of Target structures

The address and type of the targets to receive notifications from this notification rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

One or more parameter values are not valid.

ResourceNotFoundException:

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

ConfigurationException:

Some or all of the configuration is incomplete, missing, or not valid.

Shapes

AccessDeniedException

Description

AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.

Members
Message
Type: string

ConcurrentModificationException

Description

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

Members
Message
Type: string

ConfigurationException

Description

Some or all of the configuration is incomplete, missing, or not valid.

Members
Message
Type: string

EventTypeSummary

Description

Returns information about an event that has triggered a notification rule.

Members
EventTypeId
Type: string

The system-generated ID of the event. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

EventTypeName
Type: string

The name of the event.

ResourceType
Type: string

The resource type of the event.

ServiceName
Type: string

The name of the service for which the event applies.

InvalidNextTokenException

Description

The value for the enumeration token used in the request to return the next batch of the results is not valid.

Members
Message
Type: string

LimitExceededException

Description

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

Members
Message
Type: string

ListEventTypesFilter

Description

Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.

Members
Name
Required: Yes
Type: string

The system-generated name of the filter type you want to filter by.

Value
Required: Yes
Type: string

The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.

ListNotificationRulesFilter

Description

Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.

Members
Name
Required: Yes
Type: string

The name of the attribute you want to use to filter the returned notification rules.

Value
Required: Yes
Type: string

The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE in Name, you might specify the ARN of a pipeline in CodePipeline for the value.

ListTargetsFilter

Description

Information about a filter to apply to the list of returned targets. You can filter by target type, address, or status. For example, to filter results to notification rules that have active Chatbot topics as targets, you could specify a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.

Members
Name
Required: Yes
Type: string

The name of the attribute you want to use to filter the returned targets.

Value
Required: Yes
Type: string

The value of the attribute you want to use to filter the returned targets. For example, if you specify SNS for the Target type, you could specify an Amazon Resource Name (ARN) for a topic as the value.

NotificationRuleSummary

Description

Information about a specified notification rule.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the notification rule.

Id
Type: string

The unique ID of the notification rule.

ResourceAlreadyExistsException

Description

A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.

Members
Message
Type: string

ResourceNotFoundException

Description

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

Members
Message
Type: string

Target

Description

Information about the Chatbot topics or Chatbot clients associated with a notification rule.

Members
TargetAddress
Type: string

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

TargetType
Type: string

The target type. Can be an Chatbot topic or Chatbot client.

  • Chatbot topics are specified as SNS.

  • Chatbot clients are specified as AWSChatbotSlack.

TargetSummary

Description

Information about the targets specified for a notification rule.

Members
TargetAddress
Type: string

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

TargetStatus
Type: string

The status of the target.

TargetType
Type: string

The type of the target (for example, SNS).

  • Chatbot topics are specified as SNS.

  • Chatbot clients are specified as AWSChatbotSlack.

ValidationException

Description

One or more parameter values are not valid.

Members
Message
Type: string