PinpointSMSVoiceV2 / Client / describe_configuration_sets

describe_configuration_sets

PinpointSMSVoiceV2.Client.describe_configuration_sets(**kwargs)

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don’t specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn’t valid, an error is returned.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_sets(
    ConfigurationSetNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'event-destination-name'|'matching-event-types'|'default-message-type'|'default-sender-id'|'default-message-feedback-enabled'|'protect-configuration-id',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

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) –

• NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

• MaxResults (integer) – The maximum number of results to return per each request.

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'|'TEXT_PROTECT_BLOCKED'|'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',
            'DefaultMessageFeedbackEnabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ProtectConfigurationId': 'string'
        },
    ],
    'NextToken': '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.

      • DefaultMessageFeedbackEnabled (boolean) –

        True if message feedback is enabled.

      • CreatedTimestamp (datetime) –

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

      • ProtectConfigurationId (string) –

        The unique identifier for the protect configuration.

  • NextToken (string) –

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

• PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

• PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

• PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

• PinpointSMSVoiceV2.Client.exceptions.ValidationException

• PinpointSMSVoiceV2.Client.exceptions.InternalServerException