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) –

        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) –

          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) –

            A resource server scope.

            • ScopeName (string) –

              The name of the scope.

            • ScopeDescription (string) –

              A description of the scope.