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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTapes Source #

DescribeTapesInput

See: newDescribeTapes smart constructor.

Constructors

DescribeTapes'

Fields

marker :: Maybe Text
A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
limit :: Maybe Natural
Specifies that the number of virtual tapes described be limited to the specified number.
Amazon Web Services may impose its own limit, if this field is not set.
tapeARNs :: Maybe [Text]
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
gatewayARN :: Text

Instances

Instances details

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

newDescribeTapes Source #

Arguments

:: Text	`$sel:gatewayARN:DescribeTapes'`
-> DescribeTapes

Create a value of DescribeTapes 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:DescribeTapes', describeTapes_marker - A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

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

Amazon Web Services may impose its own limit, if this field is not set.

$sel:tapeARNs:DescribeTapes', describeTapes_tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

$sel:gatewayARN:DescribeTapes', describeTapes_gatewayARN - Undocumented member.

Request Lenses

describeTapes_marker :: Lens' DescribeTapes (Maybe Text) Source #

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

describeTapes_limit :: Lens' DescribeTapes (Maybe Natural) Source #

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

Amazon Web Services may impose its own limit, if this field is not set.

describeTapes_tapeARNs :: Lens' DescribeTapes (Maybe [Text]) Source #

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

describeTapes_gatewayARN :: Lens' DescribeTapes Text Source #

Undocumented member.

Destructuring the Response

data DescribeTapesResponse Source #

DescribeTapesOutput

See: newDescribeTapesResponse smart constructor.

Constructors

DescribeTapesResponse'
Fields marker :: Maybe Text An opaque string that can be used as part of a subsequent `DescribeTapes` call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved. tapes :: Maybe [Tape] An array of virtual tape descriptions. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTapesResponse Source #

Arguments

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

Create a value of DescribeTapesResponse 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:DescribeTapes', describeTapesResponse_marker - An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

If a response does not contain a marker, then there are no more results to be retrieved.

$sel:tapes:DescribeTapesResponse', describeTapesResponse_tapes - An array of virtual tape descriptions.

$sel:httpStatus:DescribeTapesResponse', describeTapesResponse_httpStatus - The response's http status code.

Response Lenses

describeTapesResponse_marker :: Lens' DescribeTapesResponse (Maybe Text) Source #

An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

If a response does not contain a marker, then there are no more results to be retrieved.

describeTapesResponse_tapes :: Lens' DescribeTapesResponse (Maybe [Tape]) Source #

An array of virtual tape descriptions.

describeTapesResponse_httpStatus :: Lens' DescribeTapesResponse Int Source #

The response's http status code.