Skip to content

describe_availability_monitor_test

describe_availability_monitor_test(
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> DescribeAvailabilityMonitorTestOutput

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.

Raises:

  • InternalServerError –

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

  • InvalidGatewayRequestException –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py
def describe_availability_monitor_test(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_availability_monitor_test_output.DescribeAvailabilityMonitorTestOutput":
    """<p>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.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.describe_availability_monitor_test_input.DescribeAvailabilityMonitorTestInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_availability_monitor_test_output.DescribeAvailabilityMonitorTestOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_availability_monitor_test

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.describe_availability_monitor_test.describe_availability_monitor_test(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAvailabilityMonitorTest")
    )
    input_: capo_storage_gateway.types.describe_availability_monitor_test_input.DescribeAvailabilityMonitorTestInput = {
        "gateway_arn": gateway_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output