CognitoIdentityProvider / Client / list_terms

list_terms¶

CognitoIdentityProvider.Client.list_terms(**kwargs)¶

Returns details about all terms documents for the requested user pool.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Request Syntax

response = client.list_terms(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The ID of the user pool where you want to list terms documents.
MaxResults (integer) – The maximum number of terms documents that you want Amazon Cognito to return in the response.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Terms': [
        {
            'TermsId': 'string',
            'TermsName': 'string',
            'Enforcement': 'NONE',
            'CreationDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Terms (list) –
  
  A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.
  - (dict) –
    
    The details of a set of terms documents. For more information, see Terms documents.
    - TermsId (string) –
      
      The ID of the requested terms documents.
    - TermsName (string) –
      
      The type and friendly name of the requested terms documents.
    - Enforcement (string) –
      
      This parameter is reserved for future use and currently accepts one value.
    - CreationDate (datetime) –
      
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - LastModifiedDate (datetime) –
      
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
- NextToken (string) –
  
  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.