@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudControlClient extends AwsClient
builder() method.
For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static CloudControlClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudControlClient. |
default CancelResourceRequestResponse |
cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest)
Cancels the specified resource operation request.
|
default CancelResourceRequestResponse |
cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest)
Cancels the specified resource operation request.
|
static CloudControlClient |
create()
Create a
CloudControlClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateResourceResponse |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates the specified resource.
|
default CreateResourceResponse |
createResource(CreateResourceRequest createResourceRequest)
Creates the specified resource.
|
default DeleteResourceResponse |
deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
|
default DeleteResourceResponse |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
|
default GetResourceResponse |
getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)
Returns information about the current state of the specified resource.
|
default GetResourceResponse |
getResource(GetResourceRequest getResourceRequest)
Returns information about the current state of the specified resource.
|
default GetResourceRequestStatusResponse |
getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest)
Returns the current status of a resource operation request.
|
default GetResourceRequestStatusResponse |
getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest)
Returns the current status of a resource operation request.
|
default ListResourceRequestsResponse |
listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)
Returns existing resource operation requests.
|
default ListResourceRequestsResponse |
listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest)
Returns existing resource operation requests.
|
default ListResourceRequestsIterable |
listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)
Returns existing resource operation requests.
|
default ListResourceRequestsIterable |
listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest)
Returns existing resource operation requests.
|
default ListResourcesResponse |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns information about the specified resources.
|
default ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Returns information about the specified resources.
|
default ListResourcesIterable |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns information about the specified resources.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns information about the specified resources.
|
default CloudControlServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default UpdateResourceResponse |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates the specified property values in the resource.
|
default UpdateResourceResponse |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates the specified property values in the resource.
|
default CloudControlWaiter |
waiter()
Create an instance of
CloudControlWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CancelResourceRequestResponse cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest) throws ConcurrentModificationException, RequestTokenNotFoundException, AwsServiceException, SdkClientException, CloudControlException
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 or IN_PROGRESS can be
canceled.
cancelResourceRequestRequest - 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.AwsServiceExceptiondefault CancelResourceRequestResponse cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest) throws ConcurrentModificationException, RequestTokenNotFoundException, AwsServiceException, SdkClientException, CloudControlException
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 or IN_PROGRESS can be
canceled.
This is a convenience which creates an instance of the CancelResourceRequestRequest.Builder avoiding the
need to create one manually via CancelResourceRequestRequest.builder()
cancelResourceRequestRequest - A Consumer that will call methods on CancelResourceRequestInput.Builder to create a
request.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.AwsServiceExceptiondefault CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent type returned
by CreateResource.
createResourceRequest - 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.AwsServiceExceptiondefault CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent type returned
by CreateResource.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent returned by
DeleteResource.
deleteResourceRequest - 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.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent returned by
DeleteResource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceInput.Builder to create a request.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.AwsServiceExceptiondefault GetResourceResponse getResource(GetResourceRequest getResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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.
getResourceRequest - 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.AwsServiceExceptiondefault GetResourceResponse getResource(Consumer<GetResourceRequest.Builder> getResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 via GetResourceRequest.builder()
getResourceRequest - A Consumer that will call methods on GetResourceInput.Builder to create a request.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.AwsServiceExceptiondefault GetResourceRequestStatusResponse getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest) throws RequestTokenNotFoundException, AwsServiceException, SdkClientException, CloudControlException
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.
getResourceRequestStatusRequest - 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.AwsServiceExceptiondefault GetResourceRequestStatusResponse getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest) throws RequestTokenNotFoundException, AwsServiceException, SdkClientException, CloudControlException
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 via GetResourceRequestStatusRequest.builder()
getResourceRequestStatusRequest - A Consumer that will call methods on GetResourceRequestStatusInput.Builder to create a
request.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.AwsServiceExceptiondefault ListResourceRequestsResponse listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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.
listResourceRequestsRequest - 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.AwsServiceExceptiondefault ListResourceRequestsResponse listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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 via ListResourceRequestsRequest.builder()
listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsInput.Builder to create a
request.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.AwsServiceExceptiondefault ListResourceRequestsIterable listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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 variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client
.listResourceRequestsPaginator(request);
for (software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listResourceRequestsRequest - 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.AwsServiceExceptiondefault ListResourceRequestsIterable listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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 variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client
.listResourceRequestsPaginator(request);
for (software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListResourceRequestsRequest.builder()
listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsInput.Builder to create a
request.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.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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.
listResourcesRequest - 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.AwsServiceExceptiondefault ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesInput.Builder to create a request.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.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listResourcesRequest - 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.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent returned by
UpdateResource.
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.
updateResourceRequest - 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.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws AlreadyExistsException, HandlerInternalFailureException, GeneralServiceException, NotUpdatableException, TypeNotFoundException, ConcurrentOperationException, InvalidRequestException, PrivateTypeException, ResourceNotFoundException, NetworkFailureException, UnsupportedActionException, NotStabilizedException, ServiceInternalErrorException, HandlerFailureException, ServiceLimitExceededException, InvalidCredentialsException, ResourceConflictException, ClientTokenConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudControlException
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 the ProgressEvent returned by
UpdateResource.
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 via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceInput.Builder to create a request.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.AwsServiceExceptiondefault CloudControlWaiter waiter()
CloudControlWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudControlWaiterstatic CloudControlClient create()
CloudControlClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudControlClientBuilder builder()
CloudControlClient.static ServiceMetadata serviceMetadata()
default CloudControlServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.