Interface SendWorkflowStepActionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SendWorkflowStepActionRequest.Builder,,SendWorkflowStepActionRequest> ImagebuilderRequest.Builder,SdkBuilder<SendWorkflowStepActionRequest.Builder,,SendWorkflowStepActionRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SendWorkflowStepActionRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe action to perform on the paused workflow step.action(WorkflowStepActionType action) The action to perform on the paused workflow step.clientToken(String clientToken) A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time.imageBuildVersionArn(String imageBuildVersionArn) The Amazon Resource Name (ARN) of the image build version associated with the workflow step execution.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The reason for the action.stepExecutionId(String stepExecutionId) Uniquely identifies the waiting workflow step that you send the action to.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
stepExecutionId
Uniquely identifies the waiting workflow step that you send the action to. To get this identifier, call ListWaitingWorkflowSteps.
- Parameters:
stepExecutionId- Uniquely identifies the waiting workflow step that you send the action to. To get this identifier, call ListWaitingWorkflowSteps.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageBuildVersionArn
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.
- Parameters:
imageBuildVersionArn- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
The action to perform on the paused workflow step.
RESUMEcompletes the waiting step, and the workflow continues.STOPfails the step, and the step'sonFailuresetting 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.- Parameters:
action- The action to perform on the paused workflow step.RESUMEcompletes the waiting step, and the workflow continues.STOPfails the step, and the step'sonFailuresetting 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
action
The action to perform on the paused workflow step.
RESUMEcompletes the waiting step, and the workflow continues.STOPfails the step, and the step'sonFailuresetting 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.- Parameters:
action- The action to perform on the paused workflow step.RESUMEcompletes the waiting step, and the workflow continues.STOPfails the step, and the step'sonFailuresetting 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
reason
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.
- Parameters:
reason- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
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.
- Parameters:
clientToken- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SendWorkflowStepActionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SendWorkflowStepActionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-