SESV2 / Client / list_resource_tenants

list_resource_tenants

SESV2.Client.list_resource_tenants(**kwargs)

List all tenants associated with a specific resource.

This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_tenants(
    ResourceArn='string',
    PageSize=123,
    NextToken='string'
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to list associated tenants for.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ResourceTenants': [
        {
            'TenantName': 'string',
            'TenantId': 'string',
            'ResourceArn': 'string',
            'AssociatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Information about tenants associated with a specific resource.

    • ResourceTenants (list) –

      An array that contains information about each tenant associated with the resource.

      • (dict) –

        A structure that contains information about a tenant associated with a resource.

        • TenantName (string) –

          The name of the tenant associated with the resource.

        • TenantId (string) –

          A unique identifier for the tenant associated with the resource.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • AssociatedTimestamp (datetime) –

          The date and time when the resource was associated with the tenant.

    • NextToken (string) –

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

Exceptions