com.amazonaws.services.controlcatalog

Interface AWSControlCatalog

All Known Subinterfaces:

AWSControlCatalogAsync

All Known Implementing Classes:

AbstractAWSControlCatalog, AbstractAWSControlCatalogAsync, AWSControlCatalogAsyncClient, AWSControlCatalogClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSControlCatalog

Interface for accessing AWS Control Catalog.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSControlCatalog instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListCommonControlsResult	listCommonControls(ListCommonControlsRequest listCommonControlsRequest) Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
ListDomainsResult	listDomains(ListDomainsRequest listDomainsRequest) Returns a paginated list of domains from the Amazon Web Services Control Catalog.
ListObjectivesResult	listObjectives(ListObjectivesRequest listObjectivesRequest) Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

listCommonControls

ListCommonControlsResult listCommonControls(ListCommonControlsRequest listCommonControlsRequest)

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.

See Also:

AWS API Documentation

listDomains

ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)

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.

See Also:

AWS API Documentation

listObjectives

ListObjectivesResult listObjectives(ListObjectivesRequest listObjectivesRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.