PinpointEmail / Paginator / ListConfigurationSets

ListConfigurationSets#

class PinpointEmail.Paginator.ListConfigurationSets#

paginator = client.get_paginator('list_configuration_sets')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from PinpointEmail.Client.list_configuration_sets().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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': [
        '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.