# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.ControlCatalog do
@moduledoc """
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](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html): An alphabetical list of all Control Catalog API operations.
* [Data
types](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html):
An alphabetical list of all Control Catalog data types.
* [Common parameters](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html):
Parameters that all operations can use.
* [Common errors](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html):
Client and server errors that all operations can return.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
control_mapping() :: %{
"ControlArn" => String.t() | atom(),
"Mapping" => list(),
"MappingType" => list(any())
}
"""
@type control_mapping() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
common_control_filter() :: %{
"Objectives" => list(objective_resource_filter())
}
"""
@type common_control_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_control_mappings_response() :: %{
"ControlMappings" => list(control_mapping()),
"NextToken" => String.t() | atom()
}
"""
@type list_control_mappings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
domain_summary() :: %{
"Arn" => String.t() | atom(),
"CreateTime" => [non_neg_integer()],
"Description" => [String.t() | atom()],
"LastUpdateTime" => [non_neg_integer()],
"Name" => [String.t() | atom()]
}
"""
@type domain_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_objectives_response() :: %{
"NextToken" => String.t() | atom(),
"Objectives" => list(objective_summary())
}
"""
@type list_objectives_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_control_request() :: %{
required("ControlArn") => String.t() | atom()
}
"""
@type get_control_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
objective_summary() :: %{
"Arn" => String.t() | atom(),
"CreateTime" => [non_neg_integer()],
"Description" => [String.t() | atom()],
"Domain" => associated_domain_summary(),
"LastUpdateTime" => [non_neg_integer()],
"Name" => [String.t() | atom()]
}
"""
@type objective_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
control_mapping_filter() :: %{
"CommonControlArns" => list(String.t() | atom()),
"ControlArns" => list(String.t() | atom()),
"MappingTypes" => list(list(any())())
}
"""
@type control_mapping_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_controls_response() :: %{
"Controls" => list(control_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_controls_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
related_control_mapping_details() :: %{
"ControlArn" => String.t() | atom(),
"RelationType" => list(any())
}
"""
@type related_control_mapping_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"Message" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_control_mappings_request() :: %{
optional("Filter") => control_mapping_filter(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_control_mappings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_domains_response() :: %{
"Domains" => list(domain_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_domains_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
objective_resource_filter() :: %{
"Arn" => String.t() | atom()
}
"""
@type objective_resource_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_controls_request() :: %{
optional("Filter") => control_filter(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_controls_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
control_summary() :: %{
"Aliases" => list(String.t() | atom()),
"Arn" => String.t() | atom(),
"Behavior" => list(any()),
"CreateTime" => [non_neg_integer()],
"Description" => [String.t() | atom()],
"GovernedResources" => list(String.t() | atom()),
"Implementation" => implementation_summary(),
"Name" => [String.t() | atom()],
"Severity" => list(any())
}
"""
@type control_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
implementation_details() :: %{
"Identifier" => String.t() | atom(),
"Type" => String.t() | atom()
}
"""
@type implementation_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_common_controls_response() :: %{
"CommonControls" => list(common_control_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_common_controls_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_domains_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_domains_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"Message" => [String.t() | atom()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
region_configuration() :: %{
"DeployableRegions" => list(String.t() | atom()),
"Scope" => list(any())
}
"""
@type region_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associated_domain_summary() :: %{
"Arn" => String.t() | atom(),
"Name" => [String.t() | atom()]
}
"""
@type associated_domain_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"Message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_objectives_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("ObjectiveFilter") => objective_filter()
}
"""
@type list_objectives_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
objective_filter() :: %{
"Domains" => list(domain_resource_filter())
}
"""
@type objective_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"Message" => [String.t() | atom()]
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
framework_mapping_details() :: %{
"Item" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type framework_mapping_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"Message" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associated_objective_summary() :: %{
"Arn" => String.t() | atom(),
"Name" => [String.t() | atom()]
}
"""
@type associated_objective_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
implementation_filter() :: %{
"Identifiers" => list(String.t() | atom()),
"Types" => list(String.t() | atom())
}
"""
@type implementation_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
control_filter() :: %{
"Implementations" => implementation_filter()
}
"""
@type control_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_control_response() :: %{
"Aliases" => list(String.t() | atom()),
"Arn" => String.t() | atom(),
"Behavior" => list(any()),
"CreateTime" => [non_neg_integer()],
"Description" => [String.t() | atom()],
"GovernedResources" => list(String.t() | atom()),
"Implementation" => implementation_details(),
"Name" => [String.t() | atom()],
"Parameters" => list(control_parameter()),
"RegionConfiguration" => region_configuration(),
"Severity" => list(any())
}
"""
@type get_control_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
common_control_mapping_details() :: %{
"CommonControlArn" => String.t() | atom()
}
"""
@type common_control_mapping_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
implementation_summary() :: %{
"Identifier" => String.t() | atom(),
"Type" => String.t() | atom()
}
"""
@type implementation_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
control_parameter() :: %{
"Name" => [String.t() | atom()]
}
"""
@type control_parameter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
common_control_summary() :: %{
"Arn" => String.t() | atom(),
"CreateTime" => [non_neg_integer()],
"Description" => [String.t() | atom()],
"Domain" => associated_domain_summary(),
"LastUpdateTime" => [non_neg_integer()],
"Name" => [String.t() | atom()],
"Objective" => associated_objective_summary()
}
"""
@type common_control_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
domain_resource_filter() :: %{
"Arn" => String.t() | atom()
}
"""
@type domain_resource_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_common_controls_request() :: %{
optional("CommonControlFilter") => common_control_filter(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_common_controls_request() :: %{(String.t() | atom()) => any()}
@type get_control_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_common_controls_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_control_mappings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_controls_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_domains_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_objectives_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
def metadata do
%{
api_version: "2018-05-10",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "controlcatalog",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "ControlCatalog",
signature_version: "v4",
signing_name: "controlcatalog",
target_prefix: nil
}
end
@doc """
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.
"""
@spec get_control(map(), get_control_request(), list()) ::
{:ok, get_control_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_control_errors()}
def get_control(%Client{} = client, input, options \\ []) do
url_path = "/get-control"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_common_controls(map(), list_common_controls_request(), list()) ::
{:ok, list_common_controls_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_common_controls_errors()}
def list_common_controls(%Client{} = client, input, options \\ []) do
url_path = "/common-controls"
headers = []
custom_headers = []
{query_params, input} =
[
{"MaxResults", "maxResults"},
{"NextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_control_mappings(map(), list_control_mappings_request(), list()) ::
{:ok, list_control_mappings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_control_mappings_errors()}
def list_control_mappings(%Client{} = client, input, options \\ []) do
url_path = "/list-control-mappings"
headers = []
custom_headers = []
{query_params, input} =
[
{"MaxResults", "maxResults"},
{"NextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_controls(map(), list_controls_request(), list()) ::
{:ok, list_controls_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_controls_errors()}
def list_controls(%Client{} = client, input, options \\ []) do
url_path = "/list-controls"
headers = []
custom_headers = []
{query_params, input} =
[
{"MaxResults", "maxResults"},
{"NextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns a paginated list of domains from the Control Catalog.
"""
@spec list_domains(map(), list_domains_request(), list()) ::
{:ok, list_domains_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_domains_errors()}
def list_domains(%Client{} = client, input, options \\ []) do
url_path = "/domains"
headers = []
custom_headers = []
{query_params, input} =
[
{"MaxResults", "maxResults"},
{"NextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_objectives(map(), list_objectives_request(), list()) ::
{:ok, list_objectives_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_objectives_errors()}
def list_objectives(%Client{} = client, input, options \\ []) do
url_path = "/objectives"
headers = []
custom_headers = []
{query_params, input} =
[
{"MaxResults", "maxResults"},
{"NextToken", "nextToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
