Interface DynamoDbWaiter
-
- All Superinterfaces:
AutoCloseable,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe @Immutable public interface DynamoDbWaiter 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 interfaceDynamoDbWaiter.Builder
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
-
-
-
Method Detail
-
waitUntilContributorInsightsEnabled
default WaiterResponse<DescribeContributorInsightsResponse> waitUntilContributorInsightsEnabled(DescribeContributorInsightsRequest describeContributorInsightsRequest)
PollsDynamoDbClient.describeContributorInsights(software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsRequest)API until the desired conditionContributorInsightsEnabledis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeContributorInsightsRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilContributorInsightsEnabled
default WaiterResponse<DescribeContributorInsightsResponse> waitUntilContributorInsightsEnabled(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest)
PollsDynamoDbClient.describeContributorInsights(software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsRequest)API until the desired conditionContributorInsightsEnabledis 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
DescribeContributorInsightsRequest.builder()- Parameters:
describeContributorInsightsRequest- 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
-
waitUntilContributorInsightsEnabled
default WaiterResponse<DescribeContributorInsightsResponse> waitUntilContributorInsightsEnabled(DescribeContributorInsightsRequest describeContributorInsightsRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeContributorInsights(software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsRequest)API until the desired conditionContributorInsightsEnabledis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeContributorInsightsRequest- 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
-
waitUntilContributorInsightsEnabled
default WaiterResponse<DescribeContributorInsightsResponse> waitUntilContributorInsightsEnabled(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeContributorInsights(software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsRequest)API until the desired conditionContributorInsightsEnabledis 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:
describeContributorInsightsRequest- 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
-
waitUntilExportCompleted
default WaiterResponse<DescribeExportResponse> waitUntilExportCompleted(DescribeExportRequest describeExportRequest)
PollsDynamoDbClient.describeExport(software.amazon.awssdk.services.dynamodb.model.DescribeExportRequest)API until the desired conditionExportCompletedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeExportRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilExportCompleted
default WaiterResponse<DescribeExportResponse> waitUntilExportCompleted(Consumer<DescribeExportRequest.Builder> describeExportRequest)
PollsDynamoDbClient.describeExport(software.amazon.awssdk.services.dynamodb.model.DescribeExportRequest)API until the desired conditionExportCompletedis 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
DescribeExportRequest.builder()- Parameters:
describeExportRequest- 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
-
waitUntilExportCompleted
default WaiterResponse<DescribeExportResponse> waitUntilExportCompleted(DescribeExportRequest describeExportRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeExport(software.amazon.awssdk.services.dynamodb.model.DescribeExportRequest)API until the desired conditionExportCompletedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeExportRequest- 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
-
waitUntilExportCompleted
default WaiterResponse<DescribeExportResponse> waitUntilExportCompleted(Consumer<DescribeExportRequest.Builder> describeExportRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeExport(software.amazon.awssdk.services.dynamodb.model.DescribeExportRequest)API until the desired conditionExportCompletedis 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:
describeExportRequest- 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
-
waitUntilImportCompleted
default WaiterResponse<DescribeImportResponse> waitUntilImportCompleted(DescribeImportRequest describeImportRequest)
PollsDynamoDbClient.describeImport(software.amazon.awssdk.services.dynamodb.model.DescribeImportRequest)API until the desired conditionImportCompletedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeImportRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilImportCompleted
default WaiterResponse<DescribeImportResponse> waitUntilImportCompleted(Consumer<DescribeImportRequest.Builder> describeImportRequest)
PollsDynamoDbClient.describeImport(software.amazon.awssdk.services.dynamodb.model.DescribeImportRequest)API until the desired conditionImportCompletedis 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
DescribeImportRequest.builder()- Parameters:
describeImportRequest- 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
-
waitUntilImportCompleted
default WaiterResponse<DescribeImportResponse> waitUntilImportCompleted(DescribeImportRequest describeImportRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeImport(software.amazon.awssdk.services.dynamodb.model.DescribeImportRequest)API until the desired conditionImportCompletedis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeImportRequest- 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
-
waitUntilImportCompleted
default WaiterResponse<DescribeImportResponse> waitUntilImportCompleted(Consumer<DescribeImportRequest.Builder> describeImportRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeImport(software.amazon.awssdk.services.dynamodb.model.DescribeImportRequest)API until the desired conditionImportCompletedis 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:
describeImportRequest- 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
-
waitUntilKinesisStreamingDestinationActive
default WaiterResponse<DescribeKinesisStreamingDestinationResponse> waitUntilKinesisStreamingDestinationActive(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest)
PollsDynamoDbClient.describeKinesisStreamingDestination(software.amazon.awssdk.services.dynamodb.model.DescribeKinesisStreamingDestinationRequest)API until the desired conditionKinesisStreamingDestinationActiveis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeKinesisStreamingDestinationRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilKinesisStreamingDestinationActive
default WaiterResponse<DescribeKinesisStreamingDestinationResponse> waitUntilKinesisStreamingDestinationActive(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest)
PollsDynamoDbClient.describeKinesisStreamingDestination(software.amazon.awssdk.services.dynamodb.model.DescribeKinesisStreamingDestinationRequest)API until the desired conditionKinesisStreamingDestinationActiveis 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
DescribeKinesisStreamingDestinationRequest.builder()- Parameters:
describeKinesisStreamingDestinationRequest- 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
-
waitUntilKinesisStreamingDestinationActive
default WaiterResponse<DescribeKinesisStreamingDestinationResponse> waitUntilKinesisStreamingDestinationActive(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeKinesisStreamingDestination(software.amazon.awssdk.services.dynamodb.model.DescribeKinesisStreamingDestinationRequest)API until the desired conditionKinesisStreamingDestinationActiveis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeKinesisStreamingDestinationRequest- 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
-
waitUntilKinesisStreamingDestinationActive
default WaiterResponse<DescribeKinesisStreamingDestinationResponse> waitUntilKinesisStreamingDestinationActive(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeKinesisStreamingDestination(software.amazon.awssdk.services.dynamodb.model.DescribeKinesisStreamingDestinationRequest)API until the desired conditionKinesisStreamingDestinationActiveis 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:
describeKinesisStreamingDestinationRequest- 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
-
waitUntilTableExists
default WaiterResponse<DescribeTableResponse> waitUntilTableExists(DescribeTableRequest describeTableRequest)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeTableRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilTableExists
default WaiterResponse<DescribeTableResponse> waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableExistsis 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
DescribeTableRequest.builder()- Parameters:
describeTableRequest- 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
-
waitUntilTableExists
default WaiterResponse<DescribeTableResponse> waitUntilTableExists(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeTableRequest- 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
-
waitUntilTableExists
default WaiterResponse<DescribeTableResponse> waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableExistsis 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:
describeTableRequest- 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
-
waitUntilTableNotExists
default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(DescribeTableRequest describeTableRequest)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableNotExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeTableRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilTableNotExists
default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableNotExistsis 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
DescribeTableRequest.builder()- Parameters:
describeTableRequest- 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
-
waitUntilTableNotExists
default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableNotExistsis met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeTableRequest- 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
-
waitUntilTableNotExists
default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)API until the desired conditionTableNotExistsis 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:
describeTableRequest- 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 DynamoDbWaiter.Builder builder()
Create a builder that can be used to configure and create aDynamoDbWaiter.- Returns:
- a builder
-
create
static DynamoDbWaiter create()
Create an instance ofDynamoDbWaiterwith the default configuration.A default
DynamoDbClientwill 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
DynamoDbWaiter
-
-