CloudWatchOmni / Paginator / ListSpaces

ListSpaces¶

class CloudWatchOmni.Paginator.ListSpaces¶

paginator = client.get_paginator('list_spaces')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

domainId (string) – Filter by domain ID.
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

{
    '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 resume pagination.