CognitoIdentityProvider / Client / delete_terms

delete_terms

CognitoIdentityProvider.Client.delete_terms(**kwargs)

Deletes the terms documents with the requested ID from your app client.

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.delete_terms(
    TermsId='string',
    UserPoolId='string'
)
Parameters:

  • TermsId (string) –

    [REQUIRED]

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

  • UserPoolId (string) –

    [REQUIRED]

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

Returns:

None

Exceptions