CognitoIdentityProvider / Client / describe_terms

describe_terms

CognitoIdentityProvider.Client.describe_terms(**kwargs)

Returns details for the requested terms documents ID. For more information, see Terms documents.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_terms(
    TermsId='string',
    UserPoolId='string'
)
Parameters:

  • TermsId (string) –

    [REQUIRED]

    The ID of the terms documents that you want to describe.

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool that contains the terms documents that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Terms': {
        'TermsId': 'string',
        'UserPoolId': 'string',
        'ClientId': 'string',
        'TermsName': 'string',
        'TermsSource': 'LINK',
        'Enforcement': 'NONE',
        'Links': {
            'string': 'string'
        },
        'CreationDate': datetime(2015, 1, 1),
        'LastModifiedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Terms (dict) –

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

      • TermsId (string) –

        The ID of the terms documents.

      • UserPoolId (string) –

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

      • ClientId (string) –

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

      • TermsName (string) –

        The type and friendly name of the terms documents.

      • TermsSource (string) –

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

      • Enforcement (string) –

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

      • Links (dict) –

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

        • (string) –

          • (string) –

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

Exceptions