list-notification-rules¶

Description¶

Returns a list of the notification rules for an AWS account.

Synopsis¶

  list-notification-rules
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--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.

(structure)

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)

The name of the attribute you want to use to filter the returned notification rules.

Value -> (string)

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.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "EVENT_TYPE_ID"|"CREATED_BY"|"RESOURCE"|"TARGET_ADDRESS",
    "Value": "string"
  }
  ...
]

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 a list of notification rules

The following list-notification-rules example retrieves a list of all notification rules in the specified AWS Region.

aws codestar-notifications list-notification-rules --region us-east-1

Output:

{
    "NotificationRules": [
        {
            "Id": "dc82df7a-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
        },
        {
            "Id": "8d1f0983-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE"
        }
    ]
}

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

Output¶

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.

(structure)

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.

Table of Contents

Feedback

User Guide