CognitoIdentityProvider / Paginator / ListResourceServers

ListResourceServers

class CognitoIdentityProvider.Paginator.ListResourceServers

paginator = client.get_paginator('list_resource_servers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CognitoIdentityProvider.Client.list_resource_servers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    UserPoolId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• UserPoolId (string) –

  [REQUIRED]

  The user pool ID for the user pool.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • ResourceServers (list) –

    The resource servers.

    • (dict) –

      The details of a resource server configuration and associated custom scopes in a user pool.

      This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

      • UserPoolId (string) –

        The ID of the user pool that contains the resource server configuration.

      • Identifier (string) –

        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.

      • Name (string) –

        The name of the resource server.

      • Scopes (list) –

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

        • (dict) –

          One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType. For more information, see Scopes, M2M, and API authorization with resource servers.

          This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

          • ScopeName (string) –

            The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName. For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer, you request and receive the scope exampleResourceServer/exampleScope.

          • ScopeDescription (string) –

            A friendly description of a custom scope.