Interface CloudControlAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aCloudControlAsyncClient
.cancelResourceRequest
(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest) Cancels the specified resource operation request.cancelResourceRequest
(CancelResourceRequestRequest cancelResourceRequestRequest) Cancels the specified resource operation request.static CloudControlAsyncClient
create()
Create aCloudControlAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateResourceResponse> createResource
(Consumer<CreateResourceRequest.Builder> createResourceRequest) Creates the specified resource.default CompletableFuture
<CreateResourceResponse> createResource
(CreateResourceRequest createResourceRequest) Creates the specified resource.default CompletableFuture
<DeleteResourceResponse> deleteResource
(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) Deletes the specified resource.default CompletableFuture
<DeleteResourceResponse> deleteResource
(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource.default CompletableFuture
<GetResourceResponse> getResource
(Consumer<GetResourceRequest.Builder> getResourceRequest) Returns information about the current state of the specified resource.default CompletableFuture
<GetResourceResponse> getResource
(GetResourceRequest getResourceRequest) Returns information about the current state of the specified resource.getResourceRequestStatus
(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest) Returns the current status of a resource operation request.getResourceRequestStatus
(GetResourceRequestStatusRequest getResourceRequestStatusRequest) Returns the current status of a resource operation request.listResourceRequests
(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) Returns existing resource operation requests.listResourceRequests
(ListResourceRequestsRequest listResourceRequestsRequest) Returns existing resource operation requests.default ListResourceRequestsPublisher
listResourceRequestsPaginator
(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) This is a variant oflistResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.default ListResourceRequestsPublisher
listResourceRequestsPaginator
(ListResourceRequestsRequest listResourceRequestsRequest) This is a variant oflistResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.default CompletableFuture
<ListResourcesResponse> listResources
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns information about the specified resources.default CompletableFuture
<ListResourcesResponse> listResources
(ListResourcesRequest listResourcesRequest) Returns information about the specified resources.default ListResourcesPublisher
listResourcesPaginator
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation.default ListResourcesPublisher
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<UpdateResourceResponse> updateResource
(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates the specified property values in the resource.default CompletableFuture
<UpdateResourceResponse> updateResource
(UpdateResourceRequest updateResourceRequest) Updates the specified property values in the resource.default CloudControlAsyncWaiter
waiter()
Create an instance ofCloudControlAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelResourceRequest
default CompletableFuture<CancelResourceRequestResponse> cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest) Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Only resource operations requests with a status of
PENDING
orIN_PROGRESS
can be canceled.- Parameters:
cancelResourceRequestRequest
-- Returns:
- A Java Future containing the result of the CancelResourceRequest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConcurrentModificationException The resource is currently being modified by another operation.
- RequestTokenNotFoundException A resource operation with the specified request token can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelResourceRequest
default CompletableFuture<CancelResourceRequestResponse> cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest) Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Only resource operations requests with a status of
PENDING
orIN_PROGRESS
can be canceled.
This is a convenience which creates an instance of the
CancelResourceRequestRequest.Builder
avoiding the need to create one manually viaCancelResourceRequestRequest.builder()
- Parameters:
cancelResourceRequestRequest
- AConsumer
that will call methods onCancelResourceRequestRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelResourceRequest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConcurrentModificationException The resource is currently being modified by another operation.
- RequestTokenNotFoundException A resource operation with the specified request token can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResource
default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest) Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
type returned byCreateResource
.- Parameters:
createResourceRequest
-- Returns:
- A Java Future containing the result of the CreateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResource
default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
type returned byCreateResource
.
This is a convenience which creates an instance of the
CreateResourceRequest.Builder
avoiding the need to create one manually viaCreateResourceRequest.builder()
- Parameters:
createResourceRequest
- AConsumer
that will call methods onCreateResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResource
default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
returned byDeleteResource
.- Parameters:
deleteResourceRequest
-- Returns:
- A Java Future containing the result of the DeleteResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResource
default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
returned byDeleteResource
.
This is a convenience which creates an instance of the
DeleteResourceRequest.Builder
avoiding the need to create one manually viaDeleteResourceRequest.builder()
- Parameters:
deleteResourceRequest
- AConsumer
that will call methods onDeleteResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResource
Returns information about the current state of the specified resource. For details, see Reading a resource's current state.
You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.
- Parameters:
getResourceRequest
-- Returns:
- A Java Future containing the result of the GetResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResource
default CompletableFuture<GetResourceResponse> getResource(Consumer<GetResourceRequest.Builder> getResourceRequest) Returns information about the current state of the specified resource. For details, see Reading a resource's current state.
You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.
This is a convenience which creates an instance of the
GetResourceRequest.Builder
avoiding the need to create one manually viaGetResourceRequest.builder()
- Parameters:
getResourceRequest
- AConsumer
that will call methods onGetResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceRequestStatus
default CompletableFuture<GetResourceRequestStatusResponse> getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest) Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.
- Parameters:
getResourceRequestStatusRequest
-- Returns:
- A Java Future containing the result of the GetResourceRequestStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RequestTokenNotFoundException A resource operation with the specified request token can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceRequestStatus
default CompletableFuture<GetResourceRequestStatusResponse> getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest) Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.
This is a convenience which creates an instance of the
GetResourceRequestStatusRequest.Builder
avoiding the need to create one manually viaGetResourceRequestStatusRequest.builder()
- Parameters:
getResourceRequestStatusRequest
- AConsumer
that will call methods onGetResourceRequestStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourceRequestStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RequestTokenNotFoundException A resource operation with the specified request token can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRequests
default CompletableFuture<ListResourceRequestsResponse> listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest) Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Resource operation requests expire after 7 days.
- Parameters:
listResourceRequestsRequest
-- Returns:
- A Java Future containing the result of the ListResourceRequests operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRequests
default CompletableFuture<ListResourceRequestsResponse> listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Resource operation requests expire after 7 days.
This is a convenience which creates an instance of the
ListResourceRequestsRequest.Builder
avoiding the need to create one manually viaListResourceRequestsRequest.builder()
- Parameters:
listResourceRequestsRequest
- AConsumer
that will call methods onListResourceRequestsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceRequests operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRequestsPaginator
default ListResourceRequestsPublisher listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest) This is a variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.- Parameters:
listResourceRequestsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRequestsPaginator
default ListResourceRequestsPublisher listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) This is a variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.
This is a convenience which creates an instance of the
ListResourceRequestsRequest.Builder
avoiding the need to create one manually viaListResourceRequestsRequest.builder()
- Parameters:
listResourceRequestsRequest
- AConsumer
that will call methods onListResourceRequestsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.
You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.
- Parameters:
listResourcesRequest
-- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.
You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
This is a variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation.- Parameters:
listResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest) Updates the specified property values in the resource.
You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.
For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
returned byUpdateResource
.For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.
- Parameters:
updateResourceRequest
-- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates the specified property values in the resource.
You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.
For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the
RequestToken
of theProgressEvent
returned byUpdateResource
.For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.
This is a convenience which creates an instance of the
UpdateResourceRequest.Builder
avoiding the need to create one manually viaUpdateResourceRequest.builder()
- Parameters:
updateResourceRequest
- AConsumer
that will call methods onUpdateResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource with the name requested already exists.
- HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
- GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
- NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
- TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
- ConcurrentOperationException Another resource operation is currently being performed on this resource.
- InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
- PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
- ResourceNotFoundException A resource with the specified identifier can't be found.
- NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
- UnsupportedActionException The specified resource doesn't support this resource operation.
- NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
- ServiceInternalErrorException The resource handler has returned that the downstream service returned
an internal error, typically with a
5XX HTTP
status code. - HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
- ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
- InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
- ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
- ClientTokenConflictException The specified client token has already been used in another resource
request.
It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofCloudControlAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
CloudControlAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudControlAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudControlAsyncClient
.
-