start_availability_monitor_test

StorageGateway.Client.start_availability_monitor_test(**kwargs)

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Note

Starting this test will cause your gateway to go offline for a brief period.

See also: AWS API Documentation

Request Syntax

response = client.start_availability_monitor_test(
    GatewayARN='string'
)

Parameters

GatewayARN (string) --

[REQUIRED]

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.

Return type

dict

Returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

• (dict) --
  • GatewayARN (string) --

    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.

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException
• StorageGateway.Client.exceptions.InternalServerError