@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudControlAsyncClient extends AwsClient
builder()
method.
For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CancelResourceRequestResponse> 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.
cancelResourceRequestRequest - default CompletableFuture<CancelResourceRequestResponse> cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> 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.
This is a convenience which creates an instance of the CancelResourceRequestRequest.Builder avoiding the
need to create one manually via CancelResourceRequestRequest.builder()
cancelResourceRequestRequest - A Consumer that will call methods on CancelResourceRequestInput.Builder to create a
request.default CompletableFuture<CreateResourceResponse> 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.
createResourceRequest - 5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> 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.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceInput.Builder to create a request.5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CompletableFuture<DeleteResourceResponse> 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.
deleteResourceRequest - 5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceInput.Builder to create a request.5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CompletableFuture<GetResourceResponse> 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.
getResourceRequest - 5XX HTTP status code.default CompletableFuture<GetResourceResponse> getResource(Consumer<GetResourceRequest.Builder> 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.
This is a convenience which creates an instance of the GetResourceRequest.Builder avoiding the need to
create one manually via GetResourceRequest.builder()
getResourceRequest - A Consumer that will call methods on GetResourceInput.Builder to create a request.5XX HTTP status code.default CompletableFuture<GetResourceRequestStatusResponse> 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.
getResourceRequestStatusRequest - default CompletableFuture<GetResourceRequestStatusResponse> getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> 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.
This is a convenience which creates an instance of the GetResourceRequestStatusRequest.Builder avoiding
the need to create one manually via GetResourceRequestStatusRequest.builder()
getResourceRequestStatusRequest - A Consumer that will call methods on GetResourceRequestStatusInput.Builder to create a
request.default CompletableFuture<ListResourceRequestsResponse> 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.
listResourceRequestsRequest - default CompletableFuture<ListResourceRequestsResponse> listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> 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.
This is a convenience which creates an instance of the ListResourceRequestsRequest.Builder avoiding the
need to create one manually via ListResourceRequestsRequest.builder()
listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsInput.Builder to create a
request.default ListResourceRequestsPublisher listResourceRequestsPaginator(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.
This is a variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.
listResourceRequestsRequest - default ListResourceRequestsPublisher listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> 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.
This is a variant of
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsPublisher publisher = client.listResourceRequestsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRequests(software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsRequest)
operation.
This is a convenience which creates an instance of the ListResourceRequestsRequest.Builder avoiding the
need to create one manually via ListResourceRequestsRequest.builder()
listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsInput.Builder to create a
request.default CompletableFuture<ListResourcesResponse> 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.
listResourcesRequest - 5XX HTTP status code.default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> 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.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesInput.Builder to create a request.5XX HTTP status code.default ListResourcesPublisher listResourcesPaginator(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.
This is a variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation.
listResourcesRequest - 5XX HTTP status code.default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> 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.
This is a variant of
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.cloudcontrol.model.ListResourcesRequest) operation.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesInput.Builder to create a request.5XX HTTP status code.default CompletableFuture<UpdateResourceResponse> 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.
updateResourceRequest - 5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceInput.Builder to create a request.5XX HTTP status code.It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
default CloudControlAsyncWaiter waiter()
CloudControlAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudControlAsyncWaiterdefault CloudControlServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic CloudControlAsyncClient create()
CloudControlAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudControlAsyncClientBuilder builder()
CloudControlAsyncClient.Copyright © 2023. All rights reserved.