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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

Creating a Request

data DescribeChapCredentials Source #

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

See: newDescribeChapCredentials smart constructor.

Constructors

DescribeChapCredentials'
Fields targetARN :: Text The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Instances

Instances details

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

newDescribeChapCredentials Source #

Arguments

:: Text	`$sel:targetARN:DescribeChapCredentials'`
-> DescribeChapCredentials

Create a value of DescribeChapCredentials 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:targetARN:DescribeChapCredentials', describeChapCredentials_targetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Request Lenses

describeChapCredentials_targetARN :: Lens' DescribeChapCredentials Text Source #

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Destructuring the Response

data DescribeChapCredentialsResponse Source #

A JSON object containing the following fields:

See: newDescribeChapCredentialsResponse smart constructor.

Constructors

DescribeChapCredentialsResponse'

Fields

chapCredentials :: Maybe [ChapInfo]
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
- InitiatorName: The iSCSI initiator that connects to the target.
- SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
- SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
- TargetARN: The Amazon Resource Name (ARN) of the storage volume.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeChapCredentialsResponse Source #

Arguments

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

Create a value of DescribeChapCredentialsResponse 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:chapCredentials:DescribeChapCredentialsResponse', describeChapCredentialsResponse_chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.

$sel:httpStatus:DescribeChapCredentialsResponse', describeChapCredentialsResponse_httpStatus - The response's http status code.

Response Lenses

describeChapCredentialsResponse_chapCredentials :: Lens' DescribeChapCredentialsResponse (Maybe [ChapInfo]) Source #

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.

describeChapCredentialsResponse_httpStatus :: Lens' DescribeChapCredentialsResponse Int Source #

The response's http status code.