Table of Contents
A low-level client representing AWS Route53 Recovery Control Config
Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
import boto3
client = boto3.client('route53-recovery-control-config')
These are the available methods:
Check if an operation can be paginated.
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 Amazon Route 53 Application Recovery Controller cluster data plane.
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
ClientToken='string',
ClusterName='string'
)
Unique client idempotency token.
This field is autopopulated if not provided.
[REQUIRED]
The name of the cluster.
dict
Response Syntax
{
'Cluster': {
'ClusterArn': 'string',
'ClusterEndpoints': [
{
'Endpoint': 'string',
'Region': 'string'
},
],
'Name': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
(dict) --
200 response - Success.
Cluster (dict) --
The cluster that was created.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
ClusterEndpoints (list) --
Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
(dict) --
A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
Endpoint (string) --
A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
Region (string) --
The Amazon Web Services Region for a cluster endpoint.
Name (string) --
The name of the cluster.
Status (string) --
Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
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 AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.create_control_panel(
ClientToken='string',
ClusterArn='string',
ControlPanelName='string'
)
Unique client idempotency token.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster for the control panel.
[REQUIRED]
The name of the control panel.
dict
Response Syntax
{
'ControlPanel': {
'ClusterArn': 'string',
'ControlPanelArn': 'string',
'DefaultControlPanel': True|False,
'Name': 'string',
'RoutingControlCount': 123,
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
(dict) --
200 response - Success.
ControlPanel (dict) --
Information about a control panel.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
DefaultControlPanel (boolean) --
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
Name (string) --
The name of the control panel. You can use any non-white space character in the name.
RoutingControlCount (integer) --
The number of routing controls in the control panel.
Status (string) --
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.create_routing_control(
ClientToken='string',
ClusterArn='string',
ControlPanelArn='string',
RoutingControlName='string'
)
Unique client idempotency token.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster that includes the routing control.
[REQUIRED]
The name of the routing control.
dict
Response Syntax
{
'RoutingControl': {
'ControlPanelArn': 'string',
'Name': 'string',
'RoutingControlArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
(dict) --
200 response - Success.
RoutingControl (dict) --
The routing control that is created.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
Name (string) --
The name of the routing control.
RoutingControlArn (string) --
The Amazon Resource Name (ARN) of the routing control.
Status (string) --
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
Creates a safety rule in a control panel. Safety rules let you add safeguards around 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 a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
Gating rule: A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
See also: AWS API Documentation
Request Syntax
response = client.create_safety_rule(
AssertionRule={
'AssertedControls': [
'string',
],
'ControlPanelArn': 'string',
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'WaitPeriodMs': 123
},
ClientToken='string',
GatingRule={
'ControlPanelArn': 'string',
'GatingControls': [
'string',
],
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'TargetControls': [
'string',
],
'WaitPeriodMs': 123
}
)
A new assertion rule for a control panel.
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
The Amazon Resource Name (ARN) for the control panel.
The name of the assertion rule. You can use any non-white space character in the name.
The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
A rule can be one of the following: ATLEAST, AND, or OR.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Unique client idempotency token.
This field is autopopulated if not provided.
A new gating rule for a control panel.
The Amazon Resource Name (ARN) of the control panel.
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
The name for the new gating rule.
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
A rule can be one of the following: ATLEAST, AND, or OR.
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
dict
Response Syntax
{
'AssertionRule': {
'AssertedControls': [
'string',
],
'ControlPanelArn': 'string',
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'WaitPeriodMs': 123
},
'GatingRule': {
'ControlPanelArn': 'string',
'GatingControls': [
'string',
],
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'TargetControls': [
'string',
],
'WaitPeriodMs': 123
}
}
Response Structure
(dict) --
200 response - Success.
AssertionRule (dict) --
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
AssertedControls (list) --
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
Name (string) --
Name of the assertion rule. You can use any non-white space character in the name.
RuleConfig (dict) --
The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the assertion rule.
Status (string) --
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
GatingRule (dict) --
A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
GatingControls (list) --
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
Name (string) --
The name for the gating rule.
RuleConfig (dict) --
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the gating rule.
Status (string) --
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
TargetControls (list) --
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Exceptions
Delete a cluster.
See also: AWS API Documentation
Request Syntax
response = client.delete_cluster(
ClusterArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster that you're deleting.
{}
Response Structure
200 response - Success.
Exceptions
Deletes a control panel.
See also: AWS API Documentation
Request Syntax
response = client.delete_control_panel(
ControlPanelArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're deleting.
{}
Response Structure
200 response - Success.
Exceptions
Deletes a routing control.
See also: AWS API Documentation
Request Syntax
response = client.delete_routing_control(
RoutingControlArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control that you're deleting.
{}
Response Structure
200 response - Success.
Exceptions
Deletes a safety rule.
/>
See also: AWS API Documentation
Request Syntax
response = client.delete_safety_rule(
SafetyRuleArn='string'
)
[REQUIRED]
The request body that you include when you update a safety rule.
{}
Response Structure
200 response - Success.
Exceptions
Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.describe_cluster(
ClusterArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster that you're getting details for.
{
'Cluster': {
'ClusterArn': 'string',
'ClusterEndpoints': [
{
'Endpoint': 'string',
'Region': 'string'
},
],
'Name': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
200 response - Success.
The cluster for the DescribeCluster request.
The Amazon Resource Name (ARN) of the cluster.
Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
The Amazon Web Services Region for a cluster endpoint.
The name of the cluster.
Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
Displays details about a control panel.
See also: AWS API Documentation
Request Syntax
response = client.describe_control_panel(
ControlPanelArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're getting details for.
{
'ControlPanel': {
'ClusterArn': 'string',
'ControlPanelArn': 'string',
'DefaultControlPanel': True|False,
'Name': 'string',
'RoutingControlCount': 123,
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
200 response - Success.
Information about the control panel.
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
The Amazon Resource Name (ARN) of the control panel.
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
The name of the control panel. You can use any non-white space character in the name.
The number of routing controls in the control panel.
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_routing_control(
RoutingControlArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control that you're getting details for.
{
'RoutingControl': {
'ControlPanelArn': 'string',
'Name': 'string',
'RoutingControlArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
200 response - Success.
Information about the routing control.
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
The name of the routing control.
The Amazon Resource Name (ARN) of the routing control.
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.
See also: AWS API Documentation
Request Syntax
response = client.describe_safety_rule(
SafetyRuleArn='string'
)
[REQUIRED]
The request body that you include when you update a safety rule.
{
'AssertionRule': {
'AssertedControls': [
'string',
],
'ControlPanelArn': 'string',
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'WaitPeriodMs': 123
},
'GatingRule': {
'ControlPanelArn': 'string',
'GatingControls': [
'string',
],
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'TargetControls': [
'string',
],
'WaitPeriodMs': 123
}
}
Response Structure
200 response - Success.
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
The Amazon Resource Name (ARN) of the control panel.
Name of the assertion rule. You can use any non-white space character in the name.
The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
A rule can be one of the following: ATLEAST, AND, or OR.
The Amazon Resource Name (ARN) of the assertion rule.
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
The Amazon Resource Name (ARN) of the control panel.
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
The name for the gating rule.
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
A rule can be one of the following: ATLEAST, AND, or OR.
The Amazon Resource Name (ARN) of the gating rule.
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
See also: AWS API Documentation
Request Syntax
response = client.list_associated_route53_health_checks(
MaxResults=123,
NextToken='string',
RoutingControlArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control that you're getting details for.
dict
Response Syntax
{
'HealthCheckIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response - Success.
HealthCheckIds (list) --
Identifiers for the health checks.
NextToken (string) --
The token that identifies which batch of results you want to see.
Exceptions
Returns an array of all the clusters in an account.
See also: AWS API Documentation
Request Syntax
response = client.list_clusters(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Clusters': [
{
'ClusterArn': 'string',
'ClusterEndpoints': [
{
'Endpoint': 'string',
'Region': 'string'
},
],
'Name': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response - Success.
Clusters (list) --
An array of the clusters in an account.
(dict) --
A cluster is a set of five consensus-forming Regional endpoints that represent the infrastructure that hosts your routing controls. Typically, you host together on one cluster all of the routing controls for your applications.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
ClusterEndpoints (list) --
Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
(dict) --
A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
Endpoint (string) --
A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
Region (string) --
The Amazon Web Services Region for a cluster endpoint.
Name (string) --
The name of the cluster.
Status (string) --
Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
NextToken (string) --
The token that identifies which batch of results you want to see.
Exceptions
Returns an array of control panels for a cluster.
See also: AWS API Documentation
Request Syntax
response = client.list_control_panels(
ClusterArn='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ControlPanels': [
{
'ClusterArn': 'string',
'ControlPanelArn': 'string',
'DefaultControlPanel': True|False,
'Name': 'string',
'RoutingControlCount': 123,
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response - Success.
ControlPanels (list) --
The result of a successful ListControlPanel request.
(dict) --
A control panel represents a group of routing controls that can be changed together in a single transaction.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
DefaultControlPanel (boolean) --
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
Name (string) --
The name of the control panel. You can use any non-white space character in the name.
RoutingControlCount (integer) --
The number of routing controls in the control panel.
Status (string) --
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
NextToken (string) --
The token that identifies which batch of results you want to see.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_routing_controls(
ControlPanelArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're getting routing control details for.
dict
Response Syntax
{
'NextToken': 'string',
'RoutingControls': [
{
'ControlPanelArn': 'string',
'Name': 'string',
'RoutingControlArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
},
]
}
Response Structure
(dict) --
200 response - Success.
NextToken (string) --
The token that identifies which batch of results you want to see.
RoutingControls (list) --
An array of routing controls.
(dict) --
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.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
Name (string) --
The name of the routing control.
RoutingControlArn (string) --
The Amazon Resource Name (ARN) of the routing control.
Status (string) --
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
See also: AWS API Documentation
Request Syntax
response = client.list_safety_rules(
ControlPanelArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're getting details for.
dict
Response Syntax
{
'NextToken': 'string',
'SafetyRules': [
{
'ASSERTION': {
'AssertedControls': [
'string',
],
'ControlPanelArn': 'string',
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'WaitPeriodMs': 123
},
'GATING': {
'ControlPanelArn': 'string',
'GatingControls': [
'string',
],
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'TargetControls': [
'string',
],
'WaitPeriodMs': 123
}
},
]
}
Response Structure
(dict) --
200 response - Success.
NextToken (string) --
The token that identifies which batch of results you want to see.
SafetyRules (list) --
The list of safety rules in a control panel.
(dict) --
A safety rule. A safety rule can be an assertion rule or a gating rule.
ASSERTION (dict) --
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
AssertedControls (list) --
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
Name (string) --
Name of the assertion rule. You can use any non-white space character in the name.
RuleConfig (dict) --
The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the assertion rule.
Status (string) --
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
GATING (dict) --
A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
GatingControls (list) --
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
Name (string) --
The name for the gating rule.
RuleConfig (dict) --
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the gating rule.
Status (string) --
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
TargetControls (list) --
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Exceptions
Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
See also: AWS API Documentation
Request Syntax
response = client.update_control_panel(
ControlPanelArn='string',
ControlPanelName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel.
[REQUIRED]
The name of the control panel.
dict
Response Syntax
{
'ControlPanel': {
'ClusterArn': 'string',
'ControlPanelArn': 'string',
'DefaultControlPanel': True|False,
'Name': 'string',
'RoutingControlCount': 123,
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
(dict) --
200 response - Success.
ControlPanel (dict) --
The control panel to update.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
DefaultControlPanel (boolean) --
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
Name (string) --
The name of the control panel. You can use any non-white space character in the name.
RoutingControlCount (integer) --
The number of routing controls in the control panel.
Status (string) --
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_routing_control(
RoutingControlArn='string',
RoutingControlName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control.
[REQUIRED]
The name of the routing control.
dict
Response Syntax
{
'RoutingControl': {
'ControlPanelArn': 'string',
'Name': 'string',
'RoutingControlArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
}
}
Response Structure
(dict) --
200 response - Success.
RoutingControl (dict) --
The routing control that was updated.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
Name (string) --
The name of the routing control.
RoutingControlArn (string) --
The Amazon Resource Name (ARN) of the routing control.
Status (string) --
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Exceptions
Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel. 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 safety rule.
See also: AWS API Documentation
Request Syntax
response = client.update_safety_rule(
AssertionRuleUpdate={
'Name': 'string',
'SafetyRuleArn': 'string',
'WaitPeriodMs': 123
},
GatingRuleUpdate={
'Name': 'string',
'SafetyRuleArn': 'string',
'WaitPeriodMs': 123
}
)
An update to an assertion rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
The name of the assertion rule. You can use any non-white space character in the name.
The Amazon Resource Name (ARN) of the assertion rule.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Update to a gating rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
The name for the gating rule.
The Amazon Resource Name (ARN) of the gating rule.
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
dict
Response Syntax
{
'AssertionRule': {
'AssertedControls': [
'string',
],
'ControlPanelArn': 'string',
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'WaitPeriodMs': 123
},
'GatingRule': {
'ControlPanelArn': 'string',
'GatingControls': [
'string',
],
'Name': 'string',
'RuleConfig': {
'Inverted': True|False,
'Threshold': 123,
'Type': 'ATLEAST'|'AND'|'OR'
},
'SafetyRuleArn': 'string',
'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
'TargetControls': [
'string',
],
'WaitPeriodMs': 123
}
}
Response Structure
(dict) --
200 response - Success.
AssertionRule (dict) --
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
AssertedControls (list) --
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
Name (string) --
Name of the assertion rule. You can use any non-white space character in the name.
RuleConfig (dict) --
The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the assertion rule.
Status (string) --
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
GatingRule (dict) --
A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
ControlPanelArn (string) --
The Amazon Resource Name (ARN) of the control panel.
GatingControls (list) --
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
Name (string) --
The name for the gating rule.
RuleConfig (dict) --
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
Inverted (boolean) --
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold (integer) --
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
Type (string) --
A rule can be one of the following: ATLEAST, AND, or OR.
SafetyRuleArn (string) --
The Amazon Resource Name (ARN) of the gating rule.
Status (string) --
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
TargetControls (list) --
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
WaitPeriodMs (integer) --
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Exceptions
The available paginators are:
The available waiters are:
waiter = client.get_waiter('cluster_created')
Polls Route53RecoveryControlConfig.Client.describe_cluster() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ClusterArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None
waiter = client.get_waiter('cluster_deleted')
Polls Route53RecoveryControlConfig.Client.describe_cluster() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ClusterArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None
waiter = client.get_waiter('control_panel_created')
Polls Route53RecoveryControlConfig.Client.describe_control_panel() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ControlPanelArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None
waiter = client.get_waiter('control_panel_deleted')
Polls Route53RecoveryControlConfig.Client.describe_control_panel() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ControlPanelArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the control panel that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None
waiter = client.get_waiter('routing_control_created')
Polls Route53RecoveryControlConfig.Client.describe_routing_control() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
RoutingControlArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None
waiter = client.get_waiter('routing_control_deleted')
Polls Route53RecoveryControlConfig.Client.describe_routing_control() every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
RoutingControlArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the routing control that you're getting details for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 26
None