Amazonka.StorageGateway.DescribeChapCredentials

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

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

ToJSON DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

toJSON :: DescribeChapCredentials -> Value

toEncoding :: DescribeChapCredentials -> Encoding

toJSONList :: [DescribeChapCredentials] -> Value

toEncodingList :: [DescribeChapCredentials] -> Encoding

ToHeaders DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

toHeaders :: DescribeChapCredentials -> [Header]

ToPath DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

toPath :: DescribeChapCredentials -> ByteString

ToQuery DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

toQuery :: DescribeChapCredentials -> QueryString

AWSRequest DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Associated Types

type AWSResponse DescribeChapCredentials

Methods

request :: (Service -> Service) -> DescribeChapCredentials -> Request DescribeChapCredentials

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeChapCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeChapCredentials)))

Generic DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Associated Types

type Rep DescribeChapCredentials :: Type -> Type

Methods

from :: DescribeChapCredentials -> Rep DescribeChapCredentials x

to :: Rep DescribeChapCredentials x -> DescribeChapCredentials

Read DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

readsPrec :: Int -> ReadS DescribeChapCredentials

readList :: ReadS [DescribeChapCredentials]

readPrec :: ReadPrec DescribeChapCredentials

readListPrec :: ReadPrec [DescribeChapCredentials]

Show DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

showsPrec :: Int -> DescribeChapCredentials -> ShowS

show :: DescribeChapCredentials -> String

showList :: [DescribeChapCredentials] -> ShowS

NFData DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

rnf :: DescribeChapCredentials -> ()

Eq DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

(==) :: DescribeChapCredentials -> DescribeChapCredentials -> Bool

(/=) :: DescribeChapCredentials -> DescribeChapCredentials -> Bool

Hashable DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

hashWithSalt :: Int -> DescribeChapCredentials -> Int

hash :: DescribeChapCredentials -> Int

type AWSResponse DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

type AWSResponse DescribeChapCredentials = DescribeChapCredentialsResponse

type Rep DescribeChapCredentials

Defined in Amazonka.StorageGateway.DescribeChapCredentials

type Rep DescribeChapCredentials = D1 ('MetaData "DescribeChapCredentials" "Amazonka.StorageGateway.DescribeChapCredentials" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeChapCredentials'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeChapCredentials

Arguments

:: Text

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:

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

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

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

Generic DescribeChapCredentialsResponse

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Associated Types

type Rep DescribeChapCredentialsResponse :: Type -> Type

Methods

from :: DescribeChapCredentialsResponse -> Rep DescribeChapCredentialsResponse x

to :: Rep DescribeChapCredentialsResponse x -> DescribeChapCredentialsResponse

Show DescribeChapCredentialsResponse

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

showsPrec :: Int -> DescribeChapCredentialsResponse -> ShowS

show :: DescribeChapCredentialsResponse -> String

showList :: [DescribeChapCredentialsResponse] -> ShowS

NFData DescribeChapCredentialsResponse

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

rnf :: DescribeChapCredentialsResponse -> ()

Eq DescribeChapCredentialsResponse

Defined in Amazonka.StorageGateway.DescribeChapCredentials

Methods

(==) :: DescribeChapCredentialsResponse -> DescribeChapCredentialsResponse -> Bool

(/=) :: DescribeChapCredentialsResponse -> DescribeChapCredentialsResponse -> Bool

type Rep DescribeChapCredentialsResponse

Defined in Amazonka.StorageGateway.DescribeChapCredentials

type Rep DescribeChapCredentialsResponse = D1 ('MetaData "DescribeChapCredentialsResponse" "Amazonka.StorageGateway.DescribeChapCredentials" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" '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

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])

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

The response's http status code.