OpenSearchMemory / Paginator / ListSpaces
ListSpaces¶
- class OpenSearchMemory.Paginator.ListSpaces¶
paginator = client.get_paginator('list_spaces')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
OpenSearchMemory.Client.list_spaces().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 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
NextTokenwill 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
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'spaces': [ { 'spaceId': 'string', 'arn': 'string', 'name': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED', 'createdAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
spaces (list) –
The spaces.
(dict) –
A summary of a space, as returned by
ListSpaces.spaceId (string) –
The ID of the space.
arn (string) –
The Amazon Resource Name (ARN) of the space.
name (string) –
The name of the space.
status (string) –
The status of the space.
createdAt (datetime) –
When the space was created.
NextToken (string) –
A token to resume pagination.