A low-level client representing AWS CodeStar Notifications
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 .
client = session.create_client('codestar-notifications')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
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.
See also: AWS API Documentation
Request Syntax
response = 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'
)
Name (string) –
[REQUIRED]
The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.
EventTypeIds (list) –
[REQUIRED]
A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary .
(string) –
Resource (string) –
[REQUIRED]
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.
Targets (list) –
[REQUIRED]
A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
(dict) –
Information about the Chatbot topics or Chatbot clients associated with a notification rule.
TargetType (string) –
The target type. Can be an Chatbot topic or Chatbot client.
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
TargetAddress (string) –
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
DetailType (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 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.
ClientRequestToken (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 Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.
This field is autopopulated if not provided.
Tags (dict) –
A list of tags to apply to this notification rule. Key names cannot start with “aws
“.
(string) –
(string) –
Status (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.
Exceptions
CodeStarNotifications.Client.exceptions.ResourceAlreadyExistsException
CodeStarNotifications.Client.exceptions.LimitExceededException
CodeStarNotifications.Client.exceptions.ConfigurationException
CodeStarNotifications.Client.exceptions.ConcurrentModificationException
CodeStarNotifications.Client.exceptions.AccessDeniedException
Deletes a notification rule for a resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_notification_rule(
Arn='string'
)
Arn (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.
Exceptions
Deletes a specified target for notifications.
See also: AWS API Documentation
Request Syntax
response = client.delete_target(
TargetAddress='string',
ForceUnsubscribeAll=True|False
)
TargetAddress (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.
ForceUnsubscribeAll (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.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Returns information about a specified notification rule.
See also: AWS API Documentation
Request Syntax
response = client.describe_notification_rule(
Arn='string'
)
Arn (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. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
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 Chatbot topics and Chatbot clients associated with the notification rule.
(dict) –
Information about the targets specified for a notification rule.
TargetAddress (string) –
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
TargetType (string) –
The type of the target (for example, SNS
).
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
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 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.
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) –
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Returns information about the event types available for configuring notifications.
See also: AWS API Documentation
Request Syntax
response = client.list_event_types(
Filters=[
{
'Name': 'RESOURCE_TYPE'|'SERVICE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
Filters (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.
NextToken (string) – An enumeration token that, when provided in a request, returns the next batch of the results.
MaxResults (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. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
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.
Exceptions
Returns a list of the notification rules for an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_notification_rules(
Filters=[
{
'Name': 'EVENT_TYPE_ID'|'CREATED_BY'|'RESOURCE'|'TARGET_ADDRESS',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
Filters (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 CodePipeline for the value.
NextToken (string) – An enumeration token that, when provided in a request, returns the next batch of the results.
MaxResults (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 Amazon Web Services 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.
Exceptions
Returns a list of the tags associated with a notification rule.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
Arn='string'
)
Arn (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) –
Exceptions
Returns a list of the notification rule targets for an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_targets(
Filters=[
{
'Name': 'TARGET_TYPE'|'TARGET_ADDRESS'|'TARGET_STATUS',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
Filters (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 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
.
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.
NextToken (string) – An enumeration token that, when provided in a request, returns the next batch of the results.
MaxResults (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 Chatbot topic or Chatbot client.
TargetType (string) –
The type of the target (for example, SNS
).
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
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.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.subscribe(
Arn='string',
Target={
'TargetType': 'string',
'TargetAddress': 'string'
},
ClientRequestToken='string'
)
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
Target (dict) –
[REQUIRED]
Information about the Chatbot topics or Chatbot clients associated with a notification rule.
TargetType (string) –
The target type. Can be an Chatbot topic or Chatbot client.
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
TargetAddress (string) –
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
ClientRequestToken (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.
Exceptions
Associates a set of provided tags with a notification rule.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Arn='string',
Tags={
'string': 'string'
}
)
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule to tag.
Tags (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) –
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.unsubscribe(
Arn='string',
TargetAddress='string'
)
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule.
TargetAddress (string) –
[REQUIRED]
The ARN of the Chatbot 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.
Exceptions
Removes the association between one or more provided tags and a notification rule.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Arn='string',
TagKeys=[
'string',
]
)
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
TagKeys (list) –
[REQUIRED]
The key names of the tags to remove.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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
response = client.update_notification_rule(
Arn='string',
Name='string',
Status='ENABLED'|'DISABLED',
EventTypeIds=[
'string',
],
Targets=[
{
'TargetType': 'string',
'TargetAddress': 'string'
},
],
DetailType='BASIC'|'FULL'
)
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the notification rule.
Name (string) – The name of the notification rule.
Status (string) – The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
EventTypeIds (list) –
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 .
(string) –
Targets (list) –
The address and type of the targets to receive notifications from this notification rule.
(dict) –
Information about the Chatbot topics or Chatbot clients associated with a notification rule.
TargetType (string) –
The target type. Can be an Chatbot topic or Chatbot client.
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
TargetAddress (string) –
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
DetailType (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.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
CodeStarNotifications.Client.exceptions.AccessDeniedException
CodeStarNotifications.Client.exceptions.ConcurrentModificationException
CodeStarNotifications.Client.exceptions.ConfigurationException
CodeStarNotifications.Client.exceptions.InvalidNextTokenException
CodeStarNotifications.Client.exceptions.LimitExceededException
CodeStarNotifications.Client.exceptions.ResourceAlreadyExistsException
CodeStarNotifications.Client.exceptions.ResourceNotFoundException
AWS CodeStar Notifications can’t create the notification rule because you do not have sufficient permissions.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
AWS CodeStar Notifications can’t create the notification rule because you do not have sufficient permissions.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AWS CodeStar Notifications can’t complete the request because the resource is being modified by another process. Wait a few minutes and try again.
Example
try:
...
except client.exceptions.ConcurrentModificationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
AWS CodeStar Notifications can’t complete the request because the resource is being modified by another process. Wait a few minutes and try again.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Some or all of the configuration is incomplete, missing, or not valid.
Example
try:
...
except client.exceptions.ConfigurationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Some or all of the configuration is incomplete, missing, or not valid.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The value for the enumeration token used in the request to return the next batch of the results is not valid.
Example
try:
...
except client.exceptions.InvalidNextTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The value for the enumeration token used in the request to return the next batch of the results is not valid.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
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.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.
Example
try:
...
except client.exceptions.ResourceAlreadyExistsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AWS CodeStar Notifications can’t find a resource that matches the provided ARN.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
AWS CodeStar Notifications can’t find a resource that matches the provided ARN.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more parameter values are not valid.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
One or more parameter values are not valid.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
paginator = client.get_paginator('list_event_types')
Creates an iterator that will paginate through responses from CodeStarNotifications.Client.list_event_types()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'RESOURCE_TYPE'|'SERVICE_NAME',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters (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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'EventTypes': [
{
'EventTypeId': 'string',
'ServiceName': 'string',
'EventTypeName': 'string',
'ResourceType': '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. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
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.
paginator = client.get_paginator('list_notification_rules')
Creates an iterator that will paginate through responses from CodeStarNotifications.Client.list_notification_rules()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'EVENT_TYPE_ID'|'CREATED_BY'|'RESOURCE'|'TARGET_ADDRESS',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters (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 CodePipeline for the value.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'NotificationRules': [
{
'Id': 'string',
'Arn': 'string'
},
]
}
Response Structure
(dict) –
NotificationRules (list) –
The list of notification rules for the Amazon Web Services 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.
paginator = client.get_paginator('list_targets')
Creates an iterator that will paginate through responses from CodeStarNotifications.Client.list_targets()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'TARGET_TYPE'|'TARGET_ADDRESS'|'TARGET_STATUS',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters (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 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
.
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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Targets': [
{
'TargetAddress': 'string',
'TargetType': 'string',
'TargetStatus': 'PENDING'|'ACTIVE'|'UNREACHABLE'|'INACTIVE'|'DEACTIVATED'
},
],
}
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 Chatbot topic or Chatbot client.
TargetType (string) –
The type of the target (for example, SNS
).
Chatbot topics are specified as SNS
.
Chatbot clients are specified as AWSChatbotSlack
.
TargetStatus (string) –
The status of the target.