Network.AWS.StorageGateway.DescribeChapCredentials

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

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 - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

data DescribeChapCredentials

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

See: describeChapCredentials smart constructor.

Instances

Eq DescribeChapCredentials

Methods

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

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

Data DescribeChapCredentials

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeChapCredentials -> c DescribeChapCredentials

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeChapCredentials

toConstr :: DescribeChapCredentials -> Constr

dataTypeOf :: DescribeChapCredentials -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeChapCredentials)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeChapCredentials)

gmapT :: (forall b. Data b => b -> b) -> DescribeChapCredentials -> DescribeChapCredentials

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChapCredentials -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChapCredentials -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeChapCredentials -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeChapCredentials -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeChapCredentials -> m DescribeChapCredentials

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChapCredentials -> m DescribeChapCredentials

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChapCredentials -> m DescribeChapCredentials

Read DescribeChapCredentials

Methods

readsPrec :: Int -> ReadS DescribeChapCredentials

readList :: ReadS [DescribeChapCredentials]

readPrec :: ReadPrec DescribeChapCredentials

readListPrec :: ReadPrec [DescribeChapCredentials]

Show DescribeChapCredentials

Methods

showsPrec :: Int -> DescribeChapCredentials -> ShowS

show :: DescribeChapCredentials -> String

showList :: [DescribeChapCredentials] -> ShowS

Generic DescribeChapCredentials

Associated Types

type Rep DescribeChapCredentials :: * -> *

Methods

from :: DescribeChapCredentials -> Rep DescribeChapCredentials x

to :: Rep DescribeChapCredentials x -> DescribeChapCredentials

Hashable DescribeChapCredentials

Methods

hashWithSalt :: Int -> DescribeChapCredentials -> Int

hash :: DescribeChapCredentials -> Int

ToJSON DescribeChapCredentials

Methods

toJSON :: DescribeChapCredentials -> Value

toEncoding :: DescribeChapCredentials -> Encoding

toJSONList :: [DescribeChapCredentials] -> Value

toEncodingList :: [DescribeChapCredentials] -> Encoding

NFData DescribeChapCredentials

Methods

rnf :: DescribeChapCredentials -> ()

AWSRequest DescribeChapCredentials

Associated Types

type Rs DescribeChapCredentials :: *

Methods

request :: DescribeChapCredentials -> Request DescribeChapCredentials

response :: MonadResource m => Logger -> Service -> Proxy * DescribeChapCredentials -> ClientResponse -> m (Response DescribeChapCredentials)

ToPath DescribeChapCredentials

Methods

toPath :: DescribeChapCredentials -> ByteString

ToHeaders DescribeChapCredentials

Methods

toHeaders :: DescribeChapCredentials -> [Header]

ToQuery DescribeChapCredentials

Methods

toQuery :: DescribeChapCredentials -> QueryString

type Rep DescribeChapCredentials

type Rep DescribeChapCredentials = D1 (MetaData "DescribeChapCredentials" "Network.AWS.StorageGateway.DescribeChapCredentials" "amazonka-storagegateway-1.4.5-GOGCrgFap1r59NptpacdAf" True) (C1 (MetaCons "DescribeChapCredentials'" PrefixI True) (S1 (MetaSel (Just Symbol "_dccTargetARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs 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 - 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 - -- | The response status code.

data DescribeChapCredentialsResponse

A JSON object containing a .

See: describeChapCredentialsResponse smart constructor.

Instances

Eq DescribeChapCredentialsResponse

Methods

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

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

Data DescribeChapCredentialsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeChapCredentialsResponse -> c DescribeChapCredentialsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeChapCredentialsResponse

toConstr :: DescribeChapCredentialsResponse -> Constr

dataTypeOf :: DescribeChapCredentialsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeChapCredentialsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeChapCredentialsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeChapCredentialsResponse -> DescribeChapCredentialsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChapCredentialsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChapCredentialsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeChapCredentialsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeChapCredentialsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeChapCredentialsResponse -> m DescribeChapCredentialsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChapCredentialsResponse -> m DescribeChapCredentialsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChapCredentialsResponse -> m DescribeChapCredentialsResponse

Read DescribeChapCredentialsResponse

Methods

readsPrec :: Int -> ReadS DescribeChapCredentialsResponse

readList :: ReadS [DescribeChapCredentialsResponse]

readPrec :: ReadPrec DescribeChapCredentialsResponse

readListPrec :: ReadPrec [DescribeChapCredentialsResponse]

Show DescribeChapCredentialsResponse

Methods

showsPrec :: Int -> DescribeChapCredentialsResponse -> ShowS

show :: DescribeChapCredentialsResponse -> String

showList :: [DescribeChapCredentialsResponse] -> ShowS

Generic DescribeChapCredentialsResponse

Associated Types

type Rep DescribeChapCredentialsResponse :: * -> *

Methods

from :: DescribeChapCredentialsResponse -> Rep DescribeChapCredentialsResponse x

to :: Rep DescribeChapCredentialsResponse x -> DescribeChapCredentialsResponse

NFData DescribeChapCredentialsResponse

Methods

rnf :: DescribeChapCredentialsResponse -> ()

type Rep DescribeChapCredentialsResponse

type Rep DescribeChapCredentialsResponse = D1 (MetaData "DescribeChapCredentialsResponse" "Network.AWS.StorageGateway.DescribeChapCredentials" "amazonka-storagegateway-1.4.5-GOGCrgFap1r59NptpacdAf" False) (C1 (MetaCons "DescribeChapCredentialsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dccrsChapCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ChapInfo]))) (S1 (MetaSel (Just Symbol "_dccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

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.