CodeStarNotifications / Client / describe_notification_rule

describe_notification_rule#

CodeStarNotifications.Client.describe_notification_rule(**kwargs)#

Returns information about a specified notification rule.

Request Syntax

response = client.describe_notification_rule(
    Arn='string'
)

Parameters:

Arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'EventTypes': [
        {
            'EventTypeId': 'string',
            'ServiceName': 'string',
            'EventTypeName': 'string',
            'ResourceType': 'string'
        },
    ],
    'Resource': 'string',
    'Targets': [
        {
            'TargetAddress': 'string',
            'TargetType': 'string',
            'TargetStatus': 'PENDING'|'ACTIVE'|'UNREACHABLE'|'INACTIVE'|'DEACTIVATED'
        },
    ],
    'DetailType': 'BASIC'|'FULL',
    'CreatedBy': 'string',
    'Status': 'ENABLED'|'DISABLED',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'LastModifiedTimestamp': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- 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.
  - (dict) –
    
    Returns information about an event that has triggered a notification rule.
    - EventTypeId (string) –
      
      The system-generated ID of the event. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
    - 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 Chatbot topics and Chatbot clients associated with the notification rule.
  - (dict) –
    
    Information about the targets specified for a notification rule.
    - TargetAddress (string) –
      
      The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
    - TargetType (string) –
      
      The type of the target (for example, SNS).
      - Chatbot topics are specified as SNS.
      - Chatbot clients are specified as AWSChatbotSlack.
    - 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 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.
- 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 (datetime) –
  
  The date and time the notification rule was created, in timestamp format.
- LastModifiedTimestamp (datetime) –
  
  The date and time the notification rule was most recently updated, in timestamp format.
- Tags (dict) –
  
  The tags associated with the notification rule.
  - (string) –
    - (string) –

Exceptions

CodeStarNotifications.Client.exceptions.ResourceNotFoundException
CodeStarNotifications.Client.exceptions.ValidationException