snapshot_tier_status

Creates, updates, deletes, gets or lists a snapshot_tier_status resource.

Overview

Name	snapshot_tier_status
Type	Resource
Id	aws.ec2.snapshot_tier_status

Fields

The following fields are returned by SELECT queries:

describe_snapshot_tier_status

Name	Datatype	Description
archival_complete_time	string	The date and time when the last archive process was completed.
last_tiering_operation_status	string	The status of the last archive or restore process.
last_tiering_operation_status_detail	string	A message describing the status of the last archive or restore process.
last_tiering_progress	integer	The progress of the last archive or restore process, as a percentage.
last_tiering_start_time	string	The date and time when the last archive or restore process was started.
owner_id	string	The ID of the Amazon Web Services account that owns the snapshot.
restore_expiry_time	string	Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_id	string	The ID of the snapshot.
status	string	The state of the snapshot.
storage_tier	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.
tags	string	The tags that are assigned to the snapshot.
volume_id	string	The ID of the volume from which the snapshot was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_snapshot_tier_status	select	region	Filter, DryRun, NextToken, MaxResults	Describes the storage tier status of one or more Amazon EBS snapshots.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
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.
Filter	array	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)
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.
NextToken	string	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

SELECT examples

describe_snapshot_tier_status

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

SELECT
archival_complete_time,
last_tiering_operation_status,
last_tiering_operation_status_detail,
last_tiering_progress,
last_tiering_start_time,
owner_id,
restore_expiry_time,
snapshot_id,
status,
storage_tier,
tags,
volume_id
FROM aws.ec2.snapshot_tier_status
WHERE region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;