Amazonka.StorageGateway.DescribeTapes

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.

Creating a Request

data DescribeTapes

DescribeTapesInput

See: newDescribeTapes smart constructor.

Constructors

DescribeTapes'

Fields

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

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

• 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

ToJSON DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

toJSON :: DescribeTapes -> Value

toEncoding :: DescribeTapes -> Encoding

toJSONList :: [DescribeTapes] -> Value

toEncodingList :: [DescribeTapes] -> Encoding

ToHeaders DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

toHeaders :: DescribeTapes -> [Header]

ToPath DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

toPath :: DescribeTapes -> ByteString

ToQuery DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

toQuery :: DescribeTapes -> QueryString

AWSPager DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

page :: DescribeTapes -> AWSResponse DescribeTapes -> Maybe DescribeTapes

AWSRequest DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Associated Types

type AWSResponse DescribeTapes

Methods

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

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

Generic DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Associated Types

type Rep DescribeTapes :: Type -> Type

Methods

from :: DescribeTapes -> Rep DescribeTapes x

to :: Rep DescribeTapes x -> DescribeTapes

Read DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

readsPrec :: Int -> ReadS DescribeTapes

readList :: ReadS [DescribeTapes]

readPrec :: ReadPrec DescribeTapes

readListPrec :: ReadPrec [DescribeTapes]

Show DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

showsPrec :: Int -> DescribeTapes -> ShowS

show :: DescribeTapes -> String

showList :: [DescribeTapes] -> ShowS

NFData DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

rnf :: DescribeTapes -> ()

Eq DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

(==) :: DescribeTapes -> DescribeTapes -> Bool

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

Hashable DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

hashWithSalt :: Int -> DescribeTapes -> Int

hash :: DescribeTapes -> Int

type AWSResponse DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

type AWSResponse DescribeTapes = DescribeTapesResponse

type Rep DescribeTapes

Defined in Amazonka.StorageGateway.DescribeTapes

type Rep DescribeTapes = D1 ('MetaData "DescribeTapes" "Amazonka.StorageGateway.DescribeTapes" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeTapes'" '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])) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeTapes

Arguments

:: Text

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

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

DescribeTapes, describeTapes_gatewayARN - Undocumented member.

Request Lenses

describeTapes_limit :: Lens' DescribeTapes (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.

describeTapes_marker :: Lens' DescribeTapes (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.

describeTapes_tapeARNs :: Lens' DescribeTapes (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.

describeTapes_gatewayARN :: Lens' DescribeTapes Text

Undocumented member.

Destructuring the Response

data DescribeTapesResponse

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

Generic DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

Associated Types

type Rep DescribeTapesResponse :: Type -> Type

Methods

from :: DescribeTapesResponse -> Rep DescribeTapesResponse x

to :: Rep DescribeTapesResponse x -> DescribeTapesResponse

Read DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

readsPrec :: Int -> ReadS DescribeTapesResponse

readList :: ReadS [DescribeTapesResponse]

readPrec :: ReadPrec DescribeTapesResponse

readListPrec :: ReadPrec [DescribeTapesResponse]

Show DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

showsPrec :: Int -> DescribeTapesResponse -> ShowS

show :: DescribeTapesResponse -> String

showList :: [DescribeTapesResponse] -> ShowS

NFData DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

rnf :: DescribeTapesResponse -> ()

Eq DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

Methods

(==) :: DescribeTapesResponse -> DescribeTapesResponse -> Bool

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

type Rep DescribeTapesResponse

Defined in Amazonka.StorageGateway.DescribeTapes

type Rep DescribeTapesResponse = D1 ('MetaData "DescribeTapesResponse" "Amazonka.StorageGateway.DescribeTapes" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" '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

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:

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)

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])

An array of virtual tape descriptions.

describeTapesResponse_httpStatus :: Lens' DescribeTapesResponse Int

The response's http status code.