Skip to content

TermsType

Source code in docs_src/capo_cognito_identity_provider/types/terms_type.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class TermsType(TypedDict, closed=True):
    terms_id: "capo_cognito_identity_provider.types.terms_id_type.TermsIdType"
    """<p>The ID of the terms documents.</p>"""
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool that contains the terms documents.</p>"""
    client_id: "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    """<p>The ID of the app client that the terms documents are assigned to.</p>"""
    terms_name: "capo_cognito_identity_provider.types.terms_name_type.TermsNameType"
    """<p>The type and friendly name of the terms documents.</p>"""
    terms_source: (
        "capo_cognito_identity_provider.types.terms_source_type.TermsSourceType"
    )
    """<p>This parameter is reserved for future use and currently accepts one value.</p>"""
    enforcement: "capo_cognito_identity_provider.types.terms_enforcement_type.TermsEnforcementType"
    """<p>This parameter is reserved for future use and currently accepts one value.</p>"""
    links: "capo_cognito_identity_provider.types.links_type.LinksType"
    """<p>A map of URLs to languages. For each localized language that will view the requested <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code> displays for all languages that don't have a language-specific URL.</p> <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es"</code>.</p>"""
    creation_date: "capo_cognito_identity_provider.types.date_type.DateType"
    """<p>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 <code>Date</code> object.</p>"""
    last_modified_date: "capo_cognito_identity_provider.types.date_type.DateType"
    """<p>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 <code>Date</code> object.</p>"""

client_id instance-attribute 

client_id: ClientIdType

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

creation_date instance-attribute 

creation_date: DateType

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.

enforcement instance-attribute 

enforcement: TermsEnforcementType

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

last_modified_date instance-attribute 

last_modified_date: DateType

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.

links: LinksType

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".

terms_id instance-attribute 

terms_id: TermsIdType

The ID of the terms documents.

terms_name instance-attribute 

terms_name: TermsNameType

The type and friendly name of the terms documents.

terms_source instance-attribute 

terms_source: TermsSourceType

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

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

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