EC2 / Client / describe_snapshot_tier_status

describe_snapshot_tier_status

EC2.Client.describe_snapshot_tier_status(**kwargs)

Describes the storage tier status of one or more Amazon EBS snapshots.

See also: AWS API Documentation

Request Syntax

response = client.describe_snapshot_tier_status(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters:

• Filters (list) –

  The filters.

  • snapshot-id - The snapshot ID.

  • volume-id - The ID of the volume the snapshot is for.

  • last-tiering-operation - The state of the last archive or restore action. ( archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• 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.

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotTierStatuses': [
        {
            'SnapshotId': 'string',
            'VolumeId': 'string',
            'Status': 'pending'|'completed'|'error'|'recoverable'|'recovering',
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'StorageTier': 'archive'|'standard',
            'LastTieringStartTime': datetime(2015, 1, 1),
            'LastTieringProgress': 123,
            'LastTieringOperationStatus': 'archival-in-progress'|'archival-completed'|'archival-failed'|'temporary-restore-in-progress'|'temporary-restore-completed'|'temporary-restore-failed'|'permanent-restore-in-progress'|'permanent-restore-completed'|'permanent-restore-failed',
            'LastTieringOperationStatusDetail': 'string',
            'ArchivalCompleteTime': datetime(2015, 1, 1),
            'RestoreExpiryTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • SnapshotTierStatuses (list) –

    Information about the snapshot’s storage tier.

    • (dict) –

      Provides information about a snapshot’s storage tier.

      • SnapshotId (string) –

        The ID of the snapshot.

      • VolumeId (string) –

        The ID of the volume from which the snapshot was created.

      • Status (string) –

        The state of the snapshot.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the snapshot.

      • Tags (list) –

        The tags that are assigned to the snapshot.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • StorageTier (string) –

        The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

      • LastTieringStartTime (datetime) –

        The date and time when the last archive or restore process was started.

      • LastTieringProgress (integer) –

        The progress of the last archive or restore process, as a percentage.

      • LastTieringOperationStatus (string) –

        The status of the last archive or restore process.

      • LastTieringOperationStatusDetail (string) –

        A message describing the status of the last archive or restore process.

      • ArchivalCompleteTime (datetime) –

        The date and time when the last archive process was completed.

      • RestoreExpiryTime (datetime) –

        Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.