/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudcontrolapi; import javax.annotation.Generated; import com.amazonaws.services.cloudcontrolapi.model.*; /** * Interface for accessing CloudControlApi asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.cloudcontrolapi.AbstractAWSCloudControlApiAsync} instead. *

*

*

* For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services * Cloud Control API User Guide. *

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

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

* * @param cancelResourceRequestRequest * @return A Java Future containing the result of the CancelResourceRequest operation returned by the service. * @sample AWSCloudControlApiAsync.CancelResourceRequest * @see AWS API Documentation */ java.util.concurrent.Future 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 * canceled. *

* * @param cancelResourceRequestRequest * @param 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. * @return A Java Future containing the result of the CancelResourceRequest operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.CancelResourceRequest * @see AWS API Documentation */ java.util.concurrent.Future cancelResourceRequestAsync(CancelResourceRequestRequest cancelResourceRequestRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param createResourceRequest * @return A Java Future containing the result of the CreateResource operation returned by the service. * @sample AWSCloudControlApiAsync.CreateResource * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param createResourceRequest * @param 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. * @return A Java Future containing the result of the CreateResource operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.CreateResource * @see AWS * API Documentation */ java.util.concurrent.Future createResourceAsync(CreateResourceRequest createResourceRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param deleteResourceRequest * @return A Java Future containing the result of the DeleteResource operation returned by the service. * @sample AWSCloudControlApiAsync.DeleteResource * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param deleteResourceRequest * @param 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. * @return A Java Future containing the result of the DeleteResource operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.DeleteResource * @see AWS * API Documentation */ java.util.concurrent.Future deleteResourceAsync(DeleteResourceRequest deleteResourceRequest, com.amazonaws.handlers.AsyncHandler 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 those resources were provisioned using Cloud Control API. *

* * @param getResourceRequest * @return A Java Future containing the result of the GetResource operation returned by the service. * @sample AWSCloudControlApiAsync.GetResource * @see AWS API * Documentation */ java.util.concurrent.Future 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 those resources were provisioned using Cloud Control API. *

* * @param getResourceRequest * @param 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. * @return A Java Future containing the result of the GetResource operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.GetResource * @see AWS API * Documentation */ java.util.concurrent.Future getResourceAsync(GetResourceRequest getResourceRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param getResourceRequestStatusRequest * @return A Java Future containing the result of the GetResourceRequestStatus operation returned by the service. * @sample AWSCloudControlApiAsync.GetResourceRequestStatus * @see AWS API Documentation */ java.util.concurrent.Future 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. *

* * @param getResourceRequestStatusRequest * @param 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. * @return A Java Future containing the result of the GetResourceRequestStatus operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.GetResourceRequestStatus * @see AWS API Documentation */ java.util.concurrent.Future getResourceRequestStatusAsync(GetResourceRequestStatusRequest getResourceRequestStatusRequest, com.amazonaws.handlers.AsyncHandler 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 7 days. *

* * * @param listResourceRequestsRequest * @return A Java Future containing the result of the ListResourceRequests operation returned by the service. * @sample AWSCloudControlApiAsync.ListResourceRequests * @see AWS API Documentation */ java.util.concurrent.Future 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 7 days. *

* * * @param listResourceRequestsRequest * @param 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. * @return A Java Future containing the result of the ListResourceRequests operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.ListResourceRequests * @see AWS API Documentation */ java.util.concurrent.Future listResourceRequestsAsync(ListResourceRequestsRequest listResourceRequestsRequest, com.amazonaws.handlers.AsyncHandler 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 those resources were provisioned using Cloud Control API. *

* * @param listResourcesRequest * @return A Java Future containing the result of the ListResources operation returned by the service. * @sample AWSCloudControlApiAsync.ListResources * @see AWS API * Documentation */ java.util.concurrent.Future 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 those resources were provisioned using Cloud Control API. *

* * @param listResourcesRequest * @param 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. * @return A Java Future containing the result of the ListResources operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.ListResources * @see AWS API * Documentation */ java.util.concurrent.Future listResourcesAsync(ListResourcesRequest listResourcesRequest, com.amazonaws.handlers.AsyncHandler 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 CloudFormation Users Guide. *

* * @param updateResourceRequest * @return A Java Future containing the result of the UpdateResource operation returned by the service. * @sample AWSCloudControlApiAsync.UpdateResource * @see AWS * API Documentation */ java.util.concurrent.Future 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 CloudFormation Users Guide. *

* * @param updateResourceRequest * @param 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. * @return A Java Future containing the result of the UpdateResource operation returned by the service. * @sample AWSCloudControlApiAsyncHandler.UpdateResource * @see AWS * API Documentation */ java.util.concurrent.Future updateResourceAsync(UpdateResourceRequest updateResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }