Package software.amazon.awssdk.services.controlcatalog

Interface ControlCatalogClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Welcome to the Amazon Web Services Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Amazon Web Services Control Catalog.

Use the following links to get started with the Amazon Web Services Control Catalog API:

• Actions: An alphabetical list of all Control Catalog API operations.

• Data types: An alphabetical list of all Control Catalog data types.

• Common parameters: Parameters that all operations can use.

• Common errors: Client and server errors that all operations can return.

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 ControlCatalogClientBuilder	builder()	Create a builder that can be used to configure and create a ControlCatalogClient.
static ControlCatalogClient	create()	Create a ControlCatalogClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListCommonControlsResponse	listCommonControls(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)	Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
default ListCommonControlsResponse	listCommonControls(ListCommonControlsRequest listCommonControlsRequest)	Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
default ListCommonControlsIterable	listCommonControlsPaginator(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)	This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.
default ListCommonControlsIterable	listCommonControlsPaginator(ListCommonControlsRequest listCommonControlsRequest)	This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	Returns a paginated list of domains from the Amazon Web Services Control Catalog.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest)	Returns a paginated list of domains from the Amazon Web Services Control Catalog.
default ListDomainsIterable	listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.
default ListDomainsIterable	listDomainsPaginator(ListDomainsRequest listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.
default ListObjectivesResponse	listObjectives(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)	Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
default ListObjectivesResponse	listObjectives(ListObjectivesRequest listObjectivesRequest)	Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
default ListObjectivesIterable	listObjectivesPaginator(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)	This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.
default ListObjectivesIterable	listObjectivesPaginator(ListObjectivesRequest listObjectivesRequest)	This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.
default ControlCatalogServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

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

listCommonControls

default ListCommonControlsResponse listCommonControls(ListCommonControlsRequest listCommonControlsRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

Parameters:

listCommonControlsRequest -

Returns:

Result of the ListCommonControls operation returned by the service.

See Also:

• AWS API Documentation

listCommonControls

default ListCommonControlsResponse listCommonControls(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

This is a convenience which creates an instance of the ListCommonControlsRequest.Builder avoiding the need to create one manually via ListCommonControlsRequest.builder()

Parameters:

listCommonControlsRequest - A Consumer that will call methods on ListCommonControlsRequest.Builder to create a request.

Returns:

Result of the ListCommonControls operation returned by the service.

See Also:

• AWS API Documentation

listCommonControlsPaginator

default ListCommonControlsIterable listCommonControlsPaginator(ListCommonControlsRequest listCommonControlsRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) 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.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client
             .listCommonControlsPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(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 listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.

Parameters:

listCommonControlsRequest -

Returns:

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

See Also:

• AWS API Documentation

listCommonControlsPaginator

default ListCommonControlsIterable listCommonControlsPaginator(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) 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.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client
             .listCommonControlsPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(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 listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.

This is a convenience which creates an instance of the ListCommonControlsRequest.Builder avoiding the need to create one manually via ListCommonControlsRequest.builder()

Parameters:

listCommonControlsRequest - A Consumer that will call methods on ListCommonControlsRequest.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

listDomains

default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest)
                                          throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) 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.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client
             .listDomainsPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(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 listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.

Parameters:

listDomainsRequest -

Returns:

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

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                          throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) 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.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client
             .listDomainsPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(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 listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.

This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.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

listObjectives

default ListObjectivesResponse listObjectives(ListObjectivesRequest listObjectivesRequest)
                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

Parameters:

listObjectivesRequest -

Returns:

Result of the ListObjectives operation returned by the service.

See Also:

• AWS API Documentation

listObjectives

default ListObjectivesResponse listObjectives(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)
                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

This is a convenience which creates an instance of the ListObjectivesRequest.Builder avoiding the need to create one manually via ListObjectivesRequest.builder()

Parameters:

listObjectivesRequest - A Consumer that will call methods on ListObjectivesRequest.Builder to create a request.

Returns:

Result of the ListObjectives operation returned by the service.

See Also:

• AWS API Documentation

listObjectivesPaginator

default ListObjectivesIterable listObjectivesPaginator(ListObjectivesRequest listObjectivesRequest)
                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) 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.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client
             .listObjectivesPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(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 listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.

Parameters:

listObjectivesRequest -

Returns:

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

See Also:

• AWS API Documentation

listObjectivesPaginator

default ListObjectivesIterable listObjectivesPaginator(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)
                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) 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.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client
             .listObjectivesPaginator(request);
     for (software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(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 listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.

This is a convenience which creates an instance of the ListObjectivesRequest.Builder avoiding the need to create one manually via ListObjectivesRequest.builder()

Parameters:

listObjectivesRequest - A Consumer that will call methods on ListObjectivesRequest.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

create

static ControlCatalogClient create()

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

builder

static ControlCatalogClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ControlCatalogServiceClientConfiguration 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