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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

This operation returns paginated results.

Synopsis

data ListTapes = ListTapes' {
- marker :: Maybe Text
- limit :: Maybe Natural
- tapeARNs :: Maybe [Text]
}
newListTapes :: ListTapes
listTapes_marker :: Lens' ListTapes (Maybe Text)
listTapes_limit :: Lens' ListTapes (Maybe Natural)
listTapes_tapeARNs :: Lens' ListTapes (Maybe [Text])
data ListTapesResponse = ListTapesResponse' {
- marker :: Maybe Text
- tapeInfos :: Maybe [TapeInfo]
- httpStatus :: Int
}
newListTapesResponse :: Int -> ListTapesResponse
listTapesResponse_marker :: Lens' ListTapesResponse (Maybe Text)
listTapesResponse_tapeInfos :: Lens' ListTapesResponse (Maybe [TapeInfo])
listTapesResponse_httpStatus :: Lens' ListTapesResponse Int

Creating a Request

data ListTapes Source #

A JSON object that contains one or more of the following fields:

ListTapesInput$Limit
ListTapesInput$Marker
ListTapesInput$TapeARNs

See: newListTapes smart constructor.

Constructors

ListTapes'
Fields marker :: Maybe Text A string that indicates the position at which to begin the returned list of tapes. limit :: Maybe Natural An optional number limit for the tapes in the list returned by this call. tapeARNs :: Maybe [Text]

Instances

Instances details

Eq ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods (==) :: ListTapes -> ListTapes -> Bool # (/=) :: ListTapes -> ListTapes -> Bool #
Read ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods readsPrec :: Int -> ReadS ListTapes # readList :: ReadS [ListTapes] # readPrec :: ReadPrec ListTapes # readListPrec :: ReadPrec [ListTapes] #
Show ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods showsPrec :: Int -> ListTapes -> ShowS # show :: ListTapes -> String # showList :: [ListTapes] -> ShowS #
Generic ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Associated Types type Rep ListTapes :: Type -> Type # Methods from :: ListTapes -> Rep ListTapes x # to :: Rep ListTapes x -> ListTapes #
NFData ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods rnf :: ListTapes -> () #
Hashable ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods hashWithSalt :: Int -> ListTapes -> Int # hash :: ListTapes -> Int #
ToJSON ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods toJSON :: ListTapes -> Value # toEncoding :: ListTapes -> Encoding # toJSONList :: [ListTapes] -> Value # toEncodingList :: [ListTapes] -> Encoding #
AWSPager ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods page :: ListTapes -> AWSResponse ListTapes -> Maybe ListTapes #
AWSRequest ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Associated Types type AWSResponse ListTapes # Methods request :: ListTapes -> Request ListTapes # response :: MonadResource m => Logger -> Service -> Proxy ListTapes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTapes))) #
ToHeaders ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods toHeaders :: ListTapes -> [Header] #
ToPath ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods toPath :: ListTapes -> ByteString #
ToQuery ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes Methods toQuery :: ListTapes -> QueryString #
type Rep ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes type Rep ListTapes = D1 ('MetaData "ListTapes" "Amazonka.StorageGateway.ListTapes" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "ListTapes'" '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 ListTapes Source #
Instance details Defined in Amazonka.StorageGateway.ListTapes type AWSResponse ListTapes = ListTapesResponse

newListTapes :: ListTapes Source #

Create a value of ListTapes 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:ListTapes', listTapes_marker - A string that indicates the position at which to begin the returned list of tapes.

$sel:limit:ListTapes', listTapes_limit - An optional number limit for the tapes in the list returned by this call.

$sel:tapeARNs:ListTapes', listTapes_tapeARNs - Undocumented member.

Request Lenses

listTapes_marker :: Lens' ListTapes (Maybe Text) Source #

A string that indicates the position at which to begin the returned list of tapes.

listTapes_limit :: Lens' ListTapes (Maybe Natural) Source #

An optional number limit for the tapes in the list returned by this call.

listTapes_tapeARNs :: Lens' ListTapes (Maybe [Text]) Source #

Undocumented member.

Destructuring the Response

data ListTapesResponse Source #

A JSON object containing the following fields:

ListTapesOutput$Marker
ListTapesOutput$VolumeInfos

See: newListTapesResponse smart constructor.

Constructors

ListTapesResponse'
Fields marker :: Maybe Text A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body. tapeInfos :: Maybe [TapeInfo] httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListTapesResponse Source #

Arguments

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

Create a value of ListTapesResponse 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:ListTapes', listTapesResponse_marker - A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

$sel:tapeInfos:ListTapesResponse', listTapesResponse_tapeInfos - Undocumented member.

$sel:httpStatus:ListTapesResponse', listTapesResponse_httpStatus - The response's http status code.

Response Lenses

listTapesResponse_marker :: Lens' ListTapesResponse (Maybe Text) Source #

A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

listTapesResponse_tapeInfos :: Lens' ListTapesResponse (Maybe [TapeInfo]) Source #

Undocumented member.

listTapesResponse_httpStatus :: Lens' ListTapesResponse Int Source #

The response's http status code.