imagebuilder / Client / send_workflow_step_action

send_workflow_step_action

imagebuilder.Client.send_workflow_step_action(**kwargs)

Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an action, call ListWaitingWorkflowSteps.

See also: AWS API Documentation

Request Syntax

response = client.send_workflow_step_action(
    stepExecutionId='string',
    imageBuildVersionArn='string',
    action='RESUME'|'STOP',
    reason='string',
    clientToken='string'
)
Parameters:

  • stepExecutionId (string) –

    [REQUIRED]

    Uniquely identifies the waiting workflow step that you send the action to. To get this identifier, call ListWaitingWorkflowSteps.

  • imageBuildVersionArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the image build version associated with the workflow step execution. This value must match the image that owns the waiting step. If the ARN does not correspond to the image running the workflow, then the request fails with a validation error.

  • action (string) –

    [REQUIRED]

    The action to perform on the paused workflow step. RESUME completes the waiting step, and the workflow continues. STOP fails the step, and the step’s onFailure setting determines whether the workflow continues or aborts. The workflow step must be in a waiting state to accept an action. The request fails if the step has already timed out or been actioned.

  • reason (string) – The reason for the action. This value is stored with the step execution record and is accessible in subsequent workflow steps via step output references.

  • clientToken (string) –

    [REQUIRED]

    A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'stepExecutionId': 'string',
    'imageBuildVersionArn': 'string',
    'clientToken': 'string'
}

Response Structure

  • (dict) –

    • stepExecutionId (string) –

      The unique identifier for the workflow step that received the action, as specified in the request.

    • 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

  • imagebuilder.Client.exceptions.ServiceException

  • imagebuilder.Client.exceptions.ClientException

  • imagebuilder.Client.exceptions.ResourceNotFoundException

  • imagebuilder.Client.exceptions.InvalidRequestException

  • imagebuilder.Client.exceptions.InvalidParameterValueException

  • imagebuilder.Client.exceptions.ServiceUnavailableException

  • imagebuilder.Client.exceptions.IdempotentParameterMismatchException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException

  • imagebuilder.Client.exceptions.ResourceInUseException