start_availability_monitor_test `async` ¶

start_availability_monitor_test(
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> StartAvailabilityMonitorTestOutput

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.

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

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/async_storage_gateway.py

async def start_availability_monitor_test(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.start_availability_monitor_test_output.StartAvailabilityMonitorTestOutput":
    """<p>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 <code>DescribeAvailabilityMonitorTest</code> API.</p> <note> <p>Starting this test will cause your gateway to go offline for a brief period.</p> </note>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.start_availability_monitor_test_input.StartAvailabilityMonitorTestInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.start_availability_monitor_test_output.StartAvailabilityMonitorTestOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.start_availability_monitor_test

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.start_availability_monitor_test.async_start_availability_monitor_test(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAvailabilityMonitorTest")
    )
    input_: capo_storage_gateway.types.start_availability_monitor_test_input.StartAvailabilityMonitorTestInput = {
        "gateway_arn": gateway_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

start_availability_monitor_test async ¶

start_availability_monitor_test `async` ¶