Skip to content

ListRolesRequest

Source code in docs_src/capo_account_access_runtime/types/list_roles_request.py
class ListRolesRequest(TypedDict, closed=True):
    tenant_id: "capo_account_access_runtime.types.tenant_id.TenantId"
    """<p>The identifier of the tenant whose roles you want to list. A tenant ID begins with <code>aa-</code> and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of roles to return in a single response. If more roles are available than the specified value, the response includes a <code>nextToken</code> value that you can use to retrieve the next page of results. If you don't specify a value, the service uses a default page size.</p>"""
    next_token: NotRequired["capo_account_access_runtime.types.token.Token"]
    """<p>The pagination token from a previous <code>ListRoles</code> response. Use it to retrieve the next page of results. Omit this parameter on the first call.</p>"""

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of roles to return in a single response. If more roles are available than the specified value, the response includes a nextToken value that you can use to retrieve the next page of results. If you don't specify a value, the service uses a default page size.

next_token instance-attribute

next_token: NotRequired[Token]

The pagination token from a previous ListRoles response. Use it to retrieve the next page of results. Omit this parameter on the first call.

tenant_id instance-attribute

tenant_id: TenantId

The identifier of the tenant whose roles you want to list. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.