Amazon Pinpoint SMS and Voice Service

2018/12/21 - Amazon Pinpoint SMS and Voice Service - 3 updated api methods

Changes  Configuration sets can now use Amazon SNS as an event destination.

CreateConfigurationSetEventDestination (updated) Link ¶
Changes (request) 
{'EventDestination': {'SnsDestination': {'TopicArn': 'string'}}}

Create a new event destination in a configuration set.

See also: AWS API Documentation

Request Syntax

client.create_configuration_set_event_destination(
    ConfigurationSetName='string',
    EventDestination={
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'Enabled': True|False,
        'KinesisFirehoseDestination': {
            'DeliveryStreamArn': 'string',
            'IamRoleArn': 'string'
        },
        'MatchingEventTypes': [
            'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
        ],
        'SnsDestination': {
            'TopicArn': 'string'
        }
    },
    EventDestinationName='string'
)
type ConfigurationSetName

string

param ConfigurationSetName

[REQUIRED] ConfigurationSetName

type EventDestination

dict

param EventDestination

An object that defines a single 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.

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

type EventDestinationName

string

param EventDestinationName

A name that identifies the event destination.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) -- CreateConfigurationSetEventDestinationResponse

GetConfigurationSetEventDestinations (updated) Link ¶
Changes (response) 
{'EventDestinations': {'SnsDestination': {'TopicArn': 'string'}}}

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.

See also: AWS API Documentation

Request Syntax

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

string

param ConfigurationSetName

[REQUIRED] ConfigurationSetName

rtype

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.

UpdateConfigurationSetEventDestination (updated) Link ¶
Changes (request) 
{'EventDestination': {'SnsDestination': {'TopicArn': 'string'}}}

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

See also: AWS API Documentation

Request Syntax

client.update_configuration_set_event_destination(
    ConfigurationSetName='string',
    EventDestination={
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'Enabled': True|False,
        'KinesisFirehoseDestination': {
            'DeliveryStreamArn': 'string',
            'IamRoleArn': 'string'
        },
        'MatchingEventTypes': [
            'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
        ],
        'SnsDestination': {
            'TopicArn': 'string'
        }
    },
    EventDestinationName='string'
)
type ConfigurationSetName

string

param ConfigurationSetName

[REQUIRED] ConfigurationSetName

type EventDestination

dict

param EventDestination

An object that defines a single 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.

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

type EventDestinationName

string

param EventDestinationName

[REQUIRED] EventDestinationName

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) -- UpdateConfigurationSetEventDestinationResponse