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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

This operation returns paginated results.

Synopsis

data DescribeVTLDevices = DescribeVTLDevices' {
- marker :: Maybe Text
- limit :: Maybe Natural
- vTLDeviceARNs :: Maybe [Text]
- gatewayARN :: Text
}
newDescribeVTLDevices :: Text -> DescribeVTLDevices
describeVTLDevices_marker :: Lens' DescribeVTLDevices (Maybe Text)
describeVTLDevices_limit :: Lens' DescribeVTLDevices (Maybe Natural)
describeVTLDevices_vTLDeviceARNs :: Lens' DescribeVTLDevices (Maybe [Text])
describeVTLDevices_gatewayARN :: Lens' DescribeVTLDevices Text
data DescribeVTLDevicesResponse = DescribeVTLDevicesResponse' {
- vTLDevices :: Maybe [VTLDevice]
- gatewayARN :: Maybe Text
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeVTLDevicesResponse :: Int -> DescribeVTLDevicesResponse
describeVTLDevicesResponse_vTLDevices :: Lens' DescribeVTLDevicesResponse (Maybe [VTLDevice])
describeVTLDevicesResponse_gatewayARN :: Lens' DescribeVTLDevicesResponse (Maybe Text)
describeVTLDevicesResponse_marker :: Lens' DescribeVTLDevicesResponse (Maybe Text)
describeVTLDevicesResponse_httpStatus :: Lens' DescribeVTLDevicesResponse Int

Creating a Request

data DescribeVTLDevices Source #

DescribeVTLDevicesInput

See: newDescribeVTLDevices smart constructor.

Constructors

DescribeVTLDevices'

Fields

marker :: Maybe Text
An opaque string that indicates the position at which to begin describing the VTL devices.
limit :: Maybe Natural
Specifies that the number of VTL devices described be limited to the specified number.
vTLDeviceARNs :: Maybe [Text]
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
gatewayARN :: Text

Instances

Instances details

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

newDescribeVTLDevices Source #

Arguments

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

Create a value of DescribeVTLDevices 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:DescribeVTLDevices', describeVTLDevices_marker - An opaque string that indicates the position at which to begin describing the VTL devices.

$sel:limit:DescribeVTLDevices', describeVTLDevices_limit - Specifies that the number of VTL devices described be limited to the specified number.

$sel:vTLDeviceARNs:DescribeVTLDevices', describeVTLDevices_vTLDeviceARNs - An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

$sel:gatewayARN:DescribeVTLDevices', describeVTLDevices_gatewayARN - Undocumented member.

Request Lenses

describeVTLDevices_marker :: Lens' DescribeVTLDevices (Maybe Text) Source #

An opaque string that indicates the position at which to begin describing the VTL devices.

describeVTLDevices_limit :: Lens' DescribeVTLDevices (Maybe Natural) Source #

Specifies that the number of VTL devices described be limited to the specified number.

describeVTLDevices_vTLDeviceARNs :: Lens' DescribeVTLDevices (Maybe [Text]) Source #

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

describeVTLDevices_gatewayARN :: Lens' DescribeVTLDevices Text Source #

Undocumented member.

Destructuring the Response

data DescribeVTLDevicesResponse Source #

DescribeVTLDevicesOutput

See: newDescribeVTLDevicesResponse smart constructor.

Constructors

DescribeVTLDevicesResponse'

Fields

vTLDevices :: Maybe [VTLDevice]
An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
gatewayARN :: Maybe Text
marker :: Maybe Text
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeVTLDevicesResponse Source #

Arguments

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

Create a value of DescribeVTLDevicesResponse 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:vTLDevices:DescribeVTLDevicesResponse', describeVTLDevicesResponse_vTLDevices - An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.

$sel:gatewayARN:DescribeVTLDevices', describeVTLDevicesResponse_gatewayARN - Undocumented member.

$sel:marker:DescribeVTLDevices', describeVTLDevicesResponse_marker - An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

$sel:httpStatus:DescribeVTLDevicesResponse', describeVTLDevicesResponse_httpStatus - The response's http status code.

Response Lenses

describeVTLDevicesResponse_vTLDevices :: Lens' DescribeVTLDevicesResponse (Maybe [VTLDevice]) Source #

An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.

describeVTLDevicesResponse_gatewayARN :: Lens' DescribeVTLDevicesResponse (Maybe Text) Source #

Undocumented member.

describeVTLDevicesResponse_marker :: Lens' DescribeVTLDevicesResponse (Maybe Text) Source #

An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

describeVTLDevicesResponse_httpStatus :: Lens' DescribeVTLDevicesResponse Int Source #

The response's http status code.