:doc:`Synthetics <../../synthetics>` / Client / start_canary

************
start_canary
************



.. py:method:: Synthetics.Client.start_canary(**kwargs)

  

  Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's ``Schedule``. To see a canary's schedule, use `GetCanary <https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanary>`_  


  **Request Syntax**
  ::

    response = client.start_canary(
        Name='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the canary that you want to run. To find canary names, use `DescribeCanaries <https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html>`__.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Synthetics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Synthetics.Client.exceptions.ValidationException`

  
  *   :py:class:`Synthetics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Synthetics.Client.exceptions.ConflictException`

  