Returns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name¶

Description¶

Returns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name. For more information, see Terms documents.

To call describe_terms_by_client, you must have the cognito-idp:DescribeTermsByClient Identity and Access Management (IAM) permission. An IAM policy that denies cognito-idp:DescribeTerms also denies requests to describe_terms_by_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_describe_terms_by_client(ClientId, UserPoolId,
  TermsName)

Arguments¶

• ClientId

[required] The ID of the app client that the terms documents are associated with.

• UserPoolId

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

• TermsName

[required] The name of the terms documents that you want to describe.

Value¶

A list with the following syntax:

list(
  Terms = list(
    TermsId = "string",
    UserPoolId = "string",
    ClientId = "string",
    TermsName = "string",
    TermsSource = "LINK",
    Enforcement = "NONE",
    Links = list(
      "string"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$describe_terms_by_client(
  ClientId = "string",
  UserPoolId = "string",
  TermsName = "string"
)