PinpointSMSVoiceV2 / Paginator / DescribeConfigurationSets

DescribeConfigurationSets

class PinpointSMSVoiceV2.Paginator.DescribeConfigurationSets

paginator = client.get_paginator('describe_configuration_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_configuration_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationSetNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'event-destination-name'|'matching-event-types'|'default-message-type'|'default-sender-id'|'protect-configuration-id',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ConfigurationSetNames (list) –

  An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

  • (string) –

• Filters (list) –

  An array of filters to apply to the results that are returned.

  • (dict) –

    The information for configuration sets that meet a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

      An array values to filter for.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSets': [
        {
            'ConfigurationSetArn': 'string',
            'ConfigurationSetName': 'string',
            'EventDestinations': [
                {
                    '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'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
                    ],
                    'CloudWatchLogsDestination': {
                        'IamRoleArn': 'string',
                        'LogGroupArn': 'string'
                    },
                    'KinesisFirehoseDestination': {
                        'IamRoleArn': 'string',
                        'DeliveryStreamArn': 'string'
                    },
                    'SnsDestination': {
                        'TopicArn': 'string'
                    }
                },
            ],
            'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'DefaultSenderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ProtectConfigurationId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ConfigurationSets (list) –

    An array of ConfigurationSets objects.

    • (dict) –

      Information related to a given configuration set in your Amazon Web Services account.

      • ConfigurationSetArn (string) –

        The Resource Name (ARN) of the ConfigurationSet.

      • ConfigurationSetName (string) –

        The name of the ConfigurationSet.

      • EventDestinations (list) –

        An array of EventDestination objects that describe any events to log and where to log them.

        • (dict) –

          Contains information about an event destination.

          Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.

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

            Note

            The TEXT_SENT event type is not supported.

            • (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 Identity and Access Management 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 Data Firehose.

            • IamRoleArn (string) –

              The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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.

      • DefaultMessageType (string) –

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

      • DefaultSenderId (string) –

        The default sender ID used by the ConfigurationSet.

      • CreatedTimestamp (datetime) –

        The time when the ConfigurationSet was created, in UNIX epoch time format.

      • ProtectConfigurationId (string) –

        The unique identifier for the protect configuration.