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 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 Control Catalog.

Use the following links to get started with the 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 GetControlResponse	getControl(Consumer<GetControlRequest.Builder> getControlRequest)	Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported.
default GetControlResponse	getControl(GetControlRequest getControlRequest)	Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported.
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 ListControlMappingsResponse	listControlMappings(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)	Returns a paginated list of control mappings from the Control Catalog.
default ListControlMappingsResponse	listControlMappings(ListControlMappingsRequest listControlMappingsRequest)	Returns a paginated list of control mappings from the Control Catalog.
default ListControlMappingsIterable	listControlMappingsPaginator(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)	This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.
default ListControlMappingsIterable	listControlMappingsPaginator(ListControlMappingsRequest listControlMappingsRequest)	This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.
default ListControlsResponse	listControls(Consumer<ListControlsRequest.Builder> listControlsRequest)	Returns a paginated list of all available controls in the Control Catalog library.
default ListControlsResponse	listControls(ListControlsRequest listControlsRequest)	Returns a paginated list of all available controls in the Control Catalog library.
default ListControlsIterable	listControlsPaginator(Consumer<ListControlsRequest.Builder> listControlsRequest)	This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.
default ListControlsIterable	listControlsPaginator(ListControlsRequest listControlsRequest)	This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	Returns a paginated list of domains from the Control Catalog.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest)	Returns a paginated list of domains from the 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 Control Catalog.
default ListObjectivesResponse	listObjectives(ListObjectivesRequest listObjectivesRequest)	Returns a paginated list of objectives from the 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

getControl

default GetControlResponse getControl(GetControlRequest getControlRequest)
                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.

Parameters:

getControlRequest -

Returns:

Result of the GetControl operation returned by the service.

See Also:

• AWS API Documentation

getControl

default GetControlResponse getControl(Consumer<GetControlRequest.Builder> getControlRequest)
                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.

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

Parameters:

getControlRequest - A Consumer that will call methods on GetControlRequest.Builder to create a request.

Returns:

Result of the GetControl operation returned by the service.

See Also:

• AWS API Documentation

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

listControlMappings

default ListControlMappingsResponse listControlMappings(ListControlMappingsRequest listControlMappingsRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

Parameters:

listControlMappingsRequest -

Returns:

Result of the ListControlMappings operation returned by the service.

See Also:

• AWS API Documentation

listControlMappings

default ListControlMappingsResponse listControlMappings(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

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

Parameters:

listControlMappingsRequest - A Consumer that will call methods on ListControlMappingsRequest.Builder to create a request.

Returns:

Result of the ListControlMappings operation returned by the service.

See Also:

• AWS API Documentation

listControlMappingsPaginator

default ListControlMappingsIterable listControlMappingsPaginator(ListControlMappingsRequest listControlMappingsRequest)
                                                          throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) 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.ListControlMappingsIterable responses = client.listControlMappingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlMappingsIterable responses = client.listControlMappingsPaginator(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 listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.

Parameters:

listControlMappingsRequest -

Returns:

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

See Also:

• AWS API Documentation

listControlMappingsPaginator

default ListControlMappingsIterable listControlMappingsPaginator(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)
                                                          throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) 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.ListControlMappingsIterable responses = client.listControlMappingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlMappingsIterable responses = client.listControlMappingsPaginator(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 listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.

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

Parameters:

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

listControls

default ListControlsResponse listControls(ListControlsRequest listControlsRequest)
                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

Parameters:

listControlsRequest -

Returns:

Result of the ListControls operation returned by the service.

See Also:

• AWS API Documentation

listControls

default ListControlsResponse listControls(Consumer<ListControlsRequest.Builder> listControlsRequest)
                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

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

Parameters:

listControlsRequest - A Consumer that will call methods on ListControlsRequest.Builder to create a request.

Returns:

Result of the ListControls operation returned by the service.

See Also:

• AWS API Documentation

listControlsPaginator

default ListControlsIterable listControlsPaginator(ListControlsRequest listControlsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) 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.ListControlsIterable responses = client.listControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlsIterable responses = client.listControlsPaginator(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 listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.

Parameters:

listControlsRequest -

Returns:

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

See Also:

• AWS API Documentation

listControlsPaginator

default ListControlsIterable listControlsPaginator(Consumer<ListControlsRequest.Builder> listControlsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ControlCatalogException

This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) 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.ListControlsIterable responses = client.listControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlsIterable responses = client.listControlsPaginator(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 listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.

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

Parameters:

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