amazonka-storagegateway-2.0: Amazon Storage Gateway 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.StorageGateway.DescribeTapeRecoveryPoints

Description

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTapeRecoveryPoints Source #

DescribeTapeRecoveryPointsInput

See: newDescribeTapeRecoveryPoints smart constructor.

Constructors

DescribeTapeRecoveryPoints' 

Fields

  • limit :: Maybe Natural

    Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

  • marker :: Maybe Text

    An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

  • gatewayARN :: Text
     

Instances

Instances details
ToJSON DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

ToHeaders DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

ToPath DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

ToQuery DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

AWSPager DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

AWSRequest DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Generic DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Associated Types

type Rep DescribeTapeRecoveryPoints :: Type -> Type #

Read DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Show DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

NFData DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Eq DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Hashable DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

type AWSResponse DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

type Rep DescribeTapeRecoveryPoints Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

type Rep DescribeTapeRecoveryPoints = D1 ('MetaData "DescribeTapeRecoveryPoints" "Amazonka.StorageGateway.DescribeTapeRecoveryPoints" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeTapeRecoveryPoints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeTapeRecoveryPoints Source #

Create a value of DescribeTapeRecoveryPoints 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:limit:DescribeTapeRecoveryPoints', describeTapeRecoveryPoints_limit - Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

DescribeTapeRecoveryPoints, describeTapeRecoveryPoints_marker - An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

DescribeTapeRecoveryPoints, describeTapeRecoveryPoints_gatewayARN - Undocumented member.

Request Lenses

describeTapeRecoveryPoints_limit :: Lens' DescribeTapeRecoveryPoints (Maybe Natural) Source #

Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

describeTapeRecoveryPoints_marker :: Lens' DescribeTapeRecoveryPoints (Maybe Text) Source #

An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

Destructuring the Response

data DescribeTapeRecoveryPointsResponse Source #

DescribeTapeRecoveryPointsOutput

See: newDescribeTapeRecoveryPointsResponse smart constructor.

Constructors

DescribeTapeRecoveryPointsResponse' 

Fields

  • gatewayARN :: Maybe Text
     
  • marker :: Maybe Text

    An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

    Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

  • tapeRecoveryPointInfos :: Maybe [TapeRecoveryPointInfo]

    An array of TapeRecoveryPointInfos that are available for the specified gateway.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Associated Types

type Rep DescribeTapeRecoveryPointsResponse :: Type -> Type #

Read DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Show DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

NFData DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

Eq DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

type Rep DescribeTapeRecoveryPointsResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DescribeTapeRecoveryPoints

type Rep DescribeTapeRecoveryPointsResponse = D1 ('MetaData "DescribeTapeRecoveryPointsResponse" "Amazonka.StorageGateway.DescribeTapeRecoveryPoints" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeTapeRecoveryPointsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tapeRecoveryPointInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TapeRecoveryPointInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTapeRecoveryPointsResponse Source #

Create a value of DescribeTapeRecoveryPointsResponse 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:

DescribeTapeRecoveryPoints, describeTapeRecoveryPointsResponse_gatewayARN - Undocumented member.

DescribeTapeRecoveryPoints, describeTapeRecoveryPointsResponse_marker - An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

$sel:tapeRecoveryPointInfos:DescribeTapeRecoveryPointsResponse', describeTapeRecoveryPointsResponse_tapeRecoveryPointInfos - An array of TapeRecoveryPointInfos that are available for the specified gateway.

$sel:httpStatus:DescribeTapeRecoveryPointsResponse', describeTapeRecoveryPointsResponse_httpStatus - The response's http status code.

Response Lenses

describeTapeRecoveryPointsResponse_marker :: Lens' DescribeTapeRecoveryPointsResponse (Maybe Text) Source #

An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

describeTapeRecoveryPointsResponse_tapeRecoveryPointInfos :: Lens' DescribeTapeRecoveryPointsResponse (Maybe [TapeRecoveryPointInfo]) Source #

An array of TapeRecoveryPointInfos that are available for the specified gateway.