Network.AWS.StorageGateway.DescribeChapCredentials

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

See: AWS API Reference for DescribeChapCredentials.

Creating a Request

describeChapCredentials

Arguments

:: Text

dccTargetARN

-> DescribeChapCredentials

Creates a value of DescribeChapCredentials with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dccTargetARN

data DescribeChapCredentials

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

See: describeChapCredentials smart constructor.

Instances

Eq DescribeChapCredentials

Data DescribeChapCredentials

Read DescribeChapCredentials

Show DescribeChapCredentials

Generic DescribeChapCredentials

ToJSON DescribeChapCredentials

AWSRequest DescribeChapCredentials

ToPath DescribeChapCredentials

ToHeaders DescribeChapCredentials

ToQuery DescribeChapCredentials

Typeable * DescribeChapCredentials

type Rep DescribeChapCredentials

type Rs DescribeChapCredentials = DescribeChapCredentialsResponse

Request Lenses

dccTargetARN :: Lens' DescribeChapCredentials Text

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

describeChapCredentialsResponse

Arguments

:: Int

dccrsResponseStatus

-> DescribeChapCredentialsResponse

Creates a value of DescribeChapCredentialsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dccrsChapCredentials
• dccrsResponseStatus

data DescribeChapCredentialsResponse

A JSON object containing a .

See: describeChapCredentialsResponse smart constructor.

Instances

Eq DescribeChapCredentialsResponse

Data DescribeChapCredentialsResponse

Read DescribeChapCredentialsResponse

Show DescribeChapCredentialsResponse

Generic DescribeChapCredentialsResponse

Typeable * DescribeChapCredentialsResponse

type Rep DescribeChapCredentialsResponse

Response Lenses

dccrsChapCredentials :: Lens' DescribeChapCredentialsResponse [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.

dccrsResponseStatus :: Lens' DescribeChapCredentialsResponse Int

The response status code.