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 staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
GetControlaccepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.In the API response, controls that have the value
GLOBALin theScopefield do not show theDeployableRegionsfield, because it does not apply. Controls that have the valueREGIONALin theScopefield return a value for theDeployableRegionsfield, as shown in the example.- Parameters:
getControlRequest-- Returns:
- Result of the GetControl operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource does not exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
GetControlaccepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.In the API response, controls that have the value
GLOBALin theScopefield do not show theDeployableRegionsfield, because it does not apply. Controls that have the valueREGIONALin theScopefield return a value for theDeployableRegionsfield, as shown in the example.
This is a convenience which creates an instance of the
GetControlRequest.Builderavoiding the need to create one manually viaGetControlRequest.builder()- Parameters:
getControlRequest- AConsumerthat will call methods onGetControlRequest.Builderto create a request.- Returns:
- Result of the GetControl operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource does not exist.AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListCommonControlsRequest.builder()- Parameters:
listCommonControlsRequest- AConsumerthat will call methods onListCommonControlsRequest.Builderto create a request.- Returns:
- Result of the ListCommonControls operation returned by the service.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsIterable responses = client.listCommonControlsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCommonControlsRequest.builder()- Parameters:
listCommonControlsRequest- AConsumerthat will call methods onListCommonControlsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 Amazon Web Services 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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 Amazon Web Services 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.Builderavoiding the need to create one manually viaListControlsRequest.builder()- Parameters:
listControlsRequest- AConsumerthat will call methods onListControlsRequest.Builderto create a request.- Returns:
- Result of the ListControls operation returned by the service.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListControlsIterable responses = client.listControlsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListControlsIterable responses = client.listControlsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListControlsRequest.builder()- Parameters:
listControlsRequest- AConsumerthat will call methods onListControlsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListObjectivesRequest.builder()- Parameters:
listObjectivesRequest- AConsumerthat will call methods onListObjectivesRequest.Builderto create a request.- Returns:
- Result of the ListObjectives operation returned by the service.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesIterable responses = client.listObjectivesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListObjectivesRequest.builder()- Parameters:
listObjectivesRequest- AConsumerthat will call methods onListObjectivesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You do not have sufficient access to perform this action.InternalServerException- An internal service error occurred during the processing of your request. Try again later.ValidationException- The request has invalid or missing parameters.ThrottlingException- The request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ControlCatalogException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ControlCatalogClient create()
Create aControlCatalogClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ControlCatalogClientBuilder builder()
Create a builder that can be used to configure and create aControlCatalogClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ControlCatalogServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-