This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API to work with the following objects:
Notification rules, by calling the following:
CreateNotificationRule, which creates a notification rule for a resource in your account.
DeleteNotificationRule, which deletes a notification rule.
DescribeNotificationRule, which provides information about a notification rule.
ListNotificationRules, which lists the notification rules associated with your account.
UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.
Subscribe, which subscribes a target to a notification rule.
Unsubscribe, which removes a target from a notification rule.
Targets, by calling the following:
DeleteTarget, which removes a notification rule target from a notification rule.
ListTargets, which lists the targets associated with a notification rule.
Events, by calling the following:
ListEventTypes, which lists the event types you can include in a notification rule.
Tags, by calling the following:
ListTagsForResource, which lists the tags already associated with a notification rule in your account.
TagResource, which associates a tag you provide with a notification rule in your account.
UntagResource, which removes a tag from a notification rule in your account.
For information about how to use AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide.
', 'operations' => [ 'CreateNotificationRule' => '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.
', 'DeleteNotificationRule' => 'Deletes a notification rule for a resource.
', 'DeleteTarget' => 'Deletes a specified target for notifications.
', 'DescribeNotificationRule' => 'Returns information about a specified notification rule.
', 'ListEventTypes' => 'Returns information about the event types available for configuring notifications.
', 'ListNotificationRules' => 'Returns a list of the notification rules for an Amazon Web Services account.
', 'ListTagsForResource' => 'Returns a list of the tags associated with a notification rule.
', 'ListTargets' => 'Returns a list of the notification rule targets for an Amazon Web Services account.
', 'Subscribe' => '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' => 'Associates a set of provided tags with a notification rule.
', 'Unsubscribe' => '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' => 'Removes the association between one or more provided tags and a notification rule.
', 'UpdateNotificationRule' => '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.
AWS CodeStar Notifications can\'t create the notification rule because you do not have sufficient permissions.
', 'refs' => [], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$ClientRequestToken' => '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.
An enumeration token that, when provided in a request, returns the next batch of the results.
', ], ], 'ConcurrentModificationException' => [ 'base' => 'AWS CodeStar Notifications can\'t complete the request because the resource is being modified by another process. Wait a few minutes and try again.
', 'refs' => [], ], 'ConfigurationException' => [ 'base' => 'Some or all of the configuration is incomplete, missing, or not valid.
', 'refs' => [], ], 'CreateNotificationRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotificationRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'CreatedTimestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationRuleResult$CreatedTimestamp' => 'The date and time the notification rule was created, in timestamp format.
', ], ], 'DeleteNotificationRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotificationRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTargetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTargetResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'DetailType' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$DetailType' => '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.
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.
', 'UpdateNotificationRuleRequest$DetailType' => '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.
', ], ], 'EventTypeBatch' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationRuleResult$EventTypes' => 'A list of the event types associated with the notification rule.
', 'ListEventTypesResult$EventTypes' => 'Information about each event, including service name, resource type, event ID, and event name.
', ], ], 'EventTypeId' => [ 'base' => NULL, 'refs' => [ 'EventTypeIds$member' => NULL, 'EventTypeSummary$EventTypeId' => '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.
', ], ], 'EventTypeIds' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$EventTypeIds' => 'A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
', 'UpdateNotificationRuleRequest$EventTypeIds' => '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.
', ], ], 'EventTypeName' => [ 'base' => NULL, 'refs' => [ 'EventTypeSummary$EventTypeName' => 'The name of the event.
', ], ], 'EventTypeSummary' => [ 'base' => 'Returns information about an event that has triggered a notification rule.
', 'refs' => [ 'EventTypeBatch$member' => NULL, ], ], 'ForceUnsubscribeAll' => [ 'base' => NULL, 'refs' => [ 'DeleteTargetRequest$ForceUnsubscribeAll' => '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.
', ], ], 'InvalidNextTokenException' => [ 'base' => 'The value for the enumeration token used in the request to return the next batch of the results is not valid.
', 'refs' => [], ], 'LastModifiedTimestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationRuleResult$LastModifiedTimestamp' => 'The date and time the notification rule was most recently updated, in timestamp format.
', ], ], 'LimitExceededException' => [ 'base' => '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.
', 'refs' => [], ], 'ListEventTypesFilter' => [ 'base' => 'Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
', 'refs' => [ 'ListEventTypesFilters$member' => NULL, ], ], 'ListEventTypesFilterName' => [ 'base' => NULL, 'refs' => [ 'ListEventTypesFilter$Name' => 'The system-generated name of the filter type you want to filter by.
', ], ], 'ListEventTypesFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListEventTypesFilter$Value' => 'The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.
', ], ], 'ListEventTypesFilters' => [ 'base' => NULL, 'refs' => [ 'ListEventTypesRequest$Filters' => 'The filters to use to return information by service or resource type.
', ], ], 'ListEventTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventTypesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListNotificationRulesFilter' => [ 'base' => 'Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
', 'refs' => [ 'ListNotificationRulesFilters$member' => NULL, ], ], 'ListNotificationRulesFilterName' => [ 'base' => NULL, 'refs' => [ 'ListNotificationRulesFilter$Name' => 'The name of the attribute you want to use to filter the returned notification rules.
', ], ], 'ListNotificationRulesFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListNotificationRulesFilter$Value' => '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.
', ], ], 'ListNotificationRulesFilters' => [ 'base' => NULL, 'refs' => [ 'ListNotificationRulesRequest$Filters' => '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.
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.
The name of the attribute you want to use to filter the returned targets.
', ], ], 'ListTargetsFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListTargetsFilter$Value' => '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.
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.
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.
', 'ListNotificationRulesRequest$MaxResults' => 'A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
', 'ListTargetsRequest$MaxResults' => 'A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConcurrentModificationException$Message' => NULL, 'ConfigurationException$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ResourceAlreadyExistsException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListEventTypesRequest$NextToken' => 'An enumeration token that, when provided in a request, returns the next batch of the results.
', 'ListEventTypesResult$NextToken' => 'An enumeration token that can be used in a request to return the next batch of the results.
', 'ListNotificationRulesRequest$NextToken' => 'An enumeration token that, when provided in a request, returns the next batch of the results.
', 'ListNotificationRulesResult$NextToken' => 'An enumeration token that can be used in a request to return the next batch of the results.
', 'ListTargetsRequest$NextToken' => 'An enumeration token that, when provided in a request, returns the next batch of the results.
', 'ListTargetsResult$NextToken' => 'An enumeration token that can be used in a request to return the next batch of results.
', ], ], 'NotificationRuleArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleResult$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', 'DeleteNotificationRuleRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule you want to delete.
', 'DeleteNotificationRuleResult$Arn' => 'The Amazon Resource Name (ARN) of the deleted notification rule.
', 'DescribeNotificationRuleRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', 'DescribeNotificationRuleResult$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', 'ListTagsForResourceRequest$Arn' => 'The Amazon Resource Name (ARN) for the notification rule.
', 'NotificationRuleSummary$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', 'SubscribeRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
', 'SubscribeResult$Arn' => 'The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.
', 'TagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule to tag.
', 'UnsubscribeRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', 'UnsubscribeResult$Arn' => 'The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.
', 'UntagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
', 'UpdateNotificationRuleRequest$Arn' => 'The Amazon Resource Name (ARN) of the notification rule.
', ], ], 'NotificationRuleBatch' => [ 'base' => NULL, 'refs' => [ 'ListNotificationRulesResult$NotificationRules' => 'The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID.
', ], ], 'NotificationRuleCreatedBy' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationRuleResult$CreatedBy' => 'The name or email alias of the person who created the notification rule.
', ], ], 'NotificationRuleId' => [ 'base' => NULL, 'refs' => [ 'NotificationRuleSummary$Id' => 'The unique ID of the notification rule.
', ], ], 'NotificationRuleName' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$Name' => 'The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.
', 'DescribeNotificationRuleResult$Name' => 'The name of the notification rule.
', 'UpdateNotificationRuleRequest$Name' => 'The name of the notification rule.
', ], ], 'NotificationRuleResource' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$Resource' => '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.
', 'DescribeNotificationRuleResult$Resource' => 'The Amazon Resource Name (ARN) of the resource associated with the notification rule.
', ], ], 'NotificationRuleStatus' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$Status' => '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.
The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
', 'UpdateNotificationRuleRequest$Status' => 'The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
', ], ], 'NotificationRuleSummary' => [ 'base' => 'Information about a specified notification rule.
', 'refs' => [ 'NotificationRuleBatch$member' => NULL, ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'AWS CodeStar Notifications can\'t find a resource that matches the provided ARN.
', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'EventTypeSummary$ResourceType' => 'The resource type of the event.
', ], ], 'ServiceName' => [ 'base' => NULL, 'refs' => [ 'EventTypeSummary$ServiceName' => 'The name of the service for which the event applies.
', ], ], 'SubscribeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubscribeResult' => [ 'base' => NULL, 'refs' => [], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeys$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The key names of the tags to remove.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateNotificationRuleRequest$Tags' => 'A list of tags to apply to this notification rule. Key names cannot start with "aws".
The tags associated with the notification rule.
', 'ListTagsForResourceResult$Tags' => 'The tags associated with the notification rule.
', 'TagResourceRequest$Tags' => 'The list of tags to associate with the resource. Tag key names cannot start with "aws".
The list of tags associated with the resource.
', ], ], 'Target' => [ 'base' => 'Information about the Chatbot topics or Chatbot clients associated with a notification rule.
', 'refs' => [ 'SubscribeRequest$Target' => NULL, 'Targets$member' => NULL, ], ], 'TargetAddress' => [ 'base' => NULL, 'refs' => [ 'DeleteTargetRequest$TargetAddress' => 'The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.
', 'Target$TargetAddress' => 'The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
', 'TargetSummary$TargetAddress' => 'The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
', 'UnsubscribeRequest$TargetAddress' => 'The ARN of the Chatbot topic to unsubscribe from the notification rule.
', ], ], 'TargetStatus' => [ 'base' => NULL, 'refs' => [ 'TargetSummary$TargetStatus' => 'The status of the target.
', ], ], 'TargetSummary' => [ 'base' => 'Information about the targets specified for a notification rule.
', 'refs' => [ 'TargetsBatch$member' => NULL, ], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Target$TargetType' => 'The target type. Can be an Chatbot topic or Chatbot client.
Chatbot topics are specified as SNS.
Chatbot clients are specified as AWSChatbotSlack.
The type of the target (for example, SNS).
Chatbot topics are specified as SNS.
Chatbot clients are specified as AWSChatbotSlack.
A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
', 'UpdateNotificationRuleRequest$Targets' => 'The address and type of the targets to receive notifications from this notification rule.
', ], ], 'TargetsBatch' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationRuleResult$Targets' => 'A list of the Chatbot topics and Chatbot clients associated with the notification rule.
', 'ListTargetsResult$Targets' => 'The list of notification rule targets.
', ], ], 'UnsubscribeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnsubscribeResult' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotificationRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotificationRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'One or more parameter values are not valid.
', 'refs' => [], ], ],];