Interface OpsWorksWaiter
-
- All Superinterfaces:
AutoCloseable,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface OpsWorksWaiter 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 staticbuilder()method
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceOpsWorksWaiter.Builder
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
-
-
-
Method Detail
-
waitUntilAppExists
default WaiterResponse<DescribeAppsResponse> waitUntilAppExists(DescribeAppsRequest describeAppsRequest)
PollsOpsWorksClient.describeApps(software.amazon.awssdk.services.opsworks.model.DescribeAppsRequest)API until the desired conditionAppExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAppsRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilAppExists
default WaiterResponse<DescribeAppsResponse> waitUntilAppExists(Consumer<DescribeAppsRequest.Builder> describeAppsRequest)
PollsOpsWorksClient.describeApps(software.amazon.awssdk.services.opsworks.model.DescribeAppsRequest)API until the desired conditionAppExistsis 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
DescribeAppsRequest.builder()- Parameters:
describeAppsRequest- 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
-
waitUntilAppExists
default WaiterResponse<DescribeAppsResponse> waitUntilAppExists(DescribeAppsRequest describeAppsRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeApps(software.amazon.awssdk.services.opsworks.model.DescribeAppsRequest)API until the desired conditionAppExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAppsRequest- 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
-
waitUntilAppExists
default WaiterResponse<DescribeAppsResponse> waitUntilAppExists(Consumer<DescribeAppsRequest.Builder> describeAppsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeApps(software.amazon.awssdk.services.opsworks.model.DescribeAppsRequest)API until the desired conditionAppExistsis 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:
describeAppsRequest- 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
-
waitUntilDeploymentSuccessful
default WaiterResponse<DescribeDeploymentsResponse> waitUntilDeploymentSuccessful(DescribeDeploymentsRequest describeDeploymentsRequest)
PollsOpsWorksClient.describeDeployments(software.amazon.awssdk.services.opsworks.model.DescribeDeploymentsRequest)API until the desired conditionDeploymentSuccessfulis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeDeploymentsRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilDeploymentSuccessful
default WaiterResponse<DescribeDeploymentsResponse> waitUntilDeploymentSuccessful(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest)
PollsOpsWorksClient.describeDeployments(software.amazon.awssdk.services.opsworks.model.DescribeDeploymentsRequest)API until the desired conditionDeploymentSuccessfulis 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
DescribeDeploymentsRequest.builder()- Parameters:
describeDeploymentsRequest- 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
-
waitUntilDeploymentSuccessful
default WaiterResponse<DescribeDeploymentsResponse> waitUntilDeploymentSuccessful(DescribeDeploymentsRequest describeDeploymentsRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeDeployments(software.amazon.awssdk.services.opsworks.model.DescribeDeploymentsRequest)API until the desired conditionDeploymentSuccessfulis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeDeploymentsRequest- 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
-
waitUntilDeploymentSuccessful
default WaiterResponse<DescribeDeploymentsResponse> waitUntilDeploymentSuccessful(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeDeployments(software.amazon.awssdk.services.opsworks.model.DescribeDeploymentsRequest)API until the desired conditionDeploymentSuccessfulis 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:
describeDeploymentsRequest- 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
-
waitUntilInstanceOnline
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceOnline(DescribeInstancesRequest describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceOnlineis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilInstanceOnline
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceOnline(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceOnlineis 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
DescribeInstancesRequest.builder()- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceOnline
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceOnline(DescribeInstancesRequest describeInstancesRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceOnlineis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceOnline
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceOnline(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceOnlineis 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:
describeInstancesRequest- 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
-
waitUntilInstanceRegistered
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceRegistered(DescribeInstancesRequest describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceRegisteredis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilInstanceRegistered
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceRegistered(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceRegisteredis 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
DescribeInstancesRequest.builder()- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceRegistered
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceRegistered(DescribeInstancesRequest describeInstancesRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceRegisteredis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceRegistered
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceRegistered(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceRegisteredis 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:
describeInstancesRequest- 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
-
waitUntilInstanceStopped
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceStopped(DescribeInstancesRequest describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceStoppedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilInstanceStopped
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceStopped(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceStoppedis 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
DescribeInstancesRequest.builder()- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceStopped
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceStopped(DescribeInstancesRequest describeInstancesRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceStoppedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceStopped
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceStopped(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceStoppedis 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:
describeInstancesRequest- 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
-
waitUntilInstanceTerminated
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceTerminated(DescribeInstancesRequest describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceTerminatedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilInstanceTerminated
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceTerminated(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceTerminatedis 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
DescribeInstancesRequest.builder()- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceTerminated
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceTerminated(DescribeInstancesRequest describeInstancesRequest, WaiterOverrideConfiguration overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceTerminatedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeInstancesRequest- 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
-
waitUntilInstanceTerminated
default WaiterResponse<DescribeInstancesResponse> waitUntilInstanceTerminated(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsOpsWorksClient.describeInstances(software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest)API until the desired conditionInstanceTerminatedis 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:
describeInstancesRequest- 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
static OpsWorksWaiter.Builder builder()
Create a builder that can be used to configure and create aOpsWorksWaiter.- Returns:
- a builder
-
create
static OpsWorksWaiter create()
Create an instance ofOpsWorksWaiterwith the default configuration.A default
OpsWorksClientwill 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
OpsWorksWaiter
-
-