subscribe¶

subscribe(**kwargs)

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.

See also: AWS API Documentation

Request Syntax

response = client.subscribe(
    Arn='string',
    Target={
        'TargetType': 'string',
        'TargetAddress': 'string'
    },
    ClientRequestToken='string'
)

Parameters

Arn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
Target (dict) --
[REQUIRED]

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.
ClientRequestToken (string) -- An enumeration token that, when provided in a request, returns the next batch of the results.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

Exceptions

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

Table Of Contents

subscribe¶