Package software.amazon.awssdk.services.cloudcontrol

Interface CloudControlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudControlClient
extends AwsClient

Service client for accessing CloudControlApi. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CloudControlClientBuilder	builder()	Create a builder that can be used to configure and create a CloudControlClient.
default CancelResourceRequestResponse	cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest)	Cancels the specified resource operation request.
default CancelResourceRequestResponse	cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest)	Cancels the specified resource operation request.
static CloudControlClient	create()	Create a CloudControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateResourceResponse	createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)	Creates the specified resource.
default CreateResourceResponse	createResource(CreateResourceRequest createResourceRequest)	Creates the specified resource.
default DeleteResourceResponse	deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)	Deletes the specified resource.
default DeleteResourceResponse	deleteResource(DeleteResourceRequest deleteResourceRequest)	Deletes the specified resource.
default GetResourceResponse	getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)	Returns information about the current state of the specified resource.
default GetResourceResponse	getResource(GetResourceRequest getResourceRequest)	Returns information about the current state of the specified resource.
default GetResourceRequestStatusResponse	getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest)	Returns the current status of a resource operation request.
default GetResourceRequestStatusResponse	getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest)	Returns the current status of a resource operation request.
default ListResourceRequestsResponse	listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)	Returns existing resource operation requests.
default ListResourceRequestsResponse	listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest)	Returns existing resource operation requests.
default ListResourceRequestsIterable	listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)	Returns existing resource operation requests.
default ListResourceRequestsIterable	listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest)	Returns existing resource operation requests.
default ListResourcesResponse	listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)	Returns information about the specified resources.
default ListResourcesResponse	listResources(ListResourcesRequest listResourcesRequest)	Returns information about the specified resources.
default ListResourcesIterable	listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)	Returns information about the specified resources.
default ListResourcesIterable	listResourcesPaginator(ListResourcesRequest listResourcesRequest)	Returns information about the specified resources.
default CloudControlServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateResourceResponse	updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)	Updates the specified property values in the resource.
default UpdateResourceResponse	updateResource(UpdateResourceRequest updateResourceRequest)	Updates the specified property values in the resource.
default CloudControlWaiter	waiter()	Create an instance of CloudControlWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

cancelResourceRequest

default CancelResourceRequestResponse cancelResourceRequest(CancelResourceRequestRequest cancelResourceRequestRequest)
                                                     throws ConcurrentModificationException,
RequestTokenNotFoundException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

cancelResourceRequest

default CancelResourceRequestResponse cancelResourceRequest(Consumer<CancelResourceRequestRequest.Builder> cancelResourceRequestRequest)
                                                     throws ConcurrentModificationException,
RequestTokenNotFoundException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

cancelResourceRequestRequest - A Consumer that will call methods on CancelResourceRequestRequest.Builder to create a request.

Returns:

Result of the CancelResourceRequest operation returned by the service.

See Also:

• AWS API Documentation

createResource

default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

createResource

default CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.

Returns:

Result of the CreateResource operation returned by the service.

See Also:

• AWS API Documentation

deleteResource

default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

deleteResource

default DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.

Returns:

Result of the DeleteResource operation returned by the service.

See Also:

• AWS API Documentation

getResource

default GetResourceResponse getResource(GetResourceRequest getResourceRequest)
                                 throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

getResource

default GetResourceResponse getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)
                                 throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

getResourceRequest - A Consumer that will call methods on GetResourceRequest.Builder to create a request.

Returns:

Result of the GetResource operation returned by the service.

See Also:

• AWS API Documentation

getResourceRequestStatus

default GetResourceRequestStatusResponse getResourceRequestStatus(GetResourceRequestStatusRequest getResourceRequestStatusRequest)
                                                           throws RequestTokenNotFoundException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

getResourceRequestStatus

default GetResourceRequestStatusResponse getResourceRequestStatus(Consumer<GetResourceRequestStatusRequest.Builder> getResourceRequestStatusRequest)
                                                           throws RequestTokenNotFoundException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

getResourceRequestStatusRequest - A Consumer that will call methods on GetResourceRequestStatusRequest.Builder to create a request.

Returns:

Result of the GetResourceRequestStatus operation returned by the service.

See Also:

• AWS API Documentation

listResourceRequests

default ListResourceRequestsResponse listResourceRequests(ListResourceRequestsRequest listResourceRequestsRequest)
                                                   throws AwsServiceException,
SdkClientException,
CloudControlException

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

listResourceRequests

default ListResourceRequestsResponse listResourceRequests(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)
                                                   throws AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsRequest.Builder to create a request.

Returns:

Result of the ListResourceRequests operation returned by the service.

See Also:

• AWS API Documentation

listResourceRequestsPaginator

default ListResourceRequestsIterable listResourceRequestsPaginator(ListResourceRequestsRequest listResourceRequestsRequest)
                                                            throws AwsServiceException,
SdkClientException,
CloudControlException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client
             .listResourceRequestsPaginator(request);
     for (software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listResourceRequestsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourceRequestsPaginator

default ListResourceRequestsIterable listResourceRequestsPaginator(Consumer<ListResourceRequestsRequest.Builder> listResourceRequestsRequest)
                                                            throws AwsServiceException,
SdkClientException,
CloudControlException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client
             .listResourceRequestsPaginator(request);
     for (software.amazon.awssdk.services.cloudcontrol.model.ListResourceRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourceRequestsIterable responses = client.listResourceRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listResourceRequestsRequest - A Consumer that will call methods on ListResourceRequestsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResources

default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest)
                                     throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

listResources

default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
                                     throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.

Returns:

Result of the ListResources operation returned by the service.

See Also:

• AWS API Documentation

listResourcesPaginator

default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest)
                                              throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client
             .listResourcesPaginator(request);
     for (software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listResourcesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourcesPaginator

default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
                                              throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client
             .listResourcesPaginator(request);
     for (software.amazon.awssdk.services.cloudcontrol.model.ListResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudcontrol.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

updateResource

default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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.

See Also:

• AWS API Documentation

updateResource

default UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
                                       throws AlreadyExistsException,
HandlerInternalFailureException,
GeneralServiceException,
NotUpdatableException,
TypeNotFoundException,
ConcurrentOperationException,
InvalidRequestException,
PrivateTypeException,
ResourceNotFoundException,
NetworkFailureException,
UnsupportedActionException,
NotStabilizedException,
ServiceInternalErrorException,
HandlerFailureException,
ServiceLimitExceededException,
InvalidCredentialsException,
ResourceConflictException,
ClientTokenConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudControlException

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()

Parameters:

updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.

Returns:

Result of the UpdateResource operation returned by the service.

See Also:

• AWS API Documentation

waiter

default CloudControlWaiter waiter()

Create an instance of CloudControlWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of CloudControlWaiter

create

static CloudControlClient create()

Create a CloudControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudControlClientBuilder builder()

Create a builder that can be used to configure and create a CloudControlClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudControlServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration