SESV2 / Paginator / ListTenantResources
ListTenantResources¶
- class SESV2.Paginator.ListTenantResources¶
paginator = client.get_paginator('list_tenant_resources')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
SESV2.Client.list_tenant_resources()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( TenantName='string', Filter={ 'string': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': '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 areEMAIL_IDENTITY
,CONFIGURATION_SET
, orEMAIL_TEMPLATE
.
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
{ 'TenantResources': [ { 'ResourceType': 'EMAIL_IDENTITY'|'CONFIGURATION_SET'|'EMAIL_TEMPLATE', 'ResourceArn': '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
, orEMAIL_TEMPLATE
.ResourceArn (string) –
The Amazon Resource Name (ARN) of the resource associated with the tenant.