Route53RecoveryControlConfig / Client / list_safety_rules

list_safety_rules#

Route53RecoveryControlConfig.Client.list_safety_rules(**kwargs)#

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'
)

Parameters:

ControlPanelArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the control panel.
MaxResults (integer) – The number of objects that you want to return with this call.
NextToken (string) – The token that identifies which batch of results you want to see.

Return type:

dict

Returns:

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 state is not accepted. 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.
      - 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.
        
        (string) –
      - 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 routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
        
        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 gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
      
      For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control “switch” to be “On”. When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
      - ControlPanelArn (string) –
        
        The Amazon Resource Name (ARN) of the control panel.
      - GatingControls (list) –
        
        An array of gating routing control Amazon Resource Names (ARNs). For a simple “on/off” switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
        
        (string) –
      - Name (string) –
        
        The name for the gating rule. You can use any non-white space character in the name.
      - RuleConfig (dict) –
        
        The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
        
        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) –
        
        An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall “on/off” switch for a set of target routing controls. You can use this to manually override automated failover, for example.
        
        (string) –
      - 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

Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException
Route53RecoveryControlConfig.Client.exceptions.ThrottlingException
Route53RecoveryControlConfig.Client.exceptions.ValidationException
Route53RecoveryControlConfig.Client.exceptions.InternalServerException
Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException