PinpointEmail / Client / list_configuration_sets

list_configuration_sets#

PinpointEmail.Client.list_configuration_sets(**kwargs)#

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

See also: AWS API Documentation

Request Syntax

response = client.list_configuration_sets(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

  • PageSize (integer) – The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSets': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.

    • ConfigurationSets (list) –

      An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

      • (string) –

        The name of a configuration set.

        In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

    • NextToken (string) –

      A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

Exceptions

  • PinpointEmail.Client.exceptions.TooManyRequestsException

  • PinpointEmail.Client.exceptions.BadRequestException