Module Smaws_Client_Route53RecoveryCluster

Route53 Recovery Cluster client library built on EIO.

Types

type validation_exception_reason =
  1. | OTHER
  2. | FIELD_VALIDATION_FAILED
  3. | CANNOT_PARSE
  4. | UNKNOWN_OPERATION

Reason the request failed validation

type validation_exception_field = {
  1. message : string;
    (*

    Information about the validation exception.

    *)
  2. name : string;
    (*

    The field that had the validation exception.

    *)
}

There was a validation error on the request.

type validation_exception = {
  1. fields : validation_exception_field list option;
  2. reason : validation_exception_reason option;
  3. message : string;
}

There was a validation error on the request.

type update_routing_control_states_response = unit
type routing_control_state =
  1. | Off
  2. | On
type update_routing_control_state_entry = {
  1. routing_control_state : routing_control_state;
    (*

    The routing control state in a set of routing control state entries.

    *)
  2. routing_control_arn : string;
    (*

    The Amazon Resource Name (ARN) for a routing control state entry.

    *)
}

A routing control state entry.

type update_routing_control_states_request = {
  1. safety_rules_to_override : string list option;
    (*

    The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

    For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

    *)
  2. update_routing_control_state_entries : update_routing_control_state_entry list;
    (*

    A set of routing control entries that you want to update.

    *)
}
type throttling_exception = {
  1. retry_after_seconds : int option;
  2. message : string;
}

The request was denied because of request throttling.

type service_limit_exceeded_exception = {
  1. service_code : string;
    (*

    The service code of the limit that was exceeded.

    *)
  2. limit_code : string;
    (*

    The code of the limit that was exceeded.

    *)
  3. resource_type : string option;
    (*

    The resource type of the limit that was exceeded.

    *)
  4. resource_id : string option;
    (*

    The resource identifier of the limit that was exceeded.

    *)
  5. message : string;
}

The request can't update that many routing control states at the same time. Try again with fewer routing control states.

type resource_not_found_exception = {
  1. resource_type : string;
    (*

    Hypothetical resource type that was not found

    *)
  2. resource_id : string;
    (*

    Hypothetical resource identifier that was not found

    *)
  3. message : string;
}

The request references a routing control or control panel that was not found.

type internal_server_exception = {
  1. retry_after_seconds : int option;
  2. message : string;
}

There was an unexpected error during processing of the request.

type endpoint_temporarily_unavailable_exception = {
  1. message : string;
}

The cluster endpoint isn't available. Try another cluster endpoint.

type conflict_exception = {
  1. resource_type : string;
    (*

    Type of the resource in use

    *)
  2. resource_id : string;
    (*

    Identifier of the resource in use

    *)
  3. message : string;
    (*

    Description of the ConflictException error

    *)
}

There was a conflict with this request. Try again.

type access_denied_exception = {
  1. message : string;
}

You don't have sufficient permissions to perform this action.

type update_routing_control_state_response = unit
type update_routing_control_state_request = {
  1. safety_rules_to_override : string list option;
    (*

    The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

    For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

    *)
  2. routing_control_state : routing_control_state;
    (*

    The state of the routing control. You can set the value to ON or OFF.

    *)
  3. routing_control_arn : string;
    (*

    The Amazon Resource Name (ARN) for the routing control that you want to update the state for.

    *)
}
type routing_control = {
  1. owner : string option;
    (*

    The Amazon Web Services account ID of the routing control owner.

    *)
  2. routing_control_state : routing_control_state option;
    (*

    The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.

    *)
  3. routing_control_name : string option;
    (*

    The name of the routing control.

    *)
  4. routing_control_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the routing control.

    *)
  5. control_panel_name : string option;
    (*

    The name of the control panel where the routing control is located. Only ASCII characters are supported for control panel names.

    *)
  6. control_panel_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the control panel where the routing control is located.

    *)
}

A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.

type list_routing_controls_response = {
  1. next_token : string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. routing_controls : routing_control list;
    (*

    The list of routing controls.

    *)
}
type list_routing_controls_request = {
  1. max_results : int option;
    (*

    The number of routing controls objects that you want to return with this call. The default value is 500.

    *)
  2. next_token : string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  3. control_panel_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

    *)
}
type get_routing_control_state_response = {
  1. routing_control_name : string option;
    (*

    The routing control name.

    *)
  2. routing_control_state : routing_control_state;
    (*

    The state of the routing control.

    *)
  3. routing_control_arn : string;
    (*

    The Amazon Resource Name (ARN) of the response.

    *)
}
type get_routing_control_state_request = {
  1. routing_control_arn : string;
    (*

    The Amazon Resource Name (ARN) for the routing control that you want to get the state for.

    *)
}

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

With Route 53 ARC, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.

Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations to get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region for Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands. For more information, see Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

This API guide includes information about the API operations for how to get and update routing control states in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control panels, and routing controls) using the recovery cluster configuration API.

For more information about working with routing control in Route 53 ARC, see the following:

type base_document = Smaws_Lib.Json.t

Builders

val make_validation_exception_field : message:string -> name:string -> unit -> validation_exception_field

Create a validation_exception_field type

val make_update_routing_control_states_response : unit -> update_routing_control_states_response

Create a update_routing_control_states_response type

val make_update_routing_control_state_entry : routing_control_state:routing_control_state -> routing_control_arn:string -> unit -> update_routing_control_state_entry

Create a update_routing_control_state_entry type

val make_update_routing_control_states_request : ?safety_rules_to_override:string list -> update_routing_control_state_entries:update_routing_control_state_entry list -> unit -> update_routing_control_states_request

Create a update_routing_control_states_request type

val make_update_routing_control_state_response : unit -> update_routing_control_state_response

Create a update_routing_control_state_response type

val make_update_routing_control_state_request : ?safety_rules_to_override:string list -> routing_control_state:routing_control_state -> routing_control_arn:string -> unit -> update_routing_control_state_request

Create a update_routing_control_state_request type

val make_routing_control : ?owner:string -> ?routing_control_state:routing_control_state -> ?routing_control_name:string -> ?routing_control_arn:string -> ?control_panel_name:string -> ?control_panel_arn:string -> unit -> routing_control

Create a routing_control type

val make_list_routing_controls_response : ?next_token:string -> routing_controls:routing_control list -> unit -> list_routing_controls_response

Create a list_routing_controls_response type

val make_list_routing_controls_request : ?max_results:int -> ?next_token:string -> ?control_panel_arn:string -> unit -> list_routing_controls_request

Create a list_routing_controls_request type

val make_get_routing_control_state_response : ?routing_control_name:string -> routing_control_state:routing_control_state -> routing_control_arn:string -> unit -> get_routing_control_state_response

Create a get_routing_control_state_response type

val make_get_routing_control_state_request : routing_control_arn:string -> unit -> get_routing_control_state_request

Create a get_routing_control_state_request type

Operations

module GetRoutingControlState : sig ... end
module ListRoutingControls : sig ... end
module UpdateRoutingControlState : sig ... end
module UpdateRoutingControlStates : sig ... end