com.amazonaws.services.cloudcontrolapi

Interface AWSCloudControlApi

All Known Subinterfaces:

AWSCloudControlApiAsync

All Known Implementing Classes:

AbstractAWSCloudControlApi, AbstractAWSCloudControlApiAsync, AWSCloudControlApiAsyncClient, AWSCloudControlApiClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloudControlApi

Interface for accessing CloudControlApi.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCloudControlApi instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelResourceRequestResult	cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest) Cancels the specified resource operation request.
CreateResourceResult	createResource(CreateResourceRequest createResourceRequest) Creates the specified resource.
DeleteResourceResult	deleteResource(DeleteResourceRequest deleteResourceRequest) 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 getResourceRequest) Returns information about the current state of the specified resource.
GetResourceRequestStatusResult	getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest) Returns the current status of a resource operation request.
ListResourceRequestsResult	listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest) Returns existing resource operation requests.
ListResourcesResult	listResources(ListResourcesRequest listResourcesRequest) Returns information about the specified resources.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateResourceResult	updateResource(UpdateResourceRequest updateResourceRequest) Updates the specified property values in the resource.
AWSCloudControlApiWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelResourceRequest

CancelResourceRequestResult cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest)

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can 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.

See Also:

AWS API Documentation

createResource

CreateResourceResult createResource(CreateResourceRequest createResourceRequest)

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource.

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 a 5XX HTTP status code.

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

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

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

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

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

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteResource

DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

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 a 5XX HTTP status code.

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

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

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

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

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

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getResource

GetResourceResult getResource(GetResourceRequest getResourceRequest)

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

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 a 5XX HTTP status code.

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

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

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

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getResourceRequestStatus

GetResourceRequestStatusResult getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest)

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Parameters:

getResourceRequestStatusRequest -

Returns:

Result of the GetResourceRequestStatus operation returned by the service.

Throws:

RequestTokenNotFoundException - A resource operation with the specified request token can't be found.

See Also:

AWS API Documentation

listResourceRequests

ListResourceRequestsResult listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest)

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Resource operation requests expire after 7 days.

Parameters:

listResourceRequestsRequest -

Returns:

Result of the ListResourceRequests operation returned by the service.

See Also:

AWS API Documentation

listResources

ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

Parameters:

listResourcesRequest -

Returns:

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 a 5XX HTTP status code.

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

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

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

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateResource

UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.

For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

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 a 5XX HTTP status code.

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

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

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

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

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

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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

waiters

AWSCloudControlApiWaiters waiters()