describe_resource_server ¶

describe_resource_server(
    user_pool_id: UserPoolIdType,
    identifier: ResourceServerIdentifierType,
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> DescribeResourceServerResponse

Describes a resource server. For more information about resource servers, see Access control with resource servers.

Parameters:

user_pool_id (UserPoolIdType) –

The ID of the user pool that hosts the resource server.
identifier (ResourceServerIdentifierType) –

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Raises:

InternalErrorException –

This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException –

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException –

This exception is thrown when a user isn't authorized.
OperationNotEnabledException –

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.
ResourceNotFoundException –

This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException –

This exception is thrown when the user has made too many requests for a given operation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cognito_identity_provider/_services/cognito_identity_provider.py

def describe_resource_server(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    identifier: "capo_cognito_identity_provider.types.resource_server_identifier_type.ResourceServerIdentifierType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.describe_resource_server_response.DescribeResourceServerResponse":
    """<p>Describes a resource server. For more information about resource servers, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">Access control with resource servers</a>.</p>

    Args:
        user_pool_id: <p>The ID of the user pool that hosts the resource server.</p>
        identifier: <p>A unique resource server identifier for the resource server. The identifier can be an API friendly name like <code>solar-system-data</code>. You can also set an API URL like <code>https://solar-system-data-api.example.com</code> as your identifier.</p> <p>Amazon Cognito represents scopes in the access token in the format <code>$resource-server-identifier/$scope</code>. Longer scope-identifier strings increase the size of your access tokens.</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_resource_server_request.DescribeResourceServerRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.describe_resource_server_response.DescribeResourceServerResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_resource_server

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeResourceServer")
    )
    input_: capo_cognito_identity_provider.types.describe_resource_server_request.DescribeResourceServerRequest = {
        "user_pool_id": user_pool_id,
        "identifier": identifier,
    }

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