CloudWatchOmni / Client / list_spaces

list_spaces

CloudWatchOmni.Client.list_spaces(**kwargs)

Returns the spaces in the account, optionally filtered by domain.

See also: AWS API Documentation

Request Syntax

response = client.list_spaces(
    domainId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • domainId (string) – Filter by domain ID.

  • nextToken (string) – A token to retrieve the next page of results. Supply the same filters used on the request that returned it. Tokens expire after 24 hours.

  • maxResults (integer) – The maximum number of spaces to return per page. Defaults to 100. A page can contain fewer results than this value even when more results remain; continue while nextToken is present.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'spaceId': 'string',
            'name': 'string',
            'spaceArn': 'string',
            'domainArn': 'string',
            'region': 'string',
            'ownerAccountId': 'string',
            'status': 'ACTIVE'|'SUSPENDED'|'MOVING',
            'statusReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of space summaries.

      • (dict) –

        Summary of a space. Call GetSpace for the full space.

        • spaceId (string) –

          The unique ID of the space.

        • name (string) –

          A name that identifies the space.

        • spaceArn (string) –

          The Amazon Resource Name (ARN) of the space.

        • domainArn (string) –

          The Amazon Resource Name (ARN) of the domain the space belongs to. Absent when the space is not associated with a domain, so callers must tolerate its absence.

        • region (string) –

          The region where this space was created.

        • ownerAccountId (string) –

          AWS account ID that owns this space.

        • status (string) –

          The status of the space.

        • statusReason (string) –

          Reason for the current space status.

        • createdAt (datetime) –

          The timestamp when the space was created.

        • updatedAt (datetime) –

          The timestamp when the space was last updated.

    • nextToken (string) –

      A token to retrieve the next page of results, or null if there are no more results.

Exceptions