View Source AWS.ControlCatalog (aws-elixir v1.0.4)
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.
Link to this section Summary
Functions
Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported.
Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library.
Returns a paginated list of domains from the Amazon Web Services Control Catalog.
Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
Link to this section Functions
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.
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.
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.
Returns a paginated list of domains from the Amazon Web Services Control Catalog.
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.