[ aws . codestar-notifications ]

update-notification-rule

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-notification-rule
--arn <value>
[--name <value>]
[--status <value>]
[--event-type-ids <value>]
[--targets <value>]
[--detail-type <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.

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

Possible values:

• ENABLED

• DISABLED

--event-type-ids (list)

A list of event types associated with this notification rule.

(string)

Syntax:

"string" "string" ...

--targets (list)

The address and type of the targets to receive notifications from this notification rule.

(structure)

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.

Shorthand Syntax:

TargetType=string,TargetAddress=string ...

JSON Syntax:

[
  {
    "TargetType": "string",
    "TargetAddress": "string"
  }
  ...
]

--detail-type (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.

Possible values:

• BASIC

• FULL

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

Output

None