ElastiCache / Client / copy_serverless_cache_snapshot

copy_serverless_cache_snapshot#

ElastiCache.Client.copy_serverless_cache_snapshot(**kwargs)#

Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.

See also: AWS API Documentation

Request Syntax

response = client.copy_serverless_cache_snapshot(
    SourceServerlessCacheSnapshotName='string',
    TargetServerlessCacheSnapshotName='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • SourceServerlessCacheSnapshotName (string) –

    [REQUIRED]

    The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis OSS and Serverless Memcached only.

  • TargetServerlessCacheSnapshotName (string) –

    [REQUIRED]

    The identifier for the snapshot to be created. Available for Redis OSS and Serverless Memcached only.

  • KmsKeyId (string) – The identifier of the KMS key used to encrypt the target snapshot. Available for Redis OSS and Serverless Memcached only.

  • Tags (list) –

    A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis OSS and Serverless Memcached only. Default: NULL

    • (dict) –

      A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.

      • Key (string) –

        The key for the tag. May not be null.

      • Value (string) –

        The tag’s value. May be null.

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 response for the attempt to copy the serverless cache snapshot. 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.ServerlessCacheSnapshotAlreadyExistsFault

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotNotFoundFault

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotQuotaExceededFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheSnapshotStateFault

  • ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • ElastiCache.Client.exceptions.TagQuotaPerResourceExceeded

  • ElastiCache.Client.exceptions.InvalidParameterValueException

  • ElastiCache.Client.exceptions.InvalidParameterCombinationException