describe-notification-rule¶

Description¶

Returns information about a specified notification rule.

Synopsis¶

  describe-notification-rule
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve details of a notification rule

The following describe-notification-rule example retrieves the details of the specified notification rule.

aws codestar-notifications describe-notification-rule \
    --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE

Output:

{
    "LastModifiedTimestamp": 1569199844.857,
    "EventTypes": [
        {
            "ServiceName": "CodeCommit",
            "EventTypeName": "Branches and tags: Created",
            "ResourceType": "Repository",
            "EventTypeId": "codecommit-repository-branches-and-tags-created"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL",
    "Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo",
    "Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE",
    "Targets": [
        {
            "TargetStatus": "ACTIVE",
            "TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic",
            "TargetType": "SNS"
        }
    ],
    "Name": "MyNotificationRule",
    "CreatedTimestamp": 1569199844.857,
    "CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major"
}

For more information, see View Notification Rules in the AWS Developer Tools Console User Guide.

Output¶

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.

(structure)

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.

(structure)

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 -> (timestamp)

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

LastModifiedTimestamp -> (timestamp)

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

Tags -> (map)

The tags associated with the notification rule.

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide