TermsType - Amazon Cognito User Pools
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TermsType

The details of a set of terms documents. For more information, see Terms documents.

This data type is a response parameter of CreateTerms and UpdateTerms.

Contents

ClientId

The ID of the app client that the terms documents are assigned to.

Type: String

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

Pattern: [\w+]+

Required: Yes

CreationDate

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.

Type: Timestamp

Required: Yes

Enforcement

This parameter is reserved for future use and currently accepts one value.

Type: String

Valid Values: NONE

Required: Yes

LastModifiedDate

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.

Type: Timestamp

Required: Yes

A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.

For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".

Type: String to string map

Map Entries: Maximum number of 12 items.

Key Pattern: ^cognito:(default|english|french|spanish|german|bahasa-indonesia|italian|japanese|korean|portuguese-brazil|chinese-(simplified|traditional))$

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}]+$

Required: Yes

TermsId

The ID of the terms documents.

Type: String

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Required: Yes

TermsName

The type and friendly name of the terms documents.

Type: String

Pattern: ^(terms-of-use|privacy-policy)$

Required: Yes

TermsSource

This parameter is reserved for future use and currently accepts one value.

Type: String

Valid Values: LINK

Required: Yes

UserPoolId

The ID of the user pool that contains the terms documents.

Type: String

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

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

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: