PinpointSMSVoice / Client / get_configuration_set_event_destinations

get_configuration_set_event_destinations#

PinpointSMSVoice.Client.get_configuration_set_event_destinations(**kwargs)#

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

Request Syntax

response = client.get_configuration_set_event_destinations(
    ConfigurationSetName='string'
)

Parameters:

ConfigurationSetName (string) – [REQUIRED] ConfigurationSetName

Return type:

dict

Returns:

Response Syntax

{
    'EventDestinations': [
        {
            'CloudWatchLogsDestination': {
                'IamRoleArn': 'string',
                'LogGroupArn': 'string'
            },
            'Enabled': True|False,
            'KinesisFirehoseDestination': {
                'DeliveryStreamArn': 'string',
                'IamRoleArn': 'string'
            },
            'MatchingEventTypes': [
                'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
            ],
            'Name': 'string',
            'SnsDestination': {
                'TopicArn': 'string'
            }
        },
    ]
}

Response Structure

(dict) – GetConfigurationSetEventDestinationsResponse
- EventDestinations (list) – An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
  - (dict) – An object that defines an event destination.
    - CloudWatchLogsDestination (dict) – An object that contains information about an event destination that sends data 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.
    - Enabled (boolean) – Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.
    - KinesisFirehoseDestination (dict) – An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
      - DeliveryStreamArn (string) – The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.
      - IamRoleArn (string) – The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.
    - MatchingEventTypes (list) – An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
      - (string) – The types of events that are sent to the event destination.
    - Name (string) – A name that identifies the event destination configuration.
    - SnsDestination (dict) – An object that contains information about an event destination that sends data to Amazon SNS.
      - TopicArn (string) – The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Exceptions

PinpointSMSVoice.Client.exceptions.NotFoundException
PinpointSMSVoice.Client.exceptions.TooManyRequestsException
PinpointSMSVoice.Client.exceptions.BadRequestException
PinpointSMSVoice.Client.exceptions.InternalServiceErrorException