SESV2 / Client / list_tenants

list_tenants

SESV2.Client.list_tenants(**kwargs)

List all tenants associated with your account in the current Amazon Web Services Region.

This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.

See also: AWS API Documentation

Request Syntax

response = client.list_tenants(
    Filter={
        'string': 'string'
    },
    NextToken='string',
    PageSize=123
)
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) –

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

  • PageSize (integer) – The number of results to show in a single call to ListTenants. 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

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

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.

    • NextToken (string) –

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

Exceptions