- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeAvailabilityMonitorTestCommand
Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { StorageGatewayClient, DescribeAvailabilityMonitorTestCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, DescribeAvailabilityMonitorTestCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // DescribeAvailabilityMonitorTestInput
GatewayARN: "STRING_VALUE", // required
};
const command = new DescribeAvailabilityMonitorTestCommand(input);
const response = await client.send(command);
// { // DescribeAvailabilityMonitorTestOutput
// GatewayARN: "STRING_VALUE",
// Status: "COMPLETE" || "FAILED" || "PENDING",
// StartTime: new Date("TIMESTAMP"),
// };
DescribeAvailabilityMonitorTestCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
GatewayARNRequired | string | undefined | The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. |
DescribeAvailabilityMonitorTestCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
GatewayARN | string | undefined | The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. |
StartTime | Date | undefined | The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null. |
Status | AvailabilityMonitorTestStatus | undefined | The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerError | server | An internal server error has occurred during the request. For more information, see the error and message fields. |
| InvalidGatewayRequestException | client | An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. |
| StorageGatewayServiceException | Base exception class for all service exceptions from StorageGateway service. |