MailManager / Paginator / ListAddonInstances

ListAddonInstances

class MailManager.Paginator.ListAddonInstances

paginator = client.get_paginator('list_addon_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MailManager.Client.list_addon_instances().

See also: AWS API Documentation

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

{
    'AddonInstances': [
        {
            'AddonInstanceArn': 'string',
            'AddonInstanceId': 'string',
            'AddonName': 'string',
            'AddonSubscriptionId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • AddonInstances (list) –

    The list of ingress endpoints.

    • (dict) –

      An Add On instance represents a specific configuration of an Add On.

      • AddonInstanceArn (string) –

        The Amazon Resource Name (ARN) of the Add On instance.

      • AddonInstanceId (string) –

        The unique ID of the Add On instance.

      • AddonName (string) –

        The name of the Add On for the instance.

      • AddonSubscriptionId (string) –

        The subscription ID for the instance.

      • CreatedTimestamp (datetime) –

        The timestamp of when the Add On instance was created.