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().

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

{
    'Tenants': [
        {
            'TenantName': 'string',
            'TenantId': 'string',
            'TenantArn': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

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.