Skip to content

ListTermsRequest

Source code in docs_src/capo_cognito_identity_provider/types/list_terms_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListTermsRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool where you want to list terms documents.</p>"""
    max_results: NotRequired[
        "capo_cognito_identity_provider.types.list_terms_request_max_results_integer.ListTermsRequestMaxResultsInteger"
    ]
    """<p>The maximum number of terms documents that you want Amazon Cognito to return in the response.</p>"""
    next_token: NotRequired[
        "capo_cognito_identity_provider.types.string_type.StringType"
    ]
    """<p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</p>"""

max_results instance-attribute 

max_results: NotRequired[ListTermsRequestMaxResultsInteger]

The maximum number of terms documents that you want Amazon Cognito to return in the response.

next_token instance-attribute 

next_token: NotRequired[StringType]

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool where you want to list terms documents.