amazonka-storagegateway-0.0.7: Amazon Storage Gateway SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.DescribeChapCredentials

Contents

Description

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

http://docs.aws.amazon.com/storagegateway/latest/APIReference/API_DescribeChapCredentials.html

Synopsis

Request

Request constructor

describeChapCredentials Source

DescribeChapCredentials constructor.

The fields accessible through corresponding lenses are:

Request lenses

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

Response

Response constructor

Response lenses

dccrChapCredentials :: Lens' DescribeChapCredentialsResponse [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 (e.g. 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.