amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeSnapshotTierStatus

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSnapshotTierStatus Source #

See: newDescribeSnapshotTierStatus smart constructor.

Constructors

DescribeSnapshotTierStatus' 

Fields

  • dryRun :: Maybe Bool

    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.

  • filters :: Maybe [Filter]

    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 :: Maybe Int

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

ToPath DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

ToQuery DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

AWSPager DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

AWSRequest DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Generic DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Associated Types

type Rep DescribeSnapshotTierStatus :: Type -> Type #

Read DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Show DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

NFData DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Eq DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Hashable DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

type AWSResponse DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

type Rep DescribeSnapshotTierStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

type Rep DescribeSnapshotTierStatus = D1 ('MetaData "DescribeSnapshotTierStatus" "Amazonka.EC2.DescribeSnapshotTierStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSnapshotTierStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeSnapshotTierStatus :: DescribeSnapshotTierStatus Source #

Create a value of DescribeSnapshotTierStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeSnapshotTierStatus', describeSnapshotTierStatus_dryRun - 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.

$sel:filters:DescribeSnapshotTierStatus', describeSnapshotTierStatus_filters - 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)

$sel:maxResults:DescribeSnapshotTierStatus', describeSnapshotTierStatus_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeSnapshotTierStatus, describeSnapshotTierStatus_nextToken - The token for the next page of results.

Request Lenses

describeSnapshotTierStatus_dryRun :: Lens' DescribeSnapshotTierStatus (Maybe Bool) Source #

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.

describeSnapshotTierStatus_filters :: Lens' DescribeSnapshotTierStatus (Maybe [Filter]) Source #

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)

describeSnapshotTierStatus_maxResults :: Lens' DescribeSnapshotTierStatus (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Destructuring the Response

data DescribeSnapshotTierStatusResponse Source #

Constructors

DescribeSnapshotTierStatusResponse' 

Fields

Instances

Instances details
Generic DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Associated Types

type Rep DescribeSnapshotTierStatusResponse :: Type -> Type #

Read DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Show DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

NFData DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

Eq DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

type Rep DescribeSnapshotTierStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeSnapshotTierStatus

type Rep DescribeSnapshotTierStatusResponse = D1 ('MetaData "DescribeSnapshotTierStatusResponse" "Amazonka.EC2.DescribeSnapshotTierStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSnapshotTierStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshotTierStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotTierStatus])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotTierStatusResponse Source #

Create a value of DescribeSnapshotTierStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSnapshotTierStatus, describeSnapshotTierStatusResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:snapshotTierStatuses:DescribeSnapshotTierStatusResponse', describeSnapshotTierStatusResponse_snapshotTierStatuses - Information about the snapshot's storage tier.

$sel:httpStatus:DescribeSnapshotTierStatusResponse', describeSnapshotTierStatusResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotTierStatusResponse_nextToken :: Lens' DescribeSnapshotTierStatusResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.