CodeCatalyst / Paginator / ListSpaces

ListSpaces

class CodeCatalyst.Paginator.ListSpaces

paginator = client.get_paginator('list_spaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_spaces().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'name': 'string',
            'regionName': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Information about the spaces.

    • (dict) –

      Information about an space.

      • name (string) –

        The name of the space.

      • regionName (string) –

        The Amazon Web Services Region where the space exists.

      • displayName (string) –

        The friendly name of the space displayed to users.

      • description (string) –

        The description of the space.

  • NextToken (string) –

    A token to resume pagination.