Interface SsmWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface SsmWaiter
extends SdkAutoCloseable
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state. This can be created using the static
builder()
method-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SsmWaiter.Builder
builder()
Create a builder that can be used to configure and create aSsmWaiter
.static SsmWaiter
create()
Create an instance ofSsmWaiter
with the default configuration.waitUntilCommandExecuted
(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCommandExecuted
(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCommandExecuted
(GetCommandInvocationRequest getCommandInvocationRequest) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired statewaitUntilCommandExecuted
(GetCommandInvocationRequest getCommandInvocationRequest, WaiterOverrideConfiguration overrideConfig) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired stateMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Method Details
-
waitUntilCommandExecuted
default WaiterResponse<GetCommandInvocationResponse> waitUntilCommandExecuted(GetCommandInvocationRequest getCommandInvocationRequest) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
getCommandInvocationRequest
- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCommandExecuted
default WaiterResponse<GetCommandInvocationResponse> waitUntilCommandExecuted(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
GetCommandInvocationRequest.builder()
- Parameters:
getCommandInvocationRequest
- The consumer that will configure the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCommandExecuted
default WaiterResponse<GetCommandInvocationResponse> waitUntilCommandExecuted(GetCommandInvocationRequest getCommandInvocationRequest, WaiterOverrideConfiguration overrideConfig) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
getCommandInvocationRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCommandExecuted
default WaiterResponse<GetCommandInvocationResponse> waitUntilCommandExecuted(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsSsmClient.getCommandInvocation(software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest)
API until the desired conditionCommandExecuted
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
getCommandInvocationRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
builder
Create a builder that can be used to configure and create aSsmWaiter
.- Returns:
- a builder
-
create
Create an instance ofSsmWaiter
with the default configuration.A default
SsmClient
will be created to poll resources. It is recommended to share a single instance of the waiter created via this method. If it is not desirable to share a waiter instance, invokeSdkAutoCloseable.close()
to release the resources once the waiter is not needed.- Returns:
- an instance of
SsmWaiter
-