describe_availability_monitor_test

StorageGateway.Client.describe_availability_monitor_test(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_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',
    'Status': 'COMPLETE'|'FAILED'|'PENDING',
    'StartTime': datetime(2015, 1, 1)
}

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.

  • Status (string) --

    The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.

  • StartTime (datetime) --

    The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.

Exceptions

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