Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StorageGateway.DescribeTapeArchives

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

This operation returns paginated results.

Synopsis

data DescribeTapeArchives = DescribeTapeArchives' {
- marker :: Maybe Text
- limit :: Maybe Natural
- tapeARNs :: Maybe [Text]
}
newDescribeTapeArchives :: DescribeTapeArchives
describeTapeArchives_marker :: Lens' DescribeTapeArchives (Maybe Text)
describeTapeArchives_limit :: Lens' DescribeTapeArchives (Maybe Natural)
describeTapeArchives_tapeARNs :: Lens' DescribeTapeArchives (Maybe [Text])
data DescribeTapeArchivesResponse = DescribeTapeArchivesResponse' {
- tapeArchives :: Maybe [TapeArchive]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeTapeArchivesResponse :: Int -> DescribeTapeArchivesResponse
describeTapeArchivesResponse_tapeArchives :: Lens' DescribeTapeArchivesResponse (Maybe [TapeArchive])
describeTapeArchivesResponse_marker :: Lens' DescribeTapeArchivesResponse (Maybe Text)
describeTapeArchivesResponse_httpStatus :: Lens' DescribeTapeArchivesResponse Int

Creating a Request

data DescribeTapeArchives Source #

DescribeTapeArchivesInput

See: newDescribeTapeArchives smart constructor.

Constructors

DescribeTapeArchives'
Fields marker :: Maybe Text An opaque string that indicates the position at which to begin describing virtual tapes. limit :: Maybe Natural Specifies that the number of virtual tapes described be limited to the specified number. tapeARNs :: Maybe [Text] Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Instances

Instances details

Eq DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods (==) :: DescribeTapeArchives -> DescribeTapeArchives -> Bool # (/=) :: DescribeTapeArchives -> DescribeTapeArchives -> Bool #
Read DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods readsPrec :: Int -> ReadS DescribeTapeArchives # readList :: ReadS [DescribeTapeArchives] # readPrec :: ReadPrec DescribeTapeArchives # readListPrec :: ReadPrec [DescribeTapeArchives] #
Show DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods showsPrec :: Int -> DescribeTapeArchives -> ShowS # show :: DescribeTapeArchives -> String # showList :: [DescribeTapeArchives] -> ShowS #
Generic DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Associated Types type Rep DescribeTapeArchives :: Type -> Type # Methods from :: DescribeTapeArchives -> Rep DescribeTapeArchives x # to :: Rep DescribeTapeArchives x -> DescribeTapeArchives #
NFData DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods rnf :: DescribeTapeArchives -> () #
Hashable DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods hashWithSalt :: Int -> DescribeTapeArchives -> Int # hash :: DescribeTapeArchives -> Int #
ToJSON DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods toJSON :: DescribeTapeArchives -> Value # toEncoding :: DescribeTapeArchives -> Encoding # toJSONList :: [DescribeTapeArchives] -> Value # toEncodingList :: [DescribeTapeArchives] -> Encoding #
AWSPager DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods page :: DescribeTapeArchives -> AWSResponse DescribeTapeArchives -> Maybe DescribeTapeArchives #
AWSRequest DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Associated Types type AWSResponse DescribeTapeArchives # Methods request :: DescribeTapeArchives -> Request DescribeTapeArchives # response :: MonadResource m => Logger -> Service -> Proxy DescribeTapeArchives -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTapeArchives))) #
ToHeaders DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods toHeaders :: DescribeTapeArchives -> [Header] #
ToPath DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods toPath :: DescribeTapeArchives -> ByteString #
ToQuery DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods toQuery :: DescribeTapeArchives -> QueryString #
type Rep DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives type Rep DescribeTapeArchives = D1 ('MetaData "DescribeTapeArchives" "Amazonka.StorageGateway.DescribeTapeArchives" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeTapeArchives'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "tapeARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))
type AWSResponse DescribeTapeArchives Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives type AWSResponse DescribeTapeArchives = DescribeTapeArchivesResponse

newDescribeTapeArchives :: DescribeTapeArchives Source #

Create a value of DescribeTapeArchives 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:marker:DescribeTapeArchives', describeTapeArchives_marker - An opaque string that indicates the position at which to begin describing virtual tapes.

$sel:limit:DescribeTapeArchives', describeTapeArchives_limit - Specifies that the number of virtual tapes described be limited to the specified number.

$sel:tapeARNs:DescribeTapeArchives', describeTapeArchives_tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Request Lenses

describeTapeArchives_marker :: Lens' DescribeTapeArchives (Maybe Text) Source #

An opaque string that indicates the position at which to begin describing virtual tapes.

describeTapeArchives_limit :: Lens' DescribeTapeArchives (Maybe Natural) Source #

Specifies that the number of virtual tapes described be limited to the specified number.

describeTapeArchives_tapeARNs :: Lens' DescribeTapeArchives (Maybe [Text]) Source #

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Destructuring the Response

data DescribeTapeArchivesResponse Source #

DescribeTapeArchivesOutput

See: newDescribeTapeArchivesResponse smart constructor.

Constructors

DescribeTapeArchivesResponse'

Fields

tapeArchives :: Maybe [TapeArchive]
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.
marker :: Maybe Text
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods (==) :: DescribeTapeArchivesResponse -> DescribeTapeArchivesResponse -> Bool # (/=) :: DescribeTapeArchivesResponse -> DescribeTapeArchivesResponse -> Bool #
Read DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods readsPrec :: Int -> ReadS DescribeTapeArchivesResponse # readList :: ReadS [DescribeTapeArchivesResponse] # readPrec :: ReadPrec DescribeTapeArchivesResponse # readListPrec :: ReadPrec [DescribeTapeArchivesResponse] #
Show DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods showsPrec :: Int -> DescribeTapeArchivesResponse -> ShowS # show :: DescribeTapeArchivesResponse -> String # showList :: [DescribeTapeArchivesResponse] -> ShowS #
Generic DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Associated Types type Rep DescribeTapeArchivesResponse :: Type -> Type # Methods from :: DescribeTapeArchivesResponse -> Rep DescribeTapeArchivesResponse x # to :: Rep DescribeTapeArchivesResponse x -> DescribeTapeArchivesResponse #
NFData DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives Methods rnf :: DescribeTapeArchivesResponse -> () #
type Rep DescribeTapeArchivesResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeTapeArchives type Rep DescribeTapeArchivesResponse = D1 ('MetaData "DescribeTapeArchivesResponse" "Amazonka.StorageGateway.DescribeTapeArchives" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeTapeArchivesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tapeArchives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TapeArchive])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTapeArchivesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTapeArchivesResponse'`
-> DescribeTapeArchivesResponse

Create a value of DescribeTapeArchivesResponse 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:tapeArchives:DescribeTapeArchivesResponse', describeTapeArchivesResponse_tapeArchives - An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

$sel:marker:DescribeTapeArchives', describeTapeArchivesResponse_marker - An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

$sel:httpStatus:DescribeTapeArchivesResponse', describeTapeArchivesResponse_httpStatus - The response's http status code.

Response Lenses

describeTapeArchivesResponse_tapeArchives :: Lens' DescribeTapeArchivesResponse (Maybe [TapeArchive]) Source #

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

describeTapeArchivesResponse_marker :: Lens' DescribeTapeArchivesResponse (Maybe Text) Source #

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

describeTapeArchivesResponse_httpStatus :: Lens' DescribeTapeArchivesResponse Int Source #

The response's http status code.