DescribeTermsByClientRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeTermsByClient operation. 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 DescribeTermsByClient, you must have the cognito-idp:DescribeTermsByClient Identity and Access Management (IAM) permission. This operation additionally validates your permission for cognito-idp:DescribeTerms, the action for . As a result, an IAM policy that denies cognito-idp:DescribeTerms also denies requests to DescribeTermsByClient.

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

In this article ▶

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.DescribeTermsByClientRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class DescribeTermsByClientRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The DescribeTermsByClientRequest type exposes the following members

Constructors

	Name	Description
	DescribeTermsByClientRequest()

Properties

Name	Type	Description
ClientId	System.String	Gets and sets the property ClientId. The ID of the app client that the terms documents are associated with.
TermsName	System.String	Gets and sets the property TermsName. The name of the terms documents that you want to describe.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool that contains the terms documents that you want to describe.

Name

Type

Description