AWS CodeStar Notifications
Welcome (API Version 2019-10-15)

DescribeNotificationRule

Returns information about a specified notification rule.

Request Syntax

POST /describeNotificationRule HTTP/1.1 Content-type: application/json { "Arn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Arn

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

Type: String

Pattern: ^arn:aws[^:\s]*:codestar-notifications:[^:\s]+:\d{12}:notificationrule\/(.*\S)?$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreatedBy": "string", "CreatedTimestamp": number, "DetailType": "string", "EventTypes": [ { "EventTypeId": "string", "EventTypeName": "string", "ResourceType": "string", "ServiceName": "string" } ], "LastModifiedTimestamp": number, "Name": "string", "Resource": "string", "Status": "string", "Tags": { "string" : "string" }, "Targets": [ { "TargetAddress": "string", "TargetStatus": "string", "TargetType": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

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

Type: String

Pattern: ^arn:aws[^:\s]*:codestar-notifications:[^:\s]+:\d{12}:notificationrule\/(.*\S)?$

CreatedBy

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

Type: String

Length Constraints: Minimum length of 1.

CreatedTimestamp

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

Type: Timestamp

DetailType

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.

Type: String

Valid Values: BASIC | FULL

EventTypes

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

Type: Array of EventTypeSummary objects

LastModifiedTimestamp

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

Type: Timestamp

Name

The name of the notification rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9\-_ ]+$

Resource

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

Type: String

Pattern: ^arn:aws[^:\s]*:[^:\s]*:[^:\s]*:[0-9]{12}:[^\s]+$

Status

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

Type: String

Valid Values: ENABLED | DISABLED

Tags

The tags associated with the notification rule.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Targets

A list of the SNS topics associated with the notification rule.

Type: Array of TargetSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

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

HTTP Status Code: 404

ValidationException

One or more parameter values are not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: