imagebuilder / Client / send_workflow_step_action

send_workflow_step_action

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

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 workflow step that sent the step action.

• imageBuildVersionArn (string) –

  [REQUIRED]

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

• action (string) –

  [REQUIRED]

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

• reason (string) – The reason why this action is sent.

• clientToken (string) –

  [REQUIRED]

  Unique, case-sensitive identifier you provide to ensure idempotency of the request. 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 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

• 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