Describe Terms

cognitoidentityprovider_describe_terms

R Documentation

Returns details for the requested terms documents ID

Description

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

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(TermsId, UserPoolId)

Arguments

TermsId	[required] The ID of the terms documents that you want to describe.
UserPoolId	[required] The ID of the user pool that contains 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(
  TermsId = "string",
  UserPoolId = "string"
)