Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describeChapCredentials :: Text -> DescribeChapCredentials
- data DescribeChapCredentials
- dccTargetARN :: Lens' DescribeChapCredentials Text
- describeChapCredentialsResponse :: Int -> DescribeChapCredentialsResponse
- data DescribeChapCredentialsResponse
- dccrsChapCredentials :: Lens' DescribeChapCredentialsResponse [ChapInfo]
- dccrsResponseStatus :: Lens' DescribeChapCredentialsResponse Int
Creating a Request
describeChapCredentials Source
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:
data DescribeChapCredentials Source
A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
See: describeChapCredentials
smart constructor.
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.
Destructuring the Response
describeChapCredentialsResponse Source
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:
data DescribeChapCredentialsResponse Source
A JSON object containing a .
See: describeChapCredentialsResponse
smart constructor.
Response Lenses
dccrsChapCredentials :: 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 (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 Source
The response status code.