ElastiCache / Client / export_serverless_cache_snapshot

export_serverless_cache_snapshot#

ElastiCache.Client.export_serverless_cache_snapshot(**kwargs)#

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.

See also: AWS API Documentation

Request Syntax

response = client.export_serverless_cache_snapshot(
    ServerlessCacheSnapshotName='string',
    S3BucketName='string'
)
Parameters:

  • ServerlessCacheSnapshotName (string) –

    [REQUIRED]

    The identifier of the serverless cache snapshot to be exported to S3. Available for Redis OSS only.

  • S3BucketName (string) –

    [REQUIRED]

    Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis OSS only.

Return type:

dict

Returns:

Response Syntax

{
    'ServerlessCacheSnapshot': {
        '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) –

    • ServerlessCacheSnapshot (dict) –

      The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis OSS and Serverless Memcached only.

      • ServerlessCacheSnapshotName (string) –

        The identifier of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

      • ARN (string) –

        The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

      • KmsKeyId (string) –

        The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

      • SnapshotType (string) –

        The type of snapshot of serverless cache. Available for Redis OSS and Serverless Memcached only.

      • Status (string) –

        The current status of the serverless cache. Available for Redis OSS and Serverless Memcached 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 OSS and Serverless Memcached only.

      • ExpiryTime (datetime) –

        The time that the serverless cache snapshot will expire. Available for Redis OSS and Serverless Memcached only.

      • BytesUsedForCache (string) –

        The total size of a serverless cache snapshot, in bytes. Available for Redis OSS and Serverless Memcached only.

      • ServerlessCacheConfiguration (dict) –

        The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis OSS and Serverless Memcached 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.

Exceptions

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotNotFoundFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheSnapshotStateFault

  • ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • ElastiCache.Client.exceptions.InvalidParameterValueException