SESV2 / Client / list_tenant_resources

list_tenant_resources

SESV2.Client.list_tenant_resources(**kwargs)

List all resources associated with a specific tenant.

This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

See also: AWS API Documentation

Request Syntax

response = client.list_tenant_resources(
    TenantName='string',
    Filter={
        'string': 'string'
    },
    PageSize=123,
    NextToken='string'
)
Parameters:

  • TenantName (string) –

    [REQUIRED]

    The name of the tenant to list resources for.

  • Filter (dict) –

    A map of filter keys and values for filtering the list of tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

    • (string) –

      The key used to filter tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

      • (string) –

        The value used to filter tenant resources. When filtering by RESOURCE_TYPE, valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE.

  • PageSize (integer) – The number of results to show in a single call to ListTenantResources. 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 ListTenantResources to indicate the position in the list of tenant resources.

Return type:

dict

Returns:

Response Syntax

{
    'TenantResources': [
        {
            'ResourceType': 'EMAIL_IDENTITY'|'CONFIGURATION_SET'|'EMAIL_TEMPLATE',
            'ResourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Information about resources associated with a specific tenant.

    • TenantResources (list) –

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

      • (dict) –

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

        • ResourceType (string) –

          The type of resource associated with the tenant. Valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource associated with the tenant.

    • NextToken (string) –

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

Exceptions