Skip to content

DescribeTermsByClientRequest

Source code in docs_src/capo_cognito_identity_provider/types/describe_terms_by_client_request.py
class DescribeTermsByClientRequest(TypedDict, closed=True):
    client_id: "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    """<p>The ID of the app client that the terms documents are associated with.</p>"""
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool that contains the terms documents that you want to describe.</p>"""
    terms_name: "capo_cognito_identity_provider.types.terms_name_type.TermsNameType"
    """<p>The name of the terms documents that you want to describe.</p>"""

client_id instance-attribute

client_id: ClientIdType

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

terms_name instance-attribute

terms_name: TermsNameType

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

user_pool_id instance-attribute

user_pool_id: UserPoolIdType

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