Skip to content

ListTenantsRequest

Source code in docs_src/capo_sesv2/types/list_tenants_request.py 
13
14
15
16
17
18
19
class ListTenantsRequest(TypedDict, closed=True):
    filter: NotRequired["capo_sesv2.types.list_tenants_filter.ListTenantsFilter"]
    """<p>An object that contains filters to apply when listing tenants. You can filter by a substring of the tenant name or by sending status.</p>"""
    next_token: NotRequired["capo_sesv2.types.next_token.NextToken"]
    """<p>A token returned from a previous call to <code>ListTenants</code> to indicate the position in the list of tenants.</p>"""
    page_size: NotRequired["capo_sesv2.types.max_items.MaxItems"]
    """<p>The number of results to show in a single call to <code>ListTenants</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>"""

filter instance-attribute 

filter: NotRequired[ListTenantsFilter]

An object that contains filters to apply when listing tenants. You can filter by a substring of the tenant name or by sending status.

next_token instance-attribute 

next_token: NotRequired[NextToken]

A token returned from a previous call to ListTenants to indicate the position in the list of tenants.

page_size instance-attribute 

page_size: NotRequired[MaxItems]

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.