Interface CloudControlClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudControlClient extends AwsClient
Service client for accessing CloudControlApi. This can be created using the staticbuilder()method.For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelResourceRequest
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
PENDINGorIN_PROGRESScan be canceled.- Parameters:
cancelResourceRequestRequest-- Returns:
- Result of the CancelResourceRequest operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelResourceRequest
default 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
PENDINGorIN_PROGRESScan be canceled.
This is a convenience which creates an instance of the
CancelResourceRequestRequest.Builderavoiding the need to create one manually viaCancelResourceRequestRequest.builder()- Parameters:
cancelResourceRequestRequest- AConsumerthat will call methods onCancelResourceRequestRequest.Builderto create a request.- Returns:
- Result of the CancelResourceRequest operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createResource
default 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
RequestTokenof theProgressEventtype returned byCreateResource.- Parameters:
createResourceRequest-- Returns:
- Result of the CreateResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
createResource
default 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
RequestTokenof theProgressEventtype returned byCreateResource.
This is a convenience which creates an instance of the
CreateResourceRequest.Builderavoiding the need to create one manually viaCreateResourceRequest.builder()- Parameters:
createResourceRequest- AConsumerthat will call methods onCreateResourceRequest.Builderto create a request.- Returns:
- Result of the CreateResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResource
default 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
RequestTokenof theProgressEventreturned byDeleteResource.- Parameters:
deleteResourceRequest-- Returns:
- Result of the DeleteResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResource
default 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
RequestTokenof theProgressEventreturned byDeleteResource.
This is a convenience which creates an instance of the
DeleteResourceRequest.Builderavoiding the need to create one manually viaDeleteResourceRequest.builder()- Parameters:
deleteResourceRequest- AConsumerthat will call methods onDeleteResourceRequest.Builderto create a request.- Returns:
- Result of the DeleteResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResource
default 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.
- Parameters:
getResourceRequest-- Returns:
- Result of the GetResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResource
default 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.Builderavoiding the need to create one manually viaGetResourceRequest.builder()- Parameters:
getResourceRequest- AConsumerthat will call methods onGetResourceRequest.Builderto create a request.- Returns:
- Result of the GetResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceRequestStatus
default 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.
- Parameters:
getResourceRequestStatusRequest-- Returns:
- Result of the GetResourceRequestStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceRequestStatus
default 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.Builderavoiding the need to create one manually viaGetResourceRequestStatusRequest.builder()- Parameters:
getResourceRequestStatusRequest- AConsumerthat will call methods onGetResourceRequestStatusRequest.Builderto create a request.- Returns:
- Result of the GetResourceRequestStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceRequests
default 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.
- Parameters:
listResourceRequestsRequest-- Returns:
- Result of the ListResourceRequests operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceRequests
default 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.Builderavoiding the need to create one manually viaListResourceRequestsRequest.builder()- Parameters:
listResourceRequestsRequest- AConsumerthat will call methods onListResourceRequestsRequest.Builderto create a request.- Returns:
- Result of the ListResourceRequests operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceRequestsPaginator
default ListResourceRequestsIterable listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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
2) Using For loopsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listResourceRequestsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceRequestsPaginator
default ListResourceRequestsIterable listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest) throws AwsServiceException, SdkClientException, CloudControlException
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
2) Using For loopsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListResourceRequestsRequest.builder()- Parameters:
listResourceRequestsRequest- AConsumerthat will call methods onListResourceRequestsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default 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.
- Parameters:
listResourcesRequest-- Returns:
- Result of the ListResources operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default 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.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- Result of the ListResources operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default 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
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
2) Using For loopsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default 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
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
2) Using For loopsoftware.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResource
default 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
RequestTokenof theProgressEventreturned 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:
- Result of the UpdateResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResource
default 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
RequestTokenof theProgressEventreturned 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.Builderavoiding the need to create one manually viaUpdateResourceRequest.builder()- Parameters:
updateResourceRequest- AConsumerthat will call methods onUpdateResourceRequest.Builderto create a request.- Returns:
- Result of the UpdateResource operation returned by the service.
- Throws:
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 a5XX HTTPstatus 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.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default CloudControlWaiter waiter()
Create an instance ofCloudControlWaiterusing 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
CloudControlWaiter
-
create
static CloudControlClient create()
Create aCloudControlClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static CloudControlClientBuilder builder()
Create a builder that can be used to configure and create aCloudControlClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default CloudControlServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-