SESV2 / Paginator / ListTenants

ListTenants

class SESV2.Paginator.ListTenants

paginator = client.get_paginator('list_tenants')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SESV2.Client.list_tenants().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filter (dict) –

  An object that contains filters to apply when listing tenants. You can filter by tenant name or sending status.

  • (string) –

    The filter key to use when listing tenants. This can be one of the following:

    • TENANT_NAME_CONTAINS – Filter by a substring of the tenant name.

    • SENDING_STATUS – Filter by sending status.

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

{
    'Tenants': [
        {
            'TenantName': 'string',
            'TenantId': 'string',
            'TenantArn': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED'
        },
    ],

}

Response Structure

• (dict) –

  Information about tenants associated with your account.

  • Tenants (list) –

    An array that contains basic information about each tenant.

    • (dict) –

      A structure that contains basic information about a tenant.

      • TenantName (string) –

        The name of the tenant.

      • TenantId (string) –

        A unique identifier for the tenant.

      • TenantArn (string) –

        The Amazon Resource Name (ARN) of the tenant.

      • CreatedTimestamp (datetime) –

        The date and time when the tenant was created.

      • SendingStatus (string) –

        The sending status for a reputation entity. This can be one of the following:

        • ENABLED – Sending is allowed for this entity.

        • DISABLED – Sending is prevented for this entity.

        • REINSTATED – Sending is allowed even if there are active reputation findings.