# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Route53RecoveryControlConfig do
@moduledoc """
Recovery Control Configuration API Reference for Amazon Route 53 Application
Recovery Controller
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
describe_cluster_request() :: %{}
"""
@type describe_cluster_request() :: %{}
@typedoc """
## Example:
update_control_panel_response() :: %{
"ControlPanel" => control_panel()
}
"""
@type update_control_panel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_routing_control_response() :: %{
"RoutingControl" => routing_control()
}
"""
@type describe_routing_control_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("Tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_safety_rule_response() :: %{
"AssertionRule" => assertion_rule(),
"GatingRule" => gating_rule()
}
"""
@type describe_safety_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
gating_rule() :: %{
"ControlPanelArn" => String.t() | atom(),
"GatingControls" => list(String.t() | atom()),
"Name" => String.t() | atom(),
"Owner" => String.t() | atom(),
"RuleConfig" => rule_config(),
"SafetyRuleArn" => String.t() | atom(),
"Status" => list(any()),
"TargetControls" => list(String.t() | atom()),
"WaitPeriodMs" => integer()
}
"""
@type gating_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_cluster_response() :: %{
"Cluster" => cluster()
}
"""
@type describe_cluster_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_control_panel_response() :: %{}
"""
@type delete_control_panel_response() :: %{}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
create_cluster_response() :: %{
"Cluster" => cluster()
}
"""
@type create_cluster_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_routing_controls_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_routing_controls_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_control_panel_request() :: %{
required("ControlPanelArn") => String.t() | atom(),
required("ControlPanelName") => String.t() | atom()
}
"""
@type update_control_panel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_routing_control_request() :: %{}
"""
@type delete_routing_control_request() :: %{}
@typedoc """
## Example:
get_resource_policy_response() :: %{
"Policy" => String.t() | atom()
}
"""
@type get_resource_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
gating_rule_update() :: %{
"Name" => String.t() | atom(),
"SafetyRuleArn" => String.t() | atom(),
"WaitPeriodMs" => integer()
}
"""
@type gating_rule_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_control_panel_response() :: %{
"ControlPanel" => control_panel()
}
"""
@type describe_control_panel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_control_panels_response() :: %{
"ControlPanels" => list(control_panel()),
"NextToken" => String.t() | atom()
}
"""
@type list_control_panels_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cluster_endpoint() :: %{
"Endpoint" => String.t() | atom(),
"Region" => String.t() | atom()
}
"""
@type cluster_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_routing_control_request() :: %{
optional("ClientToken") => String.t() | atom(),
optional("ControlPanelArn") => String.t() | atom(),
required("ClusterArn") => String.t() | atom(),
required("RoutingControlName") => String.t() | atom()
}
"""
@type create_routing_control_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_routing_control_response() :: %{}
"""
@type delete_routing_control_response() :: %{}
@typedoc """
## Example:
update_cluster_request() :: %{
required("ClusterArn") => String.t() | atom(),
required("NetworkType") => list(any())
}
"""
@type update_cluster_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_routing_control_request() :: %{
required("RoutingControlArn") => String.t() | atom(),
required("RoutingControlName") => String.t() | atom()
}
"""
@type update_routing_control_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_safety_rule_response() :: %{}
"""
@type delete_safety_rule_response() :: %{}
@typedoc """
## Example:
create_cluster_request() :: %{
optional("ClientToken") => String.t() | atom(),
optional("NetworkType") => list(any()),
optional("Tags") => map(),
required("ClusterName") => String.t() | atom()
}
"""
@type create_cluster_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(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:
assertion_rule_update() :: %{
"Name" => String.t() | atom(),
"SafetyRuleArn" => String.t() | atom(),
"WaitPeriodMs" => integer()
}
"""
@type assertion_rule_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_routing_control_response() :: %{
"RoutingControl" => routing_control()
}
"""
@type create_routing_control_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cluster() :: %{
"ClusterArn" => String.t() | atom(),
"ClusterEndpoints" => list(cluster_endpoint()),
"Name" => String.t() | atom(),
"NetworkType" => list(any()),
"Owner" => String.t() | atom(),
"Status" => list(any())
}
"""
@type cluster() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_control_panel_request() :: %{
optional("ClientToken") => String.t() | atom(),
optional("Tags") => map(),
required("ClusterArn") => String.t() | atom(),
required("ControlPanelName") => String.t() | atom()
}
"""
@type create_control_panel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_control_panel_request() :: %{}
"""
@type describe_control_panel_request() :: %{}
@typedoc """
## Example:
routing_control() :: %{
"ControlPanelArn" => String.t() | atom(),
"Name" => String.t() | atom(),
"Owner" => String.t() | atom(),
"RoutingControlArn" => String.t() | atom(),
"Status" => list(any())
}
"""
@type routing_control() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_safety_rule_request() :: %{
optional("AssertionRuleUpdate") => assertion_rule_update(),
optional("GatingRuleUpdate") => gating_rule_update()
}
"""
@type update_safety_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_safety_rule_request() :: %{}
"""
@type describe_safety_rule_request() :: %{}
@typedoc """
## Example:
create_safety_rule_request() :: %{
optional("AssertionRule") => new_assertion_rule(),
optional("ClientToken") => String.t() | atom(),
optional("GatingRule") => new_gating_rule(),
optional("Tags") => map()
}
"""
@type create_safety_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"Tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_routing_controls_response() :: %{
"NextToken" => String.t() | atom(),
"RoutingControls" => list(routing_control())
}
"""
@type list_routing_controls_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_clusters_response() :: %{
"Clusters" => list(cluster()),
"NextToken" => String.t() | atom()
}
"""
@type list_clusters_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_policy_request() :: %{}
"""
@type get_resource_policy_request() :: %{}
@typedoc """
## Example:
delete_cluster_response() :: %{}
"""
@type delete_cluster_response() :: %{}
@typedoc """
## Example:
update_routing_control_response() :: %{
"RoutingControl" => routing_control()
}
"""
@type update_routing_control_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule() :: %{
"ASSERTION" => assertion_rule(),
"GATING" => gating_rule()
}
"""
@type rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_config() :: %{
"Inverted" => boolean(),
"Threshold" => integer(),
"Type" => list(any())
}
"""
@type rule_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_safety_rule_request() :: %{}
"""
@type delete_safety_rule_request() :: %{}
@typedoc """
## Example:
list_clusters_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_clusters_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_associated_route53_health_checks_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_associated_route53_health_checks_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
new_gating_rule() :: %{
"ControlPanelArn" => String.t() | atom(),
"GatingControls" => list(String.t() | atom()),
"Name" => String.t() | atom(),
"RuleConfig" => rule_config(),
"TargetControls" => list(String.t() | atom()),
"WaitPeriodMs" => integer()
}
"""
@type new_gating_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
assertion_rule() :: %{
"AssertedControls" => list(String.t() | atom()),
"ControlPanelArn" => String.t() | atom(),
"Name" => String.t() | atom(),
"Owner" => String.t() | atom(),
"RuleConfig" => rule_config(),
"SafetyRuleArn" => String.t() | atom(),
"Status" => list(any()),
"WaitPeriodMs" => integer()
}
"""
@type assertion_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
new_assertion_rule() :: %{
"AssertedControls" => list(String.t() | atom()),
"ControlPanelArn" => String.t() | atom(),
"Name" => String.t() | atom(),
"RuleConfig" => rule_config(),
"WaitPeriodMs" => integer()
}
"""
@type new_assertion_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_cluster_request() :: %{}
"""
@type delete_cluster_request() :: %{}
@typedoc """
## Example:
control_panel() :: %{
"ClusterArn" => String.t() | atom(),
"ControlPanelArn" => String.t() | atom(),
"DefaultControlPanel" => boolean(),
"Name" => String.t() | atom(),
"Owner" => String.t() | atom(),
"RoutingControlCount" => integer(),
"Status" => list(any())
}
"""
@type control_panel() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_control_panel_request() :: %{}
"""
@type delete_control_panel_request() :: %{}
@typedoc """
## Example:
update_safety_rule_response() :: %{
"AssertionRule" => assertion_rule(),
"GatingRule" => gating_rule()
}
"""
@type update_safety_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
list_associated_route53_health_checks_response() :: %{
"HealthCheckIds" => list(String.t() | atom()),
"NextToken" => String.t() | atom()
}
"""
@type list_associated_route53_health_checks_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_control_panel_response() :: %{
"ControlPanel" => control_panel()
}
"""
@type create_control_panel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
list_safety_rules_response() :: %{
"NextToken" => String.t() | atom(),
"SafetyRules" => list(rule())
}
"""
@type list_safety_rules_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_safety_rules_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_safety_rules_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_control_panels_request() :: %{
optional("ClusterArn") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom()
}
"""
@type list_control_panels_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_routing_control_request() :: %{}
"""
@type describe_routing_control_request() :: %{}
@typedoc """
## Example:
create_safety_rule_response() :: %{
"AssertionRule" => assertion_rule(),
"GatingRule" => gating_rule()
}
"""
@type create_safety_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_cluster_response() :: %{
"Cluster" => cluster()
}
"""
@type update_cluster_response() :: %{(String.t() | atom()) => any()}
@type create_cluster_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_control_panel_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_routing_control_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_safety_rule_errors() :: validation_exception() | internal_server_exception()
@type delete_cluster_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_control_panel_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_routing_control_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_safety_rule_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type describe_cluster_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type describe_control_panel_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type describe_routing_control_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type describe_safety_rule_errors() :: validation_exception() | resource_not_found_exception()
@type get_resource_policy_errors() ::
internal_server_exception() | resource_not_found_exception()
@type list_associated_route53_health_checks_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type list_clusters_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_control_panels_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_routing_controls_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_safety_rules_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_tags_for_resource_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type tag_resource_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type untag_resource_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type update_cluster_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_control_panel_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_routing_control_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_safety_rule_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
def metadata do
%{
api_version: "2020-11-02",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "route53-recovery-control-config",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Route53 Recovery Control Config",
signature_version: "v4",
signing_name: "route53-recovery-control-config",
target_prefix: nil
}
end
@doc """
Create a new cluster.
A cluster is a set of redundant Regional endpoints against which you can run API
calls to update or get the state of one or more routing controls. Each cluster
has a name, status, Amazon Resource Name (ARN), and an array of the five cluster
endpoints (one for each supported Amazon Web Services Region) that you can use
with API calls to the cluster data plane.
"""
@spec create_cluster(map(), create_cluster_request(), list()) ::
{:ok, create_cluster_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_cluster_errors()}
def create_cluster(%Client{} = client, input, options \\ []) do
url_path = "/cluster"
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 """
Creates a new control panel.
A control panel represents a group of routing controls that can be changed
together in a single transaction. You can use a control panel to centrally view
the operational status of applications across your organization, and trigger
multi-app failovers in a single transaction, for example, to fail over an
Availability Zone or Amazon Web Services Region.
"""
@spec create_control_panel(map(), create_control_panel_request(), list()) ::
{:ok, create_control_panel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_control_panel_errors()}
def create_control_panel(%Client{} = client, input, options \\ []) do
url_path = "/controlpanel"
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 """
Creates a new routing control.
A routing control has one of two states: ON and OFF. You can map the routing
control state to the state of an Amazon Route 53 health check, which can be used
to control traffic routing.
To get or update the routing control state, see the Recovery Cluster (data
plane) API actions for Amazon Route 53 Application Recovery Controller.
"""
@spec create_routing_control(map(), create_routing_control_request(), list()) ::
{:ok, create_routing_control_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_routing_control_errors()}
def create_routing_control(%Client{} = client, input, options \\ []) do
url_path = "/routingcontrol"
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 """
Creates a safety rule in a control panel.
Safety rules let you add safeguards around changing routing control states, and
for enabling and disabling routing controls, to help prevent unexpected
outcomes.
There are two types of safety rules: assertion rules and gating rules.
Assertion rule: An assertion rule enforces that, when you change a routing
control state, that a certain criteria is met. For example, the criteria might
be that at least one routing control state is On after the transaction so that
traffic continues to flow to at least one cell for the application. This ensures
that you avoid a fail-open scenario.
Gating rule: A gating rule lets you configure a gating routing control as an
overall "on/off" switch for a group of routing controls. Or, you can configure
more complex gating scenarios, for example by configuring multiple gating
routing controls.
For more information, see [Safety rules](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html)
in the Amazon Route 53 Application Recovery Controller Developer Guide.
"""
@spec create_safety_rule(map(), create_safety_rule_request(), list()) ::
{:ok, create_safety_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_safety_rule_errors()}
def create_safety_rule(%Client{} = client, input, options \\ []) do
url_path = "/safetyrule"
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 """
Delete a cluster.
"""
@spec delete_cluster(map(), String.t() | atom(), delete_cluster_request(), list()) ::
{:ok, delete_cluster_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_cluster_errors()}
def delete_cluster(%Client{} = client, cluster_arn, input, options \\ []) do
url_path = "/cluster/#{AWS.Util.encode_uri(cluster_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a control panel.
"""
@spec delete_control_panel(map(), String.t() | atom(), delete_control_panel_request(), list()) ::
{:ok, delete_control_panel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_control_panel_errors()}
def delete_control_panel(%Client{} = client, control_panel_arn, input, options \\ []) do
url_path = "/controlpanel/#{AWS.Util.encode_uri(control_panel_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a routing control.
"""
@spec delete_routing_control(
map(),
String.t() | atom(),
delete_routing_control_request(),
list()
) ::
{:ok, delete_routing_control_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_routing_control_errors()}
def delete_routing_control(%Client{} = client, routing_control_arn, input, options \\ []) do
url_path = "/routingcontrol/#{AWS.Util.encode_uri(routing_control_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a safety rule.
/>
"""
@spec delete_safety_rule(map(), String.t() | atom(), delete_safety_rule_request(), list()) ::
{:ok, delete_safety_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_safety_rule_errors()}
def delete_safety_rule(%Client{} = client, safety_rule_arn, input, options \\ []) do
url_path = "/safetyrule/#{AWS.Util.encode_uri(safety_rule_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Display the details about a cluster.
The response includes the cluster name, endpoints, status, and Amazon Resource
Name (ARN).
"""
@spec describe_cluster(map(), String.t() | atom(), list()) ::
{:ok, describe_cluster_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_cluster_errors()}
def describe_cluster(%Client{} = client, cluster_arn, options \\ []) do
url_path = "/cluster/#{AWS.Util.encode_uri(cluster_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays details about a control panel.
"""
@spec describe_control_panel(map(), String.t() | atom(), list()) ::
{:ok, describe_control_panel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_control_panel_errors()}
def describe_control_panel(%Client{} = client, control_panel_arn, options \\ []) do
url_path = "/controlpanel/#{AWS.Util.encode_uri(control_panel_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays details about a routing control.
A routing control has one of two states: ON and OFF. You can map the routing
control state to the state of an Amazon Route 53 health check, which can be used
to control routing.
To get or update the routing control state, see the Recovery Cluster (data
plane) API actions for Amazon Route 53 Application Recovery Controller.
"""
@spec describe_routing_control(map(), String.t() | atom(), list()) ::
{:ok, describe_routing_control_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_routing_control_errors()}
def describe_routing_control(%Client{} = client, routing_control_arn, options \\ []) do
url_path = "/routingcontrol/#{AWS.Util.encode_uri(routing_control_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns information about a safety rule.
"""
@spec describe_safety_rule(map(), String.t() | atom(), list()) ::
{:ok, describe_safety_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_safety_rule_errors()}
def describe_safety_rule(%Client{} = client, safety_rule_arn, options \\ []) do
url_path = "/safetyrule/#{AWS.Util.encode_uri(safety_rule_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get information about the resource policy for a cluster.
"""
@spec get_resource_policy(map(), String.t() | atom(), list()) ::
{:ok, get_resource_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_policy_errors()}
def get_resource_policy(%Client{} = client, resource_arn, options \\ []) do
url_path = "/resourcePolicy/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an array of all Amazon Route 53 health checks associated with a specific
routing control.
"""
@spec list_associated_route53_health_checks(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_associated_route53_health_checks_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_associated_route53_health_checks_errors()}
def list_associated_route53_health_checks(
%Client{} = client,
routing_control_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/routingcontrol/#{AWS.Util.encode_uri(routing_control_arn)}/associatedRoute53HealthChecks"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an array of all the clusters in an account.
"""
@spec list_clusters(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_clusters_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_clusters_errors()}
def list_clusters(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/cluster"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an array of control panels in an account or in a cluster.
"""
@spec list_control_panels(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_control_panels_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_control_panels_errors()}
def list_control_panels(
%Client{} = client,
cluster_arn \\ nil,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/controlpanels"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(cluster_arn) do
[{"ClusterArn", cluster_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an array of routing controls for a control panel.
A routing control is an Amazon Route 53 Application Recovery Controller
construct that has one of two states: ON and OFF. You can map the routing
control state to the state of an Amazon Route 53 health check, which can be used
to control routing.
"""
@spec list_routing_controls(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_routing_controls_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_routing_controls_errors()}
def list_routing_controls(
%Client{} = client,
control_panel_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/controlpanel/#{AWS.Util.encode_uri(control_panel_arn)}/routingcontrols"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List the safety rules (the assertion rules and gating rules) that you've defined
for the routing controls in a control panel.
"""
@spec list_safety_rules(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_safety_rules_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_safety_rules_errors()}
def list_safety_rules(
%Client{} = client,
control_panel_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/controlpanel/#{AWS.Util.encode_uri(control_panel_arn)}/safetyrules"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the tags for a resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Adds a tag to a resource.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
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 """
Removes a tag from a resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"TagKeys", "TagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing cluster.
You can only update the network type of a cluster.
"""
@spec update_cluster(map(), update_cluster_request(), list()) ::
{:ok, update_cluster_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_cluster_errors()}
def update_cluster(%Client{} = client, input, options \\ []) do
url_path = "/cluster"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a control panel.
The only update you can make to a control panel is to change the name of the
control panel.
"""
@spec update_control_panel(map(), update_control_panel_request(), list()) ::
{:ok, update_control_panel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_control_panel_errors()}
def update_control_panel(%Client{} = client, input, options \\ []) do
url_path = "/controlpanel"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a routing control.
You can only update the name of the routing control. To get or update the
routing control state, see the Recovery Cluster (data plane) API actions for
Amazon Route 53 Application Recovery Controller.
"""
@spec update_routing_control(map(), update_routing_control_request(), list()) ::
{:ok, update_routing_control_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_routing_control_errors()}
def update_routing_control(%Client{} = client, input, options \\ []) do
url_path = "/routingcontrol"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update a safety rule (an assertion rule or gating rule).
You can only update the name and the waiting period for a safety rule. To make
other updates, delete the safety rule and create a new one.
"""
@spec update_safety_rule(map(), update_safety_rule_request(), list()) ::
{:ok, update_safety_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_safety_rule_errors()}
def update_safety_rule(%Client{} = client, input, options \\ []) do
url_path = "/safetyrule"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
