Delete Terms

cognitoidentityprovider_delete_terms

R Documentation

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

Description

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

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_delete_terms(TermsId, UserPoolId)

Arguments

TermsId	[required] The ID of the terms documents that you want to delete.
UserPoolId	[required] The ID of the user pool that contains the terms documents that you want to delete.

Value

An empty list.

Request syntax

svc$delete_terms(
  TermsId = "string",
  UserPoolId = "string"
)