:doc:`imagebuilder <../../imagebuilder>` / Client / send_workflow_step_action

*************************
send_workflow_step_action
*************************



.. py:method:: imagebuilder.Client.send_workflow_step_action(**kwargs)

  

  Pauses or resumes image creation when the associated workflow runs a ``WaitForAction`` step.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SendWorkflowStepAction>`_  


  **Request Syntax**
  ::

    response = client.send_workflow_step_action(
        stepExecutionId='string',
        imageBuildVersionArn='string',
        action='RESUME'|'STOP',
        reason='string',
        clientToken='string'
    )
    
  :type stepExecutionId: string
  :param stepExecutionId: **[REQUIRED]** 

    Uniquely identifies the workflow step that sent the step action.

    

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

    The Amazon Resource Name (ARN) of the image build version to send action for.

    

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

    The action for the image creation process to take while a workflow ``WaitForAction`` step waits for an asynchronous action to complete.

    

  
  :type reason: string
  :param reason: 

    The reason why this action is sent.

    

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

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html>`__ in the *Amazon EC2 API Reference*.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'stepExecutionId': 'string',
          'imageBuildVersionArn': 'string',
          'clientToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **stepExecutionId** *(string) --* 

        The workflow step that sent the step action.

        
      

      - **imageBuildVersionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the image build version that received the action request.

        
      

      - **clientToken** *(string) --* 

        The client token that uniquely identifies the request.

        
  
  **Exceptions**
  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ClientException`

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

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`imagebuilder.Client.exceptions.IdempotentParameterMismatchException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ForbiddenException`

  
  *   :py:class:`imagebuilder.Client.exceptions.CallRateLimitExceededException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ResourceInUseException`

  