Package software.amazon.awssdk.services.iam.waiters

Interface IamAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface IamAsyncWaiter
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

Nested Classes

Modifier and Type	Interface	Description
static interface	IamAsyncWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static IamAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a IamAsyncWaiter.
static IamAsyncWaiter	create()	Create an instance of IamAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>>	waitUntilInstanceProfileExists(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest)	Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>>	waitUntilInstanceProfileExists(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>>	waitUntilInstanceProfileExists(GetInstanceProfileRequest getInstanceProfileRequest)	Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>>	waitUntilInstanceProfileExists(GetInstanceProfileRequest getInstanceProfileRequest, WaiterOverrideConfiguration overrideConfig)	Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetPolicyResponse>>	waitUntilPolicyExists(Consumer<GetPolicyRequest.Builder> getPolicyRequest)	Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetPolicyResponse>>	waitUntilPolicyExists(Consumer<GetPolicyRequest.Builder> getPolicyRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetPolicyResponse>>	waitUntilPolicyExists(GetPolicyRequest getPolicyRequest)	Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetPolicyResponse>>	waitUntilPolicyExists(GetPolicyRequest getPolicyRequest, WaiterOverrideConfiguration overrideConfig)	Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetRoleResponse>>	waitUntilRoleExists(Consumer<GetRoleRequest.Builder> getRoleRequest)	Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetRoleResponse>>	waitUntilRoleExists(Consumer<GetRoleRequest.Builder> getRoleRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetRoleResponse>>	waitUntilRoleExists(GetRoleRequest getRoleRequest)	Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetRoleResponse>>	waitUntilRoleExists(GetRoleRequest getRoleRequest, WaiterOverrideConfiguration overrideConfig)	Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetUserResponse>>	waitUntilUserExists(Consumer<GetUserRequest.Builder> getUserRequest)	Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetUserResponse>>	waitUntilUserExists(Consumer<GetUserRequest.Builder> getUserRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<GetUserResponse>>	waitUntilUserExists(GetUserRequest getUserRequest)	Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<GetUserResponse>>	waitUntilUserExists(GetUserRequest getUserRequest, WaiterOverrideConfiguration overrideConfig)	Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Method Detail

waitUntilInstanceProfileExists

default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>> waitUntilInstanceProfileExists(GetInstanceProfileRequest getInstanceProfileRequest)

Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getInstanceProfileRequest - the request to be used for polling

Returns:

CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.

waitUntilInstanceProfileExists

default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>> waitUntilInstanceProfileExists(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest)

Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists 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 GetInstanceProfileRequest.builder()

Parameters:

getInstanceProfileRequest - The consumer that will configure the request to be used for polling

Returns:

CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilInstanceProfileExists

default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>> waitUntilInstanceProfileExists(GetInstanceProfileRequest getInstanceProfileRequest,
                                                                                                     WaiterOverrideConfiguration overrideConfig)

Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getInstanceProfileRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilInstanceProfileExists

default CompletableFuture<WaiterResponse<GetInstanceProfileResponse>> waitUntilInstanceProfileExists(Consumer<GetInstanceProfileRequest.Builder> getInstanceProfileRequest,
                                                                                                     Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls IamAsyncClient.getInstanceProfile(software.amazon.awssdk.services.iam.model.GetInstanceProfileRequest) API until the desired condition InstanceProfileExists 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:

getInstanceProfileRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilPolicyExists

default CompletableFuture<WaiterResponse<GetPolicyResponse>> waitUntilPolicyExists(GetPolicyRequest getPolicyRequest)

Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getPolicyRequest - the request to be used for polling

Returns:

CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.

waitUntilPolicyExists

default CompletableFuture<WaiterResponse<GetPolicyResponse>> waitUntilPolicyExists(Consumer<GetPolicyRequest.Builder> getPolicyRequest)

Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists 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 GetPolicyRequest.builder()

Parameters:

getPolicyRequest - The consumer that will configure the request to be used for polling

Returns:

CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilPolicyExists

default CompletableFuture<WaiterResponse<GetPolicyResponse>> waitUntilPolicyExists(GetPolicyRequest getPolicyRequest,
                                                                                   WaiterOverrideConfiguration overrideConfig)

Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getPolicyRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilPolicyExists

default CompletableFuture<WaiterResponse<GetPolicyResponse>> waitUntilPolicyExists(Consumer<GetPolicyRequest.Builder> getPolicyRequest,
                                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls IamAsyncClient.getPolicy(software.amazon.awssdk.services.iam.model.GetPolicyRequest) API until the desired condition PolicyExists 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:

getPolicyRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilRoleExists

default CompletableFuture<WaiterResponse<GetRoleResponse>> waitUntilRoleExists(GetRoleRequest getRoleRequest)

Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getRoleRequest - the request to be used for polling

Returns:

CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.

waitUntilRoleExists

default CompletableFuture<WaiterResponse<GetRoleResponse>> waitUntilRoleExists(Consumer<GetRoleRequest.Builder> getRoleRequest)

Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists 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 GetRoleRequest.builder()

Parameters:

getRoleRequest - The consumer that will configure the request to be used for polling

Returns:

CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilRoleExists

default CompletableFuture<WaiterResponse<GetRoleResponse>> waitUntilRoleExists(GetRoleRequest getRoleRequest,
                                                                               WaiterOverrideConfiguration overrideConfig)

Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getRoleRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilRoleExists

default CompletableFuture<WaiterResponse<GetRoleResponse>> waitUntilRoleExists(Consumer<GetRoleRequest.Builder> getRoleRequest,
                                                                               Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls IamAsyncClient.getRole(software.amazon.awssdk.services.iam.model.GetRoleRequest) API until the desired condition RoleExists 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:

getRoleRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilUserExists

default CompletableFuture<WaiterResponse<GetUserResponse>> waitUntilUserExists(GetUserRequest getUserRequest)

Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getUserRequest - the request to be used for polling

Returns:

CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.

waitUntilUserExists

default CompletableFuture<WaiterResponse<GetUserResponse>> waitUntilUserExists(Consumer<GetUserRequest.Builder> getUserRequest)

Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists 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 GetUserRequest.builder()

Parameters:

getUserRequest - The consumer that will configure the request to be used for polling

Returns:

CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilUserExists

default CompletableFuture<WaiterResponse<GetUserResponse>> waitUntilUserExists(GetUserRequest getUserRequest,
                                                                               WaiterOverrideConfiguration overrideConfig)

Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getUserRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilUserExists

default CompletableFuture<WaiterResponse<GetUserResponse>> waitUntilUserExists(Consumer<GetUserRequest.Builder> getUserRequest,
                                                                               Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls IamAsyncClient.getUser(software.amazon.awssdk.services.iam.model.GetUserRequest) API until the desired condition UserExists 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:

getUserRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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 IamAsyncWaiter.Builder builder()

Create a builder that can be used to configure and create a IamAsyncWaiter.

Returns:

a builder

create

static IamAsyncWaiter create()

Create an instance of IamAsyncWaiter with the default configuration.

A default IamAsyncClient 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, invoke SdkAutoCloseable.close() to release the resources once the waiter is not needed.

Returns:

an instance of IamAsyncWaiter