describe_terms_by_client ¶

def describe_terms_by_client(
    self,
    client_id: "capo_cognito_identity_provider.types.client_id_type.ClientIdType",
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    terms_name: "capo_cognito_identity_provider.types.terms_name_type.TermsNameType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.describe_terms_by_client_response.DescribeTermsByClientResponse":
    """<p>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 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p> <p>To call <code>DescribeTermsByClient</code>, you must have the <code>cognito-idp:DescribeTermsByClient</code> Identity and Access Management (IAM) permission. An IAM policy that denies <code>cognito-idp:DescribeTerms</code> also denies requests to <code>DescribeTermsByClient</code>.</p> <note> <p>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.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        client_id: <p>The ID of the app client that the terms documents are associated with.</p>
        user_pool_id: <p>The ID of the user pool that contains the terms documents that you want to describe.</p>
        terms_name: <p>The name of the terms documents that you want to describe.</p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.describe_terms_by_client_request.DescribeTermsByClientRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.describe_terms_by_client_response.DescribeTermsByClientResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_terms_by_client

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_terms_by_client.describe_terms_by_client(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.describe_terms_by_client_request.DescribeTermsByClientRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.describe_terms_by_client_request

        return capo_cognito_identity_provider.types.describe_terms_by_client_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_cognito_identity_provider.types.describe_terms_by_client_response.DescribeTermsByClientResponse",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.describe_terms_by_client_response

        return capo_cognito_identity_provider.types.describe_terms_by_client_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeTermsByClient",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_cognito_identity_provider.types.describe_terms_by_client_request.DescribeTermsByClientRequest = {
        "client_id": client_id,
        "user_pool_id": user_pool_id,
        "terms_name": terms_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output