CognitoIdentityProvider / Client / list_resource_servers

list_resource_servers#

CognitoIdentityProvider.Client.list_resource_servers(**kwargs)#

Lists the resource servers for a user pool.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_servers(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID for the user pool.

  • MaxResults (integer) – The maximum number of resource servers to return.

  • NextToken (string) – A pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceServers': [
        {
            'UserPoolId': 'string',
            'Identifier': 'string',
            'Name': 'string',
            'Scopes': [
                {
                    'ScopeName': 'string',
                    'ScopeDescription': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceServers (list) –

      The resource servers.

      • (dict) –

        A container for information about a resource server for a user pool.

        • UserPoolId (string) –

          The user pool ID for the user pool that hosts the resource server.

        • Identifier (string) –

          The identifier for the resource server.

        • Name (string) –

          The name of the resource server.

        • Scopes (list) –

          A list of scopes that are defined for the resource server.

          • (dict) –

            A resource server scope.

            • ScopeName (string) –

              The name of the scope.

            • ScopeDescription (string) –

              A description of the scope.

    • NextToken (string) –

      A pagination token.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException