com.amazonaws.services.cloudcontrolapi

Class AWSCloudControlApiClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudcontrolapi.AWSCloudControlApiClient

All Implemented Interfaces:

AWSCloudControlApi

Direct Known Subclasses:

AWSCloudControlApiAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCloudControlApiClient
extends AmazonWebServiceClient
implements AWSCloudControlApi

Client for accessing CloudControlApi. All service calls made using this client are blocking, and will not return until the service call completes.

Use Amazon Web Services Cloud Control API to create, read, update, delete, and list (CRUD-L) your cloud resources that belong to a wide range of services--both Amazon Web Services and third-party. With the Cloud Control API standardized set of application programming interfaces (APIs), you can perform CRUD-L operations on any supported resources in your Amazon Web Services account. Using Cloud Control API, you won't have to generate code or scripts specific to each individual service responsible for those resources.

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 and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.cloudcontrolapi.AWSCloudControlApi

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSCloudControlApiClientBuilder	builder()
CancelResourceRequestResult	cancelResourceRequest(CancelResourceRequestRequest request) Cancels the specified resource operation request.
CreateResourceResult	createResource(CreateResourceRequest request) Creates the specified resource.
DeleteResourceResult	deleteResource(DeleteResourceRequest request) Deletes the specified resource.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetResourceResult	getResource(GetResourceRequest request) Returns information about the current state of the specified resource.
GetResourceRequestStatusResult	getResourceRequestStatus(GetResourceRequestStatusRequest request) Returns the current status of a resource operation request.
ListResourceRequestsResult	listResourceRequests(ListResourceRequestsRequest request) Returns existing resource operation requests.
ListResourcesResult	listResources(ListResourcesRequest request) Returns information about the specified resources.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateResourceResult	updateResource(UpdateResourceRequest request) Updates the specified property values in the resource.
AWSCloudControlApiWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSCloudControlApiClientBuilder builder()

cancelResourceRequest

public CancelResourceRequestResult cancelResourceRequest(CancelResourceRequestRequest request)

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 cancelled.

Specified by:

cancelResourceRequest in interface AWSCloudControlApi

Parameters:

cancelResourceRequestRequest -

Returns:

Result of the CancelResourceRequest operation returned by the service.

Throws:

RequestTokenNotFoundException - A resource operation with the specified request token cannot be found.

ConcurrentModificationException - The resource is currently being modified by another operation.

See Also:

AWS API Documentation

createResource

public CreateResourceResult createResource(CreateResourceRequest request)

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.

Specified by:

createResource in interface AWSCloudControlApi

Parameters:

createResourceRequest -

Returns:

Result of the CreateResource operation returned by the service.

Throws:

ConcurrentOperationException - Another resource operation is currently being performed on this resource.

ClientTokenConflictException - The specified client token has already been used in another resource request.

It is best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

UnsupportedActionException - The specified resource does not support this resource operation.

TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.

AlreadyExistsException - The resource with the name requested already exists.

GeneralServiceException - The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

HandlerInternalFailureException - The resource handler has returned that an unexpected error occurred within the resource handler.

InvalidCredentialsException - The resource handler has returned that the credentials provided by the user are invalid.

InvalidRequestException - The resource handler has returned that invalid input from the user has generated a generic exception.

NetworkFailureException - The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

ResourceNotFoundException - A resource with the specified identifier cannot be found.

NotStabilizedException - The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

NotUpdatableException - One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

ResourceConflictException - The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

ServiceInternalErrorException - The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

ServiceLimitExceededException - The resource handler has returned that a non-transient resource limit was reached on the service side.

ThrottlingException - The request was denied due to request throttling.

PrivateTypeException - Cloud Control API has not 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.

HandlerFailureException - The resource handler has failed without a returning a more specific error code. This can include timeouts.

See Also:

AWS API Documentation

deleteResource

public DeleteResourceResult deleteResource(DeleteResourceRequest request)

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.

Specified by:

deleteResource in interface AWSCloudControlApi

Parameters:

deleteResourceRequest -

Returns:

Result of the DeleteResource operation returned by the service.

Throws:

ConcurrentOperationException - Another resource operation is currently being performed on this resource.

ClientTokenConflictException - The specified client token has already been used in another resource request.

It is best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

UnsupportedActionException - The specified resource does not support this resource operation.

TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.

AlreadyExistsException - The resource with the name requested already exists.

GeneralServiceException - The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

HandlerInternalFailureException - The resource handler has returned that an unexpected error occurred within the resource handler.

InvalidCredentialsException - The resource handler has returned that the credentials provided by the user are invalid.

InvalidRequestException - The resource handler has returned that invalid input from the user has generated a generic exception.

NetworkFailureException - The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

ResourceNotFoundException - A resource with the specified identifier cannot be found.

NotStabilizedException - The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

NotUpdatableException - One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

ResourceConflictException - The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

ServiceInternalErrorException - The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

ServiceLimitExceededException - The resource handler has returned that a non-transient resource limit was reached on the service side.

ThrottlingException - The request was denied due to request throttling.

PrivateTypeException - Cloud Control API has not 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.

HandlerFailureException - The resource handler has failed without a returning a more specific error code. This can include timeouts.

See Also:

AWS API Documentation

getResource

public GetResourceResult getResource(GetResourceRequest request)

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 or not those resources were provisioned using Cloud Control API.

Specified by:

getResource in interface AWSCloudControlApi

Parameters:

getResourceRequest -

Returns:

Result of the GetResource operation returned by the service.

Throws:

UnsupportedActionException - The specified resource does not support this resource operation.

TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.

AlreadyExistsException - The resource with the name requested already exists.

GeneralServiceException - The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

HandlerInternalFailureException - The resource handler has returned that an unexpected error occurred within the resource handler.

InvalidCredentialsException - The resource handler has returned that the credentials provided by the user are invalid.

InvalidRequestException - The resource handler has returned that invalid input from the user has generated a generic exception.

NetworkFailureException - The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

ResourceNotFoundException - A resource with the specified identifier cannot be found.

NotStabilizedException - The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

NotUpdatableException - One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

ResourceConflictException - The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

ServiceInternalErrorException - The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

ServiceLimitExceededException - The resource handler has returned that a non-transient resource limit was reached on the service side.

ThrottlingException - The request was denied due to request throttling.

PrivateTypeException - Cloud Control API has not 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.

HandlerFailureException - The resource handler has failed without a returning a more specific error code. This can include timeouts.

See Also:

AWS API Documentation

getResourceRequestStatus

public GetResourceRequestStatusResult getResourceRequestStatus(GetResourceRequestStatusRequest request)

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.

Specified by:

getResourceRequestStatus in interface AWSCloudControlApi

Parameters:

getResourceRequestStatusRequest -

Returns:

Result of the GetResourceRequestStatus operation returned by the service.

Throws:

RequestTokenNotFoundException - A resource operation with the specified request token cannot be found.

See Also:

AWS API Documentation

listResourceRequests

public ListResourceRequestsResult listResourceRequests(ListResourceRequestsRequest request)

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 seven days.

Specified by:

listResourceRequests in interface AWSCloudControlApi

Parameters:

listResourceRequestsRequest -

Returns:

Result of the ListResourceRequests operation returned by the service.

See Also:

AWS API Documentation

listResources

public ListResourcesResult listResources(ListResourcesRequest request)

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 or not those resources were provisioned using Cloud Control API.

Specified by:

listResources in interface AWSCloudControlApi

Parameters:

listResourcesRequest -

Returns:

Result of the ListResources operation returned by the service.

Throws:

UnsupportedActionException - The specified resource does not support this resource operation.

TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.

AlreadyExistsException - The resource with the name requested already exists.

GeneralServiceException - The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

HandlerInternalFailureException - The resource handler has returned that an unexpected error occurred within the resource handler.

InvalidCredentialsException - The resource handler has returned that the credentials provided by the user are invalid.

InvalidRequestException - The resource handler has returned that invalid input from the user has generated a generic exception.

NetworkFailureException - The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

ResourceNotFoundException - A resource with the specified identifier cannot be found.

NotStabilizedException - The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

NotUpdatableException - One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

ResourceConflictException - The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

ServiceInternalErrorException - The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

ServiceLimitExceededException - The resource handler has returned that a non-transient resource limit was reached on the service side.

ThrottlingException - The request was denied due to request throttling.

PrivateTypeException - Cloud Control API has not 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.

HandlerFailureException - The resource handler has failed without a returning a more specific error code. This can include timeouts.

See Also:

AWS API Documentation

updateResource

public UpdateResourceResult updateResource(UpdateResourceRequest request)

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 Amazon Web Services CloudFormation Users Guide.

Specified by:

updateResource in interface AWSCloudControlApi

Parameters:

updateResourceRequest -

Returns:

Result of the UpdateResource operation returned by the service.

Throws:

ConcurrentOperationException - Another resource operation is currently being performed on this resource.

ClientTokenConflictException - The specified client token has already been used in another resource request.

It is best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

UnsupportedActionException - The specified resource does not support this resource operation.

TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.

AlreadyExistsException - The resource with the name requested already exists.

GeneralServiceException - The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

HandlerInternalFailureException - The resource handler has returned that an unexpected error occurred within the resource handler.

InvalidCredentialsException - The resource handler has returned that the credentials provided by the user are invalid.

InvalidRequestException - The resource handler has returned that invalid input from the user has generated a generic exception.

NetworkFailureException - The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

ResourceNotFoundException - A resource with the specified identifier cannot be found.

NotStabilizedException - The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

NotUpdatableException - One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

ResourceConflictException - The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

ServiceInternalErrorException - The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

ServiceLimitExceededException - The resource handler has returned that a non-transient resource limit was reached on the service side.

ThrottlingException - The request was denied due to request throttling.

PrivateTypeException - Cloud Control API has not 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.

HandlerFailureException - The resource handler has failed without a returning a more specific error code. This can include timeouts.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSCloudControlApi

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AWSCloudControlApiWaiters waiters()

Specified by:

waiters in interface AWSCloudControlApi

shutdown

public void shutdown()

Description copied from interface: AWSCloudControlApi

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSCloudControlApi

Overrides:

shutdown in class AmazonWebServiceClient