com.amazonaws.services.cloudcontrolapi

Interface AWSCloudControlApiAsync

All Superinterfaces:

AWSCloudControlApi

All Known Implementing Classes:

AbstractAWSCloudControlApiAsync, AWSCloudControlApiAsyncClient

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

Interface for accessing CloudControlApi asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

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 inherited from interface com.amazonaws.services.cloudcontrolapi.AWSCloudControlApi

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CancelResourceRequestResult>	cancelResourceRequestAsync(CancelResourceRequestRequest cancelResourceRequestRequest) Cancels the specified resource operation request.
Future<CancelResourceRequestResult>	cancelResourceRequestAsync(CancelResourceRequestRequest cancelResourceRequestRequest, AsyncHandler<CancelResourceRequestRequest,CancelResourceRequestResult> asyncHandler) Cancels the specified resource operation request.
Future<CreateResourceResult>	createResourceAsync(CreateResourceRequest createResourceRequest) Creates the specified resource.
Future<CreateResourceResult>	createResourceAsync(CreateResourceRequest createResourceRequest, AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler) Creates the specified resource.
Future<DeleteResourceResult>	deleteResourceAsync(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource.
Future<DeleteResourceResult>	deleteResourceAsync(DeleteResourceRequest deleteResourceRequest, AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler) Deletes the specified resource.
Future<GetResourceResult>	getResourceAsync(GetResourceRequest getResourceRequest) Returns information about the current state of the specified resource.
Future<GetResourceResult>	getResourceAsync(GetResourceRequest getResourceRequest, AsyncHandler<GetResourceRequest,GetResourceResult> asyncHandler) Returns information about the current state of the specified resource.
Future<GetResourceRequestStatusResult>	getResourceRequestStatusAsync(GetResourceRequestStatusRequest getResourceRequestStatusRequest) Returns the current status of a resource operation request.
Future<GetResourceRequestStatusResult>	getResourceRequestStatusAsync(GetResourceRequestStatusRequest getResourceRequestStatusRequest, AsyncHandler<GetResourceRequestStatusRequest,GetResourceRequestStatusResult> asyncHandler) Returns the current status of a resource operation request.
Future<ListResourceRequestsResult>	listResourceRequestsAsync(ListResourceRequestsRequest listResourceRequestsRequest) Returns existing resource operation requests.
Future<ListResourceRequestsResult>	listResourceRequestsAsync(ListResourceRequestsRequest listResourceRequestsRequest, AsyncHandler<ListResourceRequestsRequest,ListResourceRequestsResult> asyncHandler) Returns existing resource operation requests.
Future<ListResourcesResult>	listResourcesAsync(ListResourcesRequest listResourcesRequest) Returns information about the specified resources.
Future<ListResourcesResult>	listResourcesAsync(ListResourcesRequest listResourcesRequest, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler) Returns information about the specified resources.
Future<UpdateResourceResult>	updateResourceAsync(UpdateResourceRequest updateResourceRequest) Updates the specified property values in the resource.
Future<UpdateResourceResult>	updateResourceAsync(UpdateResourceRequest updateResourceRequest, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler) Updates the specified property values in the resource.

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

cancelResourceRequest, createResource, deleteResource, getCachedResponseMetadata, getResource, getResourceRequestStatus, listResourceRequests, listResources, shutdown, updateResource, waiters

Method Detail

cancelResourceRequestAsync

Future<CancelResourceRequestResult> cancelResourceRequestAsync(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 cancelled.

Parameters:

cancelResourceRequestRequest -

Returns:

A Java Future containing the result of the CancelResourceRequest operation returned by the service.

See Also:

AWS API Documentation

cancelResourceRequestAsync

Future<CancelResourceRequestResult> cancelResourceRequestAsync(CancelResourceRequestRequest cancelResourceRequestRequest,
                                                               AsyncHandler<CancelResourceRequestRequest,CancelResourceRequestResult> asyncHandler)

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.

Parameters:

cancelResourceRequestRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CancelResourceRequest operation returned by the service.

See Also:

AWS API Documentation

createResourceAsync

Future<CreateResourceResult> createResourceAsync(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:

A Java Future containing the result of the CreateResource operation returned by the service.

See Also:

AWS API Documentation

createResourceAsync

Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest,
                                                 AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateResource operation returned by the service.

See Also:

AWS API Documentation

deleteResourceAsync

Future<DeleteResourceResult> deleteResourceAsync(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:

A Java Future containing the result of the DeleteResource operation returned by the service.

See Also:

AWS API Documentation

deleteResourceAsync

Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest,
                                                 AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteResource operation returned by the service.

See Also:

AWS API Documentation

getResourceAsync

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

Parameters:

getResourceRequest -

Returns:

A Java Future containing the result of the GetResource operation returned by the service.

See Also:

AWS API Documentation

getResourceAsync

Future<GetResourceResult> getResourceAsync(GetResourceRequest getResourceRequest,
                                           AsyncHandler<GetResourceRequest,GetResourceResult> asyncHandler)

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.

Parameters:

getResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetResource operation returned by the service.

See Also:

AWS API Documentation

getResourceRequestStatusAsync

Future<GetResourceRequestStatusResult> getResourceRequestStatusAsync(GetResourceRequestStatusRequest getResourceRequestStatusRequest)

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

Parameters:

getResourceRequestStatusRequest -

Returns:

A Java Future containing the result of the GetResourceRequestStatus operation returned by the service.

See Also:

AWS API Documentation

getResourceRequestStatusAsync

Future<GetResourceRequestStatusResult> getResourceRequestStatusAsync(GetResourceRequestStatusRequest getResourceRequestStatusRequest,
                                                                     AsyncHandler<GetResourceRequestStatusRequest,GetResourceRequestStatusResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetResourceRequestStatus operation returned by the service.

See Also:

AWS API Documentation

listResourceRequestsAsync

Future<ListResourceRequestsResult> listResourceRequestsAsync(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 seven days.

Parameters:

listResourceRequestsRequest -

Returns:

A Java Future containing the result of the ListResourceRequests operation returned by the service.

See Also:

AWS API Documentation

listResourceRequestsAsync

Future<ListResourceRequestsResult> listResourceRequestsAsync(ListResourceRequestsRequest listResourceRequestsRequest,
                                                             AsyncHandler<ListResourceRequestsRequest,ListResourceRequestsResult> asyncHandler)

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.

Parameters:

listResourceRequestsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListResourceRequests operation returned by the service.

See Also:

AWS API Documentation

listResourcesAsync

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

Parameters:

listResourcesRequest -

Returns:

A Java Future containing the result of the ListResources operation returned by the service.

See Also:

AWS API Documentation

listResourcesAsync

Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest,
                                               AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)

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.

Parameters:

listResourcesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListResources operation returned by the service.

See Also:

AWS API Documentation

updateResourceAsync

Future<UpdateResourceResult> updateResourceAsync(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 Amazon Web Services CloudFormation Users Guide.

Parameters:

updateResourceRequest -

Returns:

A Java Future containing the result of the UpdateResource operation returned by the service.

See Also:

AWS API Documentation

updateResourceAsync

Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest,
                                                 AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)

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.

Parameters:

updateResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateResource operation returned by the service.

See Also:

AWS API Documentation