Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListTerms

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

Note

Amazon Cognito evaluates AWS 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


{
   "MaxResults": number,
   "NextToken": "string",
   "UserPoolId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 60.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

UserPoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Terms": [ 
      { 
         "CreationDate": number,
         "Enforcement": "string",
         "LastModifiedDate": number,
         "TermsId": "string",
         "TermsName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Terms

A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

Type: Array of TermsDescriptionType objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

message: The message returned when Amazon Cognito throws an internal error exception.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

message: The message returned when the Amazon Cognito service throws an invalid parameter exception.
reasonCode: The reason code of the exception.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user isn't authorized.

message: The message returned when the Amazon Cognito service returns a not authorized exception.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

message: The message returned when the Amazon Cognito service returns a resource not found exception.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

message: The message returned when the Amazon Cognito service returns a too many requests exception.

HTTP Status Code: 400

Examples

Example

The following example operation lists all terms documents for a user pool.

Sample Request


POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.ListTerms
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>

{
   "UserPoolId": "us-east-1_EXAMPLE",
   "MaxResults": 10
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive

{
    "Terms": [
        {
            "CreationDate": 1755795432.101,
            "Enforcement": "NONE",
            "LastModifiedDate": 1755795478.934,
            "TermsId": "b2c3d4e5-6789-01bc-def0-EXAMPLE22222",
            "TermsName": "terms-of-use"
        },
        {
            "CreationDate": 1755796023.445,
            "Enforcement": "NONE",
            "LastModifiedDate": 1755796089.712,
            "TermsId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "TermsName": "privacy-policy"
        }
    ]
}