Amazonka.StorageGateway.DescribeTapeArchives

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.

Creating a Request

data DescribeTapeArchives

DescribeTapeArchivesInput

See: newDescribeTapeArchives smart constructor.

Constructors

DescribeTapeArchives'

Fields

• limit :: Maybe Natural

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

• marker :: Maybe Text

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

• tapeARNs :: Maybe [Text]

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

Instances

ToJSON DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

toJSON :: DescribeTapeArchives -> Value

toEncoding :: DescribeTapeArchives -> Encoding

toJSONList :: [DescribeTapeArchives] -> Value

toEncodingList :: [DescribeTapeArchives] -> Encoding

ToHeaders DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

toHeaders :: DescribeTapeArchives -> [Header]

ToPath DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

toPath :: DescribeTapeArchives -> ByteString

ToQuery DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

toQuery :: DescribeTapeArchives -> QueryString

AWSPager DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

page :: DescribeTapeArchives -> AWSResponse DescribeTapeArchives -> Maybe DescribeTapeArchives

AWSRequest DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Associated Types

type AWSResponse DescribeTapeArchives

Methods

request :: (Service -> Service) -> DescribeTapeArchives -> Request DescribeTapeArchives

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTapeArchives -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTapeArchives)))

Generic DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Associated Types

type Rep DescribeTapeArchives :: Type -> Type

Methods

from :: DescribeTapeArchives -> Rep DescribeTapeArchives x

to :: Rep DescribeTapeArchives x -> DescribeTapeArchives

Read DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

readsPrec :: Int -> ReadS DescribeTapeArchives

readList :: ReadS [DescribeTapeArchives]

readPrec :: ReadPrec DescribeTapeArchives

readListPrec :: ReadPrec [DescribeTapeArchives]

Show DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

showsPrec :: Int -> DescribeTapeArchives -> ShowS

show :: DescribeTapeArchives -> String

showList :: [DescribeTapeArchives] -> ShowS

NFData DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

rnf :: DescribeTapeArchives -> ()

Eq DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

(==) :: DescribeTapeArchives -> DescribeTapeArchives -> Bool

(/=) :: DescribeTapeArchives -> DescribeTapeArchives -> Bool

Hashable DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

hashWithSalt :: Int -> DescribeTapeArchives -> Int

hash :: DescribeTapeArchives -> Int

type AWSResponse DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

type AWSResponse DescribeTapeArchives = DescribeTapeArchivesResponse

type Rep DescribeTapeArchives

Defined in Amazonka.StorageGateway.DescribeTapeArchives

type Rep DescribeTapeArchives = D1 ('MetaData "DescribeTapeArchives" "Amazonka.StorageGateway.DescribeTapeArchives" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeTapeArchives'" '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 "tapeARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeTapeArchives :: DescribeTapeArchives

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:limit:DescribeTapeArchives', describeTapeArchives_limit - Specifies that the number of virtual tapes described be limited to the specified number.

DescribeTapeArchives, describeTapeArchives_marker - An opaque string that indicates the position at which to begin describing virtual tapes.

$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_limit :: Lens' DescribeTapeArchives (Maybe Natural)

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

describeTapeArchives_marker :: Lens' DescribeTapeArchives (Maybe Text)

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

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

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

Destructuring the Response

data DescribeTapeArchivesResponse

DescribeTapeArchivesOutput

See: newDescribeTapeArchivesResponse smart constructor.

Constructors

DescribeTapeArchivesResponse'

Fields

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

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Associated Types

type Rep DescribeTapeArchivesResponse :: Type -> Type

Methods

from :: DescribeTapeArchivesResponse -> Rep DescribeTapeArchivesResponse x

to :: Rep DescribeTapeArchivesResponse x -> DescribeTapeArchivesResponse

Read DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

readsPrec :: Int -> ReadS DescribeTapeArchivesResponse

readList :: ReadS [DescribeTapeArchivesResponse]

readPrec :: ReadPrec DescribeTapeArchivesResponse

readListPrec :: ReadPrec [DescribeTapeArchivesResponse]

Show DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

showsPrec :: Int -> DescribeTapeArchivesResponse -> ShowS

show :: DescribeTapeArchivesResponse -> String

showList :: [DescribeTapeArchivesResponse] -> ShowS

NFData DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

rnf :: DescribeTapeArchivesResponse -> ()

Eq DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

Methods

(==) :: DescribeTapeArchivesResponse -> DescribeTapeArchivesResponse -> Bool

(/=) :: DescribeTapeArchivesResponse -> DescribeTapeArchivesResponse -> Bool

type Rep DescribeTapeArchivesResponse

Defined in Amazonka.StorageGateway.DescribeTapeArchives

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

newDescribeTapeArchivesResponse

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:

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: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:httpStatus:DescribeTapeArchivesResponse', describeTapeArchivesResponse_httpStatus - The response's http status code.

Response Lenses

describeTapeArchivesResponse_marker :: Lens' DescribeTapeArchivesResponse (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.

describeTapeArchivesResponse_tapeArchives :: Lens' DescribeTapeArchivesResponse (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.

describeTapeArchivesResponse_httpStatus :: Lens' DescribeTapeArchivesResponse Int

The response's http status code.