ElastiCache / Paginator / DescribeServerlessCacheSnapshots
DescribeServerlessCacheSnapshots#
- class ElastiCache.Paginator.DescribeServerlessCacheSnapshots#
paginator = client.get_paginator('describe_serverless_cache_snapshots')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
ElastiCache.Client.describe_serverless_cache_snapshots()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ServerlessCacheName='string', ServerlessCacheSnapshotName='string', SnapshotType='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
ServerlessCacheName (string) – The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis only.
ServerlessCacheSnapshotName (string) – The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis only.
SnapshotType (string) – The type of snapshot that is being described. Available for Redis only.
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
{ 'ServerlessCacheSnapshots': [ { 'ServerlessCacheSnapshotName': 'string', 'ARN': 'string', 'KmsKeyId': 'string', 'SnapshotType': 'string', 'Status': 'string', 'CreateTime': datetime(2015, 1, 1), 'ExpiryTime': datetime(2015, 1, 1), 'BytesUsedForCache': 'string', 'ServerlessCacheConfiguration': { 'ServerlessCacheName': 'string', 'Engine': 'string', 'MajorEngineVersion': 'string' } }, ] }
Response Structure
(dict) –
ServerlessCacheSnapshots (list) –
The serverless caches snapshots associated with a given description request. Available for Redis only.
(dict) –
The resource representing a serverless cache snapshot. Available for Redis only.
ServerlessCacheSnapshotName (string) –
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) –
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) –
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) –
The type of snapshot of serverless cache. Available for Redis only.
Status (string) –
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) –
The date and time that the source serverless cache’s metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) –
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) –
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) –
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) –
The identifier of a serverless cache.
Engine (string) –
The engine that the serverless cache is configured with.
MajorEngineVersion (string) –
The engine version number that the serverless cache is configured with.