{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.route53recoverycluster#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.route53recoverycluster#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9:.\\/_-]*$" } }, "com.amazonaws.route53recoverycluster#Arns": { "type": "list", "member": { "target": "com.amazonaws.route53recoverycluster#Arn" } }, "com.amazonaws.route53recoverycluster#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "Description of the ConflictException error", "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "Identifier of the resource in use", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "Type of the resource in use", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There was a conflict with this request. Try again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.route53recoverycluster#ControlPanelName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.route53recoverycluster#EndpointTemporarilyUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.route53recoverycluster#GetRoutingControlState": { "type": "operation", "input": { "target": "com.amazonaws.route53recoverycluster#GetRoutingControlStateRequest" }, "output": { "target": "com.amazonaws.route53recoverycluster#GetRoutingControlStateResponse" }, "errors": [ { "target": "com.amazonaws.route53recoverycluster#AccessDeniedException" }, { "target": "com.amazonaws.route53recoverycluster#EndpointTemporarilyUnavailableException" }, { "target": "com.amazonaws.route53recoverycluster#InternalServerException" }, { "target": "com.amazonaws.route53recoverycluster#ResourceNotFoundException" }, { "target": "com.amazonaws.route53recoverycluster#ThrottlingException" }, { "target": "com.amazonaws.route53recoverycluster#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the state for a routing control. A routing control is a simple on/off switch that you\n\t\t\t\tcan use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\t\tthe state is set to OFF, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

Learn more about working with routing controls in the following topics in the \n\t\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n " } }, "com.amazonaws.route53recoverycluster#GetRoutingControlStateRequest": { "type": "structure", "members": { "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.route53recoverycluster#GetRoutingControlStateResponse": { "type": "structure", "members": { "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the response.

", "smithy.api#required": {} } }, "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { "smithy.api#documentation": "

The state of the routing control.

", "smithy.api#required": {} } }, "RoutingControlName": { "target": "com.amazonaws.route53recoverycluster#RoutingControlName", "traits": { "smithy.api#documentation": "

The routing control name.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.route53recoverycluster#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "com.amazonaws.route53recoverycluster#RetryAfterSeconds", "traits": { "smithy.api#default": 0, "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

There was an unexpected error during processing of the request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.route53recoverycluster#ListRoutingControls": { "type": "operation", "input": { "target": "com.amazonaws.route53recoverycluster#ListRoutingControlsRequest" }, "output": { "target": "com.amazonaws.route53recoverycluster#ListRoutingControlsResponse" }, "errors": [ { "target": "com.amazonaws.route53recoverycluster#AccessDeniedException" }, { "target": "com.amazonaws.route53recoverycluster#EndpointTemporarilyUnavailableException" }, { "target": "com.amazonaws.route53recoverycluster#InternalServerException" }, { "target": "com.amazonaws.route53recoverycluster#ResourceNotFoundException" }, { "target": "com.amazonaws.route53recoverycluster#ThrottlingException" }, { "target": "com.amazonaws.route53recoverycluster#ValidationException" } ], "traits": { "smithy.api#documentation": "

List routing control names and Amazon Resource Names (ARNs), as well as the routing control \n\t\t\tstate for each routing control, along with the control panel name and control panel ARN for the routing controls.\n\t\t\tIf you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists\n\t\t\tall the routing controls in the cluster.

\n

A routing control is a simple on/off switch in Route 53 ARC that you\n\t\t\tcan use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\tthe state is set to OFF, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\tto use this API operation to list routing controls in Route 53 ARC.\n

\n

Learn more about working with routing controls in the following topics in the \n\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RoutingControls", "pageSize": "MaxResults" } } }, "com.amazonaws.route53recoverycluster#ListRoutingControlsRequest": { "type": "structure", "members": { "ControlPanelArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

" } }, "NextToken": { "target": "com.amazonaws.route53recoverycluster#PageToken", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.route53recoverycluster#MaxResults", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.route53recoverycluster#ListRoutingControlsResponse": { "type": "structure", "members": { "RoutingControls": { "target": "com.amazonaws.route53recoverycluster#RoutingControls", "traits": { "smithy.api#documentation": "

The list of routing controls.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.route53recoverycluster#PageToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.route53recoverycluster#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.route53recoverycluster#Owner": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 1024 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.route53recoverycluster#PageToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8096 }, "smithy.api#pattern": "^[\\S]*$" } }, "com.amazonaws.route53recoverycluster#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "Hypothetical resource identifier that was not found", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "Hypothetical resource type that was not found", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.route53recoverycluster#RetryAfterSeconds": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Advice to clients on when the call can be safely retried" } }, "com.amazonaws.route53recoverycluster#RoutingControl": { "type": "structure", "members": { "ControlPanelArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

" } }, "ControlPanelName": { "target": "com.amazonaws.route53recoverycluster#ControlPanelName", "traits": { "smithy.api#documentation": "

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

" } }, "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

" } }, "RoutingControlName": { "target": "com.amazonaws.route53recoverycluster#RoutingControlName", "traits": { "smithy.api#documentation": "

The name of the routing control.

" } }, "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { "smithy.api#documentation": "

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

" } }, "Owner": { "target": "com.amazonaws.route53recoverycluster#Owner", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.route53recoverycluster#RoutingControlName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.route53recoverycluster#RoutingControlState": { "type": "enum", "members": { "On": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "On" } }, "Off": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Off" } } } }, "com.amazonaws.route53recoverycluster#RoutingControls": { "type": "list", "member": { "target": "com.amazonaws.route53recoverycluster#RoutingControl" } }, "com.amazonaws.route53recoverycluster#ServiceLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

The resource identifier of the limit that was exceeded.

" } }, "resourceType": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

The resource type of the limit that was exceeded.

" } }, "limitCode": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

The code of the limit that was exceeded.

", "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

The service code of the limit that was exceeded.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.route53recoverycluster#String": { "type": "string" }, "com.amazonaws.route53recoverycluster#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "com.amazonaws.route53recoverycluster#RetryAfterSeconds", "traits": { "smithy.api#default": 0, "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

The request was denied because of request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.route53recoverycluster#ToggleCustomerAPI": { "type": "service", "version": "2019-12-02", "operations": [ { "target": "com.amazonaws.route53recoverycluster#GetRoutingControlState" }, { "target": "com.amazonaws.route53recoverycluster#ListRoutingControls" }, { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlState" }, { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStates" } ], "traits": { "aws.api#service": { "sdkId": "Route53 Recovery Cluster", "arnNamespace": "route53-recovery-cluster", "cloudFormationName": "Route53RecoveryCluster", "cloudTrailEventSource": "route53recoverycluster.amazonaws.com", "endpointPrefix": "route53-recovery-cluster" }, "aws.auth#sigv4": { "name": "route53-recovery-cluster" }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

\n ", "smithy.api#title": "Route53 Recovery Cluster", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://route53-recovery-cluster.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://route53-recovery-cluster.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlState": { "type": "operation", "input": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateRequest" }, "output": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateResponse" }, "errors": [ { "target": "com.amazonaws.route53recoverycluster#AccessDeniedException" }, { "target": "com.amazonaws.route53recoverycluster#ConflictException" }, { "target": "com.amazonaws.route53recoverycluster#EndpointTemporarilyUnavailableException" }, { "target": "com.amazonaws.route53recoverycluster#InternalServerException" }, { "target": "com.amazonaws.route53recoverycluster#ResourceNotFoundException" }, { "target": "com.amazonaws.route53recoverycluster#ThrottlingException" }, { "target": "com.amazonaws.route53recoverycluster#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntries": { "type": "list", "member": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntry" } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntry": { "type": "structure", "members": { "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A routing control state entry.

" } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateRequest": { "type": "structure", "members": { "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "SafetyRulesToOverride": { "target": "com.amazonaws.route53recoverycluster#Arns", "traits": { "smithy.api#documentation": "

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

\n

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStates": { "type": "operation", "input": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesRequest" }, "output": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesResponse" }, "errors": [ { "target": "com.amazonaws.route53recoverycluster#AccessDeniedException" }, { "target": "com.amazonaws.route53recoverycluster#ConflictException" }, { "target": "com.amazonaws.route53recoverycluster#EndpointTemporarilyUnavailableException" }, { "target": "com.amazonaws.route53recoverycluster#InternalServerException" }, { "target": "com.amazonaws.route53recoverycluster#ResourceNotFoundException" }, { "target": "com.amazonaws.route53recoverycluster#ServiceLimitExceededException" }, { "target": "com.amazonaws.route53recoverycluster#ThrottlingException" }, { "target": "com.amazonaws.route53recoverycluster#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesRequest": { "type": "structure", "members": { "UpdateRoutingControlStateEntries": { "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntries", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "SafetyRulesToOverride": { "target": "com.amazonaws.route53recoverycluster#Arns", "traits": { "smithy.api#documentation": "

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

\n

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.route53recoverycluster#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.route53recoverycluster#ValidationExceptionReason" }, "fields": { "target": "com.amazonaws.route53recoverycluster#ValidationExceptionFieldList" } }, "traits": { "smithy.api#documentation": "

There was a validation error on the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.route53recoverycluster#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

The field that had the validation exception.

", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.route53recoverycluster#String", "traits": { "smithy.api#documentation": "

Information about the validation exception.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There was a validation error on the request.

" } }, "com.amazonaws.route53recoverycluster#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.route53recoverycluster#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "The fields that caused the error, if applicable" } }, "com.amazonaws.route53recoverycluster#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } } }, "traits": { "smithy.api#documentation": "Reason the request failed validation" } } } }