create_event_destination¶

PinpointSMSVoiceV2.Client.create_event_destination(**kwargs)¶

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

See also: AWS API Documentation

Request Syntax

response = client.create_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string',
    MatchingEventTypes=[
        'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
    ],
    CloudWatchLogsDestination={
        'IamRoleArn': 'string',
        'LogGroupArn': 'string'
    },
    KinesisFirehoseDestination={
        'IamRoleArn': 'string',
        'DeliveryStreamArn': 'string'
    },
    SnsDestination={
        'TopicArn': 'string'
    },
    ClientToken='string'
)

Parameters

ConfigurationSetName (string) --
[REQUIRED]

Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
EventDestinationName (string) --
[REQUIRED]

The name that identifies the event destination.
MatchingEventTypes (list) --
[REQUIRED]

An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
- (string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
- IamRoleArn (string) -- [REQUIRED]
  The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
- LogGroupArn (string) -- [REQUIRED]
  The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- IamRoleArn (string) -- [REQUIRED]
  The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
- DeliveryStreamArn (string) -- [REQUIRED]
  The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination for logging to Amazon SNS.
- TopicArn (string) -- [REQUIRED]
  The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestination': {
        'EventDestinationName': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
        ],
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'KinesisFirehoseDestination': {
            'IamRoleArn': 'string',
            'DeliveryStreamArn': 'string'
        },
        'SnsDestination': {
            'TopicArn': 'string'
        }
    }
}

Response Structure

(dict) --
- ConfigurationSetArn (string) --
  
  The ARN of the configuration set.
- ConfigurationSetName (string) --
  
  The name of the configuration set.
- EventDestination (dict) --
  
  The details of the destination where events are logged.
  - EventDestinationName (string) --
    
    The name of the EventDestination.
  - Enabled (boolean) --
    
    When set to true events will be logged.
  - MatchingEventTypes (list) --
    
    An array of event types that determine which events to log.
    - (string) --
  - CloudWatchLogsDestination (dict) --
    
    An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
    - IamRoleArn (string) --
      
      The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
    - LogGroupArn (string) --
      
      The name of the Amazon CloudWatch log group that you want to record events in.
  - KinesisFirehoseDestination (dict) --
    
    An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
    - IamRoleArn (string) --
      
      The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
    - DeliveryStreamArn (string) --
      
      The Amazon Resource Name (ARN) of the delivery stream.
  - SnsDestination (dict) --
    
    An object that contains information about an event destination that sends logging events to Amazon SNS.
    - TopicArn (string) --
      
      The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException
PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException

Table Of Contents

create_event_destination¶