2019/11/05 - AWS CodeStar Notifications - 13 new api methods
Changes This release adds a notification manager for events in repositories, build projects, deployments, and pipelines. You can now configure rules and receive notifications about events that occur for resources. Each notification includes a status message as well as a link to the resource (repository, build project, deployment application, or pipeline) whose event generated the notification.
Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
See also: AWS API Documentation
Request Syntax
client.unsubscribe(
Arn='string',
TargetAddress='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule.
string
[REQUIRED]
The ARN of the SNS topic to unsubscribe from the notification rule.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.
Returns a list of the notification rules for an AWS account.
See also: AWS API Documentation
Request Syntax
client.list_notification_rules(
Filters=[
{
'Name': 'EVENT_TYPE_ID'|'CREATED_BY'|'RESOURCE'|'TARGET_ADDRESS',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
list
The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter.
Note
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.
(dict) --
Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
Name (string) -- [REQUIRED]
The name of the attribute you want to use to filter the returned notification rules.
Value (string) -- [REQUIRED]
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 AWS CodePipeline for the value.
string
An enumeration token that, when provided in a request, returns the next batch of the results.
integer
A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
dict
Response Syntax
{
'NextToken': 'string',
'NotificationRules': [
{
'Id': 'string',
'Arn': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An enumeration token that can be used in a request to return the next batch of the results.
NotificationRules (list) --
The list of notification rules for the AWS account, by Amazon Resource Name (ARN) and ID.
(dict) --
Information about a specified notification rule.
Id (string) --
The unique ID of the notification rule.
Arn (string) --
The Amazon Resource Name (ARN) of the notification rule.
Associates a set of provided tags with a notification rule.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
Arn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule to tag.
dict
[REQUIRED]
The list of tags to associate with the resource. Tag key names cannot start with "aws".
(string) --
(string) --
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The list of tags associated with the resource.
(string) --
(string) --
Returns information about a specified notification rule.
See also: AWS API Documentation
Request Syntax
client.describe_notification_rule(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'EventTypes': [
{
'EventTypeId': 'string',
'ServiceName': 'string',
'EventTypeName': 'string',
'ResourceType': 'string'
},
],
'Resource': 'string',
'Targets': [
{
'TargetAddress': 'string',
'TargetType': 'string',
'TargetStatus': 'PENDING'|'ACTIVE'|'UNREACHABLE'|'INACTIVE'|'DEACTIVATED'
},
],
'DetailType': 'BASIC'|'FULL',
'CreatedBy': 'string',
'Status': 'ENABLED'|'DISABLED',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastModifiedTimestamp': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the notification rule.
Name (string) --
The name of the notification rule.
EventTypes (list) --
A list of the event types associated with the notification rule.
(dict) --
Returns information about an event that has triggered a notification rule.
EventTypeId (string) --
The system-generated ID of the event.
ServiceName (string) --
The name of the service for which the event applies.
EventTypeName (string) --
The name of the event.
ResourceType (string) --
The resource type of the event.
Resource (string) --
The Amazon Resource Name (ARN) of the resource associated with the notification rule.
Targets (list) --
A list of the SNS topics associated with the notification rule.
(dict) --
Information about the targets specified for a notification rule.
TargetAddress (string) --
The Amazon Resource Name (ARN) of the SNS topic.
TargetType (string) --
The type of the target (for example, SNS).
TargetStatus (string) --
The status of the target.
DetailType (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 AWS 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.
CreatedBy (string) --
The name or email alias of the person who created the notification rule.
Status (string) --
The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
CreatedTimestamp (datetime) --
The date and time the notification rule was created, in timestamp format.
LastModifiedTimestamp (datetime) --
The date and time the notification rule was most recently updated, in timestamp format.
Tags (dict) --
The tags associated with the notification rule.
(string) --
(string) --
Returns a list of the notification rule targets for an AWS account.
See also: AWS API Documentation
Request Syntax
client.list_targets(
Filters=[
{
'Name': 'TARGET_TYPE'|'TARGET_ADDRESS'|'TARGET_STATUS',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
list
The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.
Note
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.
(dict) --
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 Amazon SNS 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.
Name (string) -- [REQUIRED]
The name of the attribute you want to use to filter the returned targets.
Value (string) -- [REQUIRED]
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.
string
An enumeration token that, when provided in a request, returns the next batch of the results.
integer
A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
dict
Response Syntax
{
'Targets': [
{
'TargetAddress': 'string',
'TargetType': 'string',
'TargetStatus': 'PENDING'|'ACTIVE'|'UNREACHABLE'|'INACTIVE'|'DEACTIVATED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
The list of notification rule targets.
(dict) --
Information about the targets specified for a notification rule.
TargetAddress (string) --
The Amazon Resource Name (ARN) of the SNS topic.
TargetType (string) --
The type of the target (for example, SNS).
TargetStatus (string) --
The status of the target.
NextToken (string) --
An enumeration token that can be used in a request to return the next batch of results.
Deletes a specified target for notifications.
See also: AWS API Documentation
Request Syntax
client.delete_target(
TargetAddress='string',
ForceUnsubscribeAll=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SNS topic to delete.
boolean
A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the event types available for configuring notifications.
See also: AWS API Documentation
Request Syntax
client.list_event_types(
Filters=[
{
'Name': 'RESOURCE_TYPE'|'SERVICE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
list
The filters to use to return information by service or resource type.
(dict) --
Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
Name (string) -- [REQUIRED]
The system-generated name of the filter type you want to filter by.
Value (string) -- [REQUIRED]
The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.
string
An enumeration token that, when provided in a request, returns the next batch of the results.
integer
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.
dict
Response Syntax
{
'EventTypes': [
{
'EventTypeId': 'string',
'ServiceName': 'string',
'EventTypeName': 'string',
'ResourceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventTypes (list) --
Information about each event, including service name, resource type, event ID, and event name.
(dict) --
Returns information about an event that has triggered a notification rule.
EventTypeId (string) --
The system-generated ID of the event.
ServiceName (string) --
The name of the service for which the event applies.
EventTypeName (string) --
The name of the event.
ResourceType (string) --
The resource type of the event.
NextToken (string) --
An enumeration token that can be used in a request to return the next batch of the results.
Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
See also: AWS API Documentation
Request Syntax
client.subscribe(
Arn='string',
Target={
'TargetType': 'string',
'TargetAddress': 'string'
},
ClientRequestToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
dict
[REQUIRED]
Information about the SNS topics associated with a notification rule.
TargetType (string) --
The target type. Can be an Amazon SNS topic.
TargetAddress (string) --
The Amazon Resource Name (ARN) of the SNS topic.
string
An enumeration token that, when provided in a request, returns the next batch of the results.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.
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.
Note
To add or remove tags for a notification rule, you must use TagResource and UntagResource.
See also: AWS API Documentation
Request Syntax
client.update_notification_rule(
Arn='string',
Name='string',
Status='ENABLED'|'DISABLED',
EventTypeIds=[
'string',
],
Targets=[
{
'TargetType': 'string',
'TargetAddress': 'string'
},
],
DetailType='BASIC'|'FULL'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule.
string
The name of the notification rule.
string
The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
list
A list of event types associated with this notification rule.
(string) --
list
The address and type of the targets to receive notifications from this notification rule.
(dict) --
Information about the SNS topics associated with a notification rule.
TargetType (string) --
The target type. Can be an Amazon SNS topic.
TargetAddress (string) --
The Amazon Resource Name (ARN) of the SNS topic.
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 AWS 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.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of the tags associated with a notification rule.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for the notification rule.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The tags associated with the notification rule.
(string) --
(string) --
Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.
See also: AWS API Documentation
Request Syntax
client.create_notification_rule(
Name='string',
EventTypeIds=[
'string',
],
Resource='string',
Targets=[
{
'TargetType': 'string',
'TargetAddress': 'string'
},
],
DetailType='BASIC'|'FULL',
ClientRequestToken='string',
Tags={
'string': 'string'
},
Status='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The name for the notification rule. Notifictaion rule names must be unique in your AWS account.
list
[REQUIRED]
A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.
list
[REQUIRED]
A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
(dict) --
Information about the SNS topics associated with a notification rule.
TargetType (string) --
The target type. Can be an Amazon SNS topic.
TargetAddress (string) --
The Amazon Resource Name (ARN) of the SNS topic.
string
[REQUIRED]
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 AWS 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.
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.
Note
The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.
This field is autopopulated if not provided.
dict
A list of tags to apply to this notification rule. Key names cannot start with "aws".
(string) --
(string) --
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.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the notification rule.
Removes the association between one or more provided tags and a notification rule.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
Arn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
list
[REQUIRED]
The key names of the tags to remove.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a notification rule for a resource.
See also: AWS API Documentation
Request Syntax
client.delete_notification_rule(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule you want to delete.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the deleted notification rule.