EC2 / Client / modify_snapshot_tier

modify_snapshot_tier#

EC2.Client.modify_snapshot_tier(**kwargs)#

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_snapshot_tier(
    SnapshotId='string',
    StorageTier='archive',
    DryRun=True|False
)
Parameters:

  • SnapshotId (string) –

    [REQUIRED]

    The ID of the snapshot.

  • StorageTier (string) – The name of the storage tier. You must specify archive.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotId': 'string',
    'TieringStartTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • SnapshotId (string) –

      The ID of the snapshot.

    • TieringStartTime (datetime) –

      The date and time when the archive process was started.