list_user_pool_clients ¶

def list_user_pool_clients(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
    max_results: Optional[
        "capo_cognito_identity_provider.types.query_limit.QueryLimit"
    ] = None,
    next_token: Optional[
        "capo_cognito_identity_provider.types.pagination_key.PaginationKey"
    ] = None,
) -> "capo_cognito_identity_provider.types.list_user_pool_clients_response.ListUserPoolClientsResponse":
    """<p>Given a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html">App clients</a>.</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:
        user_pool_id: <p>The ID of the user pool where you want to list user pool clients.</p>
        max_results: <p>The maximum number of app clients that you want Amazon Cognito to return in the response.</p>
        next_token: <p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</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.list_user_pool_clients_request.ListUserPoolClientsRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.list_user_pool_clients_response.ListUserPoolClientsResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.list_user_pool_clients

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

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

        return capo_cognito_identity_provider.types.list_user_pool_clients_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListUserPoolClients", redact_output=_redact_output),
    )
    input_: capo_cognito_identity_provider.types.list_user_pool_clients_request.ListUserPoolClientsRequest = {
        "user_pool_id": user_pool_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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