CodeCatalyst / Client / list_spaces

list_spaces

CodeCatalyst.Client.list_spaces(**kwargs)

Retrieves a list of spaces.

See also: AWS API Documentation

Request Syntax

response = client.list_spaces(
    nextToken='string'
)

Parameters:

nextToken (string) – A token returned from a call to this API to indicate the next batch of results to return, if any.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • nextToken (string) –

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • 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.

Exceptions

• CodeCatalyst.Client.exceptions.ThrottlingException

• CodeCatalyst.Client.exceptions.ConflictException

• CodeCatalyst.Client.exceptions.ValidationException

• CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

• CodeCatalyst.Client.exceptions.ResourceNotFoundException

• CodeCatalyst.Client.exceptions.AccessDeniedException