Module Smaws_Client_Route53RecoveryCluster

Route53 Recovery Cluster client library built on EIO.

Types

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

Reason the request failed validation

type nonrec 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 nonrec 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 nonrec routing_control_state =
  1. | Off
  2. | On
type nonrec 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 nonrec 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 nonrec throttling_exception = {
  1. retry_after_seconds : int option;
  2. message : string;
}

The request was denied because of request throttling.

type nonrec 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 nonrec 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 nonrec internal_server_exception = {
  1. retry_after_seconds : int option;
  2. message : string;
}

There was an unexpected error during processing of the request.

type nonrec endpoint_temporarily_unavailable_exception = {
  1. message : string;
}

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

type nonrec 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 nonrec access_denied_exception = {
  1. message : string;
}

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

type nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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.

    *)
}

Builders

val make_validation_exception_field : message:string -> name:string -> unit -> validation_exception_field
val make_update_routing_control_states_response : unit -> unit
val make_update_routing_control_state_entry : routing_control_state:routing_control_state -> routing_control_arn:string -> unit -> update_routing_control_state_entry
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
val make_update_routing_control_state_response : unit -> unit
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
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
val make_list_routing_controls_response : ?next_token:string -> routing_controls:routing_control list -> unit -> list_routing_controls_response
val make_list_routing_controls_request : ?max_results:int -> ?next_token:string -> ?control_panel_arn:string -> unit -> list_routing_controls_request
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
val make_get_routing_control_state_request : routing_control_arn:string -> unit -> get_routing_control_state_request

Operations

module GetRoutingControlState : sig ... end

Get the state for a routing control. A routing control 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.

module ListRoutingControls : sig ... end

List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.

module UpdateRoutingControlState : sig ... end

Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.

module UpdateRoutingControlStates : sig ... end

Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow.