:doc:`SSM <../../ssm>` / Client / send_automation_signal

**********************
send_automation_signal
**********************



.. py:method:: SSM.Client.send_automation_signal(**kwargs)

  

  Sends a signal to an Automation execution to change the current behavior or status of the execution.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendAutomationSignal>`_  


  **Request Syntax**
  ::

    response = client.send_automation_signal(
        AutomationExecutionId='string',
        SignalType='Approve'|'Reject'|'StartStep'|'StopStep'|'Resume'|'Revoke',
        Payload={
            'string': [
                'string',
            ]
        }
    )
    
  :type AutomationExecutionId: string
  :param AutomationExecutionId: **[REQUIRED]** 

    The unique identifier for an existing Automation execution that you want to send the signal to.

    

  
  :type SignalType: string
  :param SignalType: **[REQUIRED]** 

    The type of signal to send to an Automation execution.

    

  
  :type Payload: dict
  :param Payload: 

    The data sent with the signal. The data schema depends on the type of signal used in the request.

     

    For ``Approve`` and ``Reject`` signal types, the payload is an optional comment that you can send with the signal type. For example:

     

    ``Comment="Looks good"``

     

    For ``StartStep`` and ``Resume`` signal types, you must send the name of the Automation step to start or resume as the payload. For example:

     

    ``StepName="step1"``

     

    For the ``StopStep`` signal type, you must send the step execution ID as the payload. For example:

     

    ``StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"``

    

  
    - *(string) --* 

    
      - *(list) --* 

      
        - *(string) --* 

        
    


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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`SSM.Client.exceptions.AutomationExecutionNotFoundException`

  
  *   :py:class:`SSM.Client.exceptions.AutomationStepNotFoundException`

  
  *   :py:class:`SSM.Client.exceptions.InvalidAutomationSignalException`

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

  