CodeStarNotifications / Client / update_notification_rule

update_notification_rule#

CodeStarNotifications.Client.update_notification_rule(**kwargs)#

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'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CodeStarNotifications.Client.exceptions.ValidationException

  • CodeStarNotifications.Client.exceptions.ResourceNotFoundException

  • CodeStarNotifications.Client.exceptions.ConfigurationException