:doc:`StorageGateway <../../storagegateway>` / Client / start_availability_monitor_test

*******************************
start_availability_monitor_test
*******************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartAvailabilityMonitorTest>`_  


  **Request Syntax**
  ::

    response = client.start_availability_monitor_test(
        GatewayARN='string'
    )
    
  :type GatewayARN: string
  :param GatewayARN: **[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.

    

  
  
  :rtype: 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**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  