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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Creating a Request

data DescribeStorediSCSIVolumes Source #

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

See: newDescribeStorediSCSIVolumes smart constructor.

Constructors

DescribeStorediSCSIVolumes'
Fields volumeARNs :: [Text] An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

Instances

Instances details

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

newDescribeStorediSCSIVolumes :: DescribeStorediSCSIVolumes Source #

Create a value of DescribeStorediSCSIVolumes 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:volumeARNs:DescribeStorediSCSIVolumes', describeStorediSCSIVolumes_volumeARNs - An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

Request Lenses

describeStorediSCSIVolumes_volumeARNs :: Lens' DescribeStorediSCSIVolumes [Text] Source #

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

Destructuring the Response

data DescribeStorediSCSIVolumesResponse Source #

See: newDescribeStorediSCSIVolumesResponse smart constructor.

Constructors

DescribeStorediSCSIVolumesResponse'

Fields

storediSCSIVolumes :: Maybe [StorediSCSIVolume]
Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
- ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
- LunNumber: The logical disk number.
- NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.
- NetworkInterfacePort: The port used to communicate with iSCSI targets.
- PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.
- SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
- StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.
- TargetARN: The Amazon Resource Name (ARN) of the volume target.
- VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
- VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
- VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
- VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
- VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
- VolumeSizeInBytes: The size of the volume in bytes.
- VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
- VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeStorediSCSIVolumesResponse Source #

Arguments

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

Create a value of DescribeStorediSCSIVolumesResponse 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:storediSCSIVolumes:DescribeStorediSCSIVolumesResponse', describeStorediSCSIVolumesResponse_storediSCSIVolumes - Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
LunNumber: The logical disk number.
NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.
NetworkInterfacePort: The port used to communicate with iSCSI targets.
PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.
SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.
TargetARN: The Amazon Resource Name (ARN) of the volume target.
VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
VolumeSizeInBytes: The size of the volume in bytes.
VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

$sel:httpStatus:DescribeStorediSCSIVolumesResponse', describeStorediSCSIVolumesResponse_httpStatus - The response's http status code.

Response Lenses

describeStorediSCSIVolumesResponse_storediSCSIVolumes :: Lens' DescribeStorediSCSIVolumesResponse (Maybe [StorediSCSIVolume]) Source #

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
LunNumber: The logical disk number.
NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.
NetworkInterfacePort: The port used to communicate with iSCSI targets.
PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.
SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.
TargetARN: The Amazon Resource Name (ARN) of the volume target.
VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
VolumeSizeInBytes: The size of the volume in bytes.
VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

describeStorediSCSIVolumesResponse_httpStatus :: Lens' DescribeStorediSCSIVolumesResponse Int Source #

The response's http status code.