@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudControlApiAsyncClient extends AWSCloudControlApiClient implements AWSCloudControlApiAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, cancelResourceRequest, createResource, deleteResource, getCachedResponseMetadata, getResource, getResourceRequestStatus, listResourceRequests, listResources, updateResource, waiters
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelResourceRequest, createResource, deleteResource, getCachedResponseMetadata, getResource, getResourceRequestStatus, listResourceRequests, listResources, updateResource, waiters
public static AWSCloudControlApiAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelResourceRequestResult> cancelResourceRequestAsync(CancelResourceRequestRequest request)
AWSCloudControlApiAsync
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.
cancelResourceRequestAsync
in interface AWSCloudControlApiAsync
public Future<CancelResourceRequestResult> cancelResourceRequestAsync(CancelResourceRequestRequest request, AsyncHandler<CancelResourceRequestRequest,CancelResourceRequestResult> asyncHandler)
AWSCloudControlApiAsync
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.
cancelResourceRequestAsync
in interface AWSCloudControlApiAsync
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.public Future<CreateResourceResult> createResourceAsync(CreateResourceRequest request)
AWSCloudControlApiAsync
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
.
createResourceAsync
in interface AWSCloudControlApiAsync
public Future<CreateResourceResult> createResourceAsync(CreateResourceRequest request, AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler)
AWSCloudControlApiAsync
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
.
createResourceAsync
in interface AWSCloudControlApiAsync
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.public Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest request)
AWSCloudControlApiAsync
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
.
deleteResourceAsync
in interface AWSCloudControlApiAsync
public Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest request, AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler)
AWSCloudControlApiAsync
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
.
deleteResourceAsync
in interface AWSCloudControlApiAsync
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.public Future<GetResourceResult> getResourceAsync(GetResourceRequest request)
AWSCloudControlApiAsync
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.
getResourceAsync
in interface AWSCloudControlApiAsync
public Future<GetResourceResult> getResourceAsync(GetResourceRequest request, AsyncHandler<GetResourceRequest,GetResourceResult> asyncHandler)
AWSCloudControlApiAsync
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.
getResourceAsync
in interface AWSCloudControlApiAsync
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.public Future<GetResourceRequestStatusResult> getResourceRequestStatusAsync(GetResourceRequestStatusRequest request)
AWSCloudControlApiAsync
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.
getResourceRequestStatusAsync
in interface AWSCloudControlApiAsync
public Future<GetResourceRequestStatusResult> getResourceRequestStatusAsync(GetResourceRequestStatusRequest request, AsyncHandler<GetResourceRequestStatusRequest,GetResourceRequestStatusResult> asyncHandler)
AWSCloudControlApiAsync
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.
getResourceRequestStatusAsync
in interface AWSCloudControlApiAsync
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.public Future<ListResourceRequestsResult> listResourceRequestsAsync(ListResourceRequestsRequest request)
AWSCloudControlApiAsync
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.
listResourceRequestsAsync
in interface AWSCloudControlApiAsync
public Future<ListResourceRequestsResult> listResourceRequestsAsync(ListResourceRequestsRequest request, AsyncHandler<ListResourceRequestsRequest,ListResourceRequestsResult> asyncHandler)
AWSCloudControlApiAsync
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.
listResourceRequestsAsync
in interface AWSCloudControlApiAsync
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.public Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest request)
AWSCloudControlApiAsync
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.
listResourcesAsync
in interface AWSCloudControlApiAsync
public Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest request, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
AWSCloudControlApiAsync
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.
listResourcesAsync
in interface AWSCloudControlApiAsync
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.public Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest request)
AWSCloudControlApiAsync
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.
updateResourceAsync
in interface AWSCloudControlApiAsync
public Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest request, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
AWSCloudControlApiAsync
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.
updateResourceAsync
in interface AWSCloudControlApiAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSCloudControlApi
shutdown
in class AWSCloudControlApiClient