import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeChapCredentialsInput, DescribeChapCredentialsOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeChapCredentialsCommand}. */ export interface DescribeChapCredentialsCommandInput extends DescribeChapCredentialsInput { } /** * @public * * The output of {@link DescribeChapCredentialsCommand}. */ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCredentialsOutput, __MetadataBearer { } declare const DescribeChapCredentialsCommand_base: { new (input: DescribeChapCredentialsCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeChapCredentialsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, DescribeChapCredentialsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, DescribeChapCredentialsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import * // import type { StorageGatewayClientConfig } from "@aws-sdk/client-storage-gateway"; * const config = {}; // type is StorageGatewayClientConfig * const client = new StorageGatewayClient(config); * const input = { // DescribeChapCredentialsInput * TargetARN: "STRING_VALUE", // required * }; * const command = new DescribeChapCredentialsCommand(input); * const response = await client.send(command); * // { // DescribeChapCredentialsOutput * // ChapCredentials: [ // ChapCredentials * // { // ChapInfo * // TargetARN: "STRING_VALUE", * // SecretToAuthenticateInitiator: "STRING_VALUE", * // InitiatorName: "STRING_VALUE", * // SecretToAuthenticateTarget: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DescribeChapCredentialsCommandInput - {@link DescribeChapCredentialsCommandInput} * @returns {@link DescribeChapCredentialsCommandOutput} * @see {@link DescribeChapCredentialsCommandInput} for command's `input` shape. * @see {@link DescribeChapCredentialsCommandOutput} for command's `response` shape. * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An internal server error has occurred during the request. For more information, see the * error and message fields.

* * @throws {@link InvalidGatewayRequestException} (client fault) *

An exception occurred because an invalid gateway request was issued to the service. For * more information, see the error and message fields.

* * @throws {@link StorageGatewayServiceException} *

Base exception class for all service exceptions from StorageGateway service.

* * * @example To describe CHAP credetnitals for an iSCSI * ```javascript * // Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. * const input = { * TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" * }; * const command = new DescribeChapCredentialsCommand(input); * const response = await client.send(command); * /* response is * { * ChapCredentials: [ * { * InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", * SecretToAuthenticateInitiator: "111111111111", * SecretToAuthenticateTarget: "222222222222", * TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeChapCredentialsCommand extends DescribeChapCredentialsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeChapCredentialsInput; output: DescribeChapCredentialsOutput; }; sdk: { input: DescribeChapCredentialsCommandInput; output: DescribeChapCredentialsCommandOutput; }; }; }