Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
" }, "CreatePracticeRunConfiguration":{ "name":"CreatePracticeRunConfiguration", "http":{ "method":"POST", "requestUri":"/configuration", "responseCode":201 }, "input":{"shape":"CreatePracticeRunConfigurationRequest"}, "output":{"shape":"CreatePracticeRunConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "DeletePracticeRunConfiguration":{ "name":"DeletePracticeRunConfiguration", "http":{ "method":"DELETE", "requestUri":"/configuration/{resourceIdentifier}", "responseCode":200 }, "input":{"shape":"DeletePracticeRunConfigurationRequest"}, "output":{"shape":"DeletePracticeRunConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
", "idempotent":true }, "GetAutoshiftObserverNotificationStatus":{ "name":"GetAutoshiftObserverNotificationStatus", "http":{ "method":"GET", "requestUri":"/autoshift-observer-notification", "responseCode":200 }, "input":{"shape":"GetAutoshiftObserverNotificationStatusRequest"}, "output":{"shape":"GetAutoshiftObserverNotificationStatusResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "GetManagedResource":{ "name":"GetManagedResource", "http":{ "method":"GET", "requestUri":"/managedresources/{resourceIdentifier}", "responseCode":200 }, "input":{"shape":"GetManagedResourceRequest"}, "output":{"shape":"GetManagedResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" }, "ListAutoshifts":{ "name":"ListAutoshifts", "http":{ "method":"GET", "requestUri":"/autoshifts", "responseCode":200 }, "input":{"shape":"ListAutoshiftsRequest"}, "output":{"shape":"ListAutoshiftsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
" }, "ListZonalShifts":{ "name":"ListZonalShifts", "http":{ "method":"GET", "requestUri":"/zonalshifts", "responseCode":200 }, "input":{"shape":"ListZonalShiftsRequest"}, "output":{"shape":"ListZonalShiftsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see \">ListAutoshifts.
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "UpdateAutoshiftObserverNotificationStatus":{ "name":"UpdateAutoshiftObserverNotificationStatus", "http":{ "method":"PUT", "requestUri":"/autoshift-observer-notification", "responseCode":200 }, "input":{"shape":"UpdateAutoshiftObserverNotificationStatusRequest"}, "output":{"shape":"UpdateAutoshiftObserverNotificationStatusResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
", "idempotent":true }, "UpdatePracticeRunConfiguration":{ "name":"UpdatePracticeRunConfiguration", "http":{ "method":"PATCH", "requestUri":"/configuration/{resourceIdentifier}", "responseCode":200 }, "input":{"shape":"UpdatePracticeRunConfigurationRequest"}, "output":{"shape":"UpdatePracticeRunConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
" }, "UpdateZonalAutoshiftConfiguration":{ "name":"UpdateZonalAutoshiftConfiguration", "http":{ "method":"PUT", "requestUri":"/managedresources/{resourceIdentifier}", "responseCode":200 }, "input":{"shape":"UpdateZonalAutoshiftConfigurationRequest"}, "output":{"shape":"UpdateZonalAutoshiftConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.
You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AppliedStatus":{ "type":"string", "enum":[ "APPLIED", "NOT_APPLIED" ] }, "AppliedWeights":{ "type":"map", "key":{"shape":"AvailabilityZone"}, "value":{"shape":"Weight"} }, "AutoshiftAppliedStatus":{ "type":"string", "enum":[ "APPLIED", "NOT_APPLIED" ] }, "AutoshiftExecutionStatus":{ "type":"string", "enum":[ "ACTIVE", "COMPLETED" ] }, "AutoshiftInResource":{ "type":"structure", "required":[ "appliedStatus", "awayFrom", "startTime" ], "members":{ "appliedStatus":{ "shape":"AutoshiftAppliedStatus", "documentation":"The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
The time (UTC) when the autoshift started.
" } }, "documentation":"A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "AutoshiftObserverNotificationStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "AutoshiftSummaries":{ "type":"list", "member":{"shape":"AutoshiftSummary"} }, "AutoshiftSummary":{ "type":"structure", "required":[ "awayFrom", "endTime", "startTime", "status" ], "members":{ "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
The time (in UTC) when the autoshift ended.
" }, "startTime":{ "shape":"StartTime", "documentation":"The time (in UTC) when the autoshift started.
" }, "status":{ "shape":"AutoshiftExecutionStatus", "documentation":"The status for an autoshift.
" } }, "documentation":"Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.
Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.
You can stop an autoshift for a resource by disabling zonal autoshift.
" }, "AutoshiftsInResource":{ "type":"list", "member":{"shape":"AutoshiftInResource"} }, "AvailabilityZone":{ "type":"string", "max":20, "min":0 }, "AvailabilityZones":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "BlockedDate":{ "type":"string", "max":10, "min":10, "pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "BlockedDates":{ "type":"list", "member":{"shape":"BlockedDate"}, "max":15, "min":0 }, "BlockedWindow":{ "type":"string", "max":19, "min":19, "pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$" }, "BlockedWindows":{ "type":"list", "member":{"shape":"BlockedWindow"}, "max":15, "min":0 }, "CancelZonalShiftRequest":{ "type":"structure", "required":["zonalShiftId"], "members":{ "zonalShiftId":{ "shape":"ZonalShiftId", "documentation":"The internally-generated identifier of a zonal shift.
", "location":"uri", "locationName":"zonalShiftId" } } }, "ConflictException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ConflictExceptionReason", "documentation":"The reason for the conflict exception.
" }, "zonalShiftId":{ "shape":"String", "documentation":"The zonal shift ID associated with the conflict exception.
" } }, "documentation":"The request could not be processed because of conflict in the current state of the resource.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ConflictExceptionReason":{ "type":"string", "enum":[ "ZonalShiftAlreadyExists", "ZonalShiftStatusNotActive", "SimultaneousZonalShiftsConflict", "PracticeConfigurationAlreadyExists", "AutoShiftEnabled", "PracticeConfigurationDoesNotExist" ] }, "ControlCondition":{ "type":"structure", "required":[ "alarmIdentifier", "type" ], "members":{ "alarmIdentifier":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
" }, "type":{ "shape":"ControlConditionType", "documentation":"The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "ControlConditionType":{ "type":"string", "enum":["CLOUDWATCH"] }, "ControlConditions":{ "type":"list", "member":{"shape":"ControlCondition"}, "max":1, "min":1 }, "CreatePracticeRunConfigurationRequest":{ "type":"structure", "required":[ "outcomeAlarms", "resourceIdentifier" ], "members":{ "blockedDates":{ "shape":"BlockedDates", "documentation":"Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates.
The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.
The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.
Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.
The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" } } }, "CreatePracticeRunConfigurationResponse":{ "type":"structure", "required":[ "arn", "name", "practiceRunConfiguration", "zonalAutoshiftStatus" ], "members":{ "arn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource that you configured the practice run for.
" }, "name":{ "shape":"ResourceName", "documentation":"The name of the resource that you configured the practice run for.
" }, "practiceRunConfiguration":{ "shape":"PracticeRunConfiguration", "documentation":"A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.
" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The status for zonal autoshift for a resource. When you specify ENABLED for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.
When you enable zonal autoshift, you must also configure practice runs for the resource.
" } } }, "DeletePracticeRunConfigurationRequest":{ "type":"structure", "required":["resourceIdentifier"], "members":{ "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", "location":"uri", "locationName":"resourceIdentifier" } } }, "DeletePracticeRunConfigurationResponse":{ "type":"structure", "required":[ "arn", "name", "zonalAutoshiftStatus" ], "members":{ "arn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.
" }, "name":{ "shape":"ResourceName", "documentation":"The name of the resource that you deleted the practice run for.
" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The status of zonal autoshift for the resource.
" } } }, "ExpiresIn":{ "type":"string", "max":5, "min":2, "pattern":"^([1-9][0-9]*)(m|h)$" }, "ExpiryTime":{"type":"timestamp"}, "GetAutoshiftObserverNotificationStatusRequest":{ "type":"structure", "members":{ } }, "GetAutoshiftObserverNotificationStatusResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"AutoshiftObserverNotificationStatus", "documentation":"The status of autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
", "location":"uri", "locationName":"resourceIdentifier" } } }, "GetManagedResourceResponse":{ "type":"structure", "required":[ "appliedWeights", "zonalShifts" ], "members":{ "appliedWeights":{ "shape":"AppliedWeights", "documentation":"A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
" }, "arn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) for the resource.
" }, "autoshifts":{ "shape":"AutoshiftsInResource", "documentation":"An array of the autoshifts that are active for the resource.
" }, "name":{ "shape":"ResourceName", "documentation":"The name of the resource.
" }, "practiceRunConfiguration":{ "shape":"PracticeRunConfiguration", "documentation":"The practice run configuration for zonal autoshift that's associated with the resource.
" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
The zonal shifts that are currently active for a resource.
" } } }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"There was an internal server error.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ListAutoshiftsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The number of objects that you want to return with this call.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
The status of the autoshift.
", "location":"querystring", "locationName":"status" } } }, "ListAutoshiftsResponse":{ "type":"structure", "members":{ "items":{ "shape":"AutoshiftSummaries", "documentation":"The items in the response list.
" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
The number of objects that you want to return with this call.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
The items in the response list.
" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
The number of objects that you want to return with this call.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.
", "location":"querystring", "locationName":"resourceIdentifier" }, "status":{ "shape":"ZonalShiftStatus", "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The items in the response list.
" }, "nextToken":{ "shape":"String", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
" }, "arn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) for the managed resource.
" }, "autoshifts":{ "shape":"AutoshiftsInResource", "documentation":"An array of the autoshifts that have been completed for a resource.
" }, "availabilityZones":{ "shape":"AvailabilityZones", "documentation":"The Availability Zones that a resource is deployed in.
" }, "name":{ "shape":"ResourceName", "documentation":"The name of the managed resource.
" }, "practiceRunStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, Route 53 ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value to DISABLED.
Route 53 ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.
The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.
An array of the zonal shifts for a resource.
" } }, "documentation":"A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.
A managed resource is a load balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.
At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.
Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.
Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.
The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.
A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.
Practice runs are required for zonal autoshift. The zonal shifts that Route 53 ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.
" }, "PracticeRunOutcome":{ "type":"string", "enum":[ "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED" ] }, "ResourceArn":{ "type":"string", "max":1024, "min":8, "pattern":"^arn:.*$" }, "ResourceIdentifier":{ "type":"string", "max":1024, "min":8 }, "ResourceName":{ "type":"string", "max":256, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The input requested a resource that was not found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "StartTime":{"type":"timestamp"}, "StartZonalShiftRequest":{ "type":"structure", "required":[ "awayFrom", "comment", "expiresIn", "resourceIdentifier" ], "members":{ "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" }, "expiresIn":{ "shape":"ExpiresIn", "documentation":"The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.
For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" } } }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UpdateAutoshiftObserverNotificationStatusRequest":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"AutoshiftObserverNotificationStatus", "documentation":"The status to set for autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
The status for autoshift observer notification.
" } } }, "UpdatePracticeRunConfigurationRequest":{ "type":"structure", "required":["resourceIdentifier"], "members":{ "blockedDates":{ "shape":"BlockedDates", "documentation":"Add, change, or remove blocked dates for a practice run in zonal autoshift.
Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
" }, "outcomeAlarms":{ "shape":"ControlConditions", "documentation":"Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", "location":"uri", "locationName":"resourceIdentifier" } } }, "UpdatePracticeRunConfigurationResponse":{ "type":"structure", "required":[ "arn", "name", "practiceRunConfiguration", "zonalAutoshiftStatus" ], "members":{ "arn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
" }, "name":{ "shape":"ResourceName", "documentation":"The name of the resource that you updated the practice run for.
" }, "practiceRunConfiguration":{ "shape":"PracticeRunConfiguration", "documentation":"The practice run configuration that was updated.
" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The zonal autoshift status for the resource that you updated the practice run for.
" } } }, "UpdateZonalAutoshiftConfigurationRequest":{ "type":"structure", "required":[ "resourceIdentifier", "zonalAutoshiftStatus" ], "members":{ "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", "location":"uri", "locationName":"resourceIdentifier" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.
The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
" }, "zonalAutoshiftStatus":{ "shape":"ZonalAutoshiftStatus", "documentation":"The updated zonal autoshift status for the resource.
" } } }, "UpdateZonalShiftRequest":{ "type":"structure", "required":["zonalShiftId"], "members":{ "comment":{ "shape":"ZonalShiftComment", "documentation":"A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" }, "expiresIn":{ "shape":"ExpiresIn", "documentation":"The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.
For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
The identifier of a zonal shift.
", "location":"uri", "locationName":"zonalShiftId" } } }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason for the validation exception.
" } }, "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionReason":{ "type":"string", "enum":[ "InvalidExpiresIn", "InvalidStatus", "MissingValue", "InvalidToken", "InvalidResourceIdentifier", "InvalidAz", "UnsupportedAz", "InvalidAlarmCondition", "InvalidConditionType", "InvalidPracticeBlocker" ] }, "Weight":{ "type":"float", "box":true, "max":1.0, "min":0.0 }, "ZonalAutoshiftStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ZonalShift":{ "type":"structure", "required":[ "awayFrom", "comment", "expiryTime", "resourceIdentifier", "startTime", "status", "zonalShiftId" ], "members":{ "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" }, "expiryTime":{ "shape":"ExpiryTime", "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" }, "startTime":{ "shape":"StartTime", "documentation":"The time (UTC) when the zonal shift starts.
" }, "status":{ "shape":"ZonalShiftStatus", "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The identifier of a zonal shift.
" } } }, "ZonalShiftComment":{ "type":"string", "max":128, "min":0 }, "ZonalShiftId":{ "type":"string", "max":36, "min":6, "pattern":"^[A-Za-z0-9-]+$" }, "ZonalShiftInResource":{ "type":"structure", "required":[ "appliedStatus", "awayFrom", "comment", "expiryTime", "resourceIdentifier", "startTime", "zonalShiftId" ], "members":{ "appliedStatus":{ "shape":"AppliedStatus", "documentation":"The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
" }, "expiryTime":{ "shape":"ExpiryTime", "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" }, "practiceRunOutcome":{ "shape":"PracticeRunOutcome", "documentation":"The outcome, or end state, returned for a practice run. The following values can be returned:
PENDING: Outcome value when a practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift.
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" }, "startTime":{ "shape":"StartTime", "documentation":"The time (UTC) when the zonal shift starts.
" }, "zonalShiftId":{ "shape":"ZonalShiftId", "documentation":"The identifier of a zonal shift.
" } }, "documentation":"A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
" }, "ZonalShiftStatus":{ "type":"string", "enum":[ "ACTIVE", "EXPIRED", "CANCELED" ] }, "ZonalShiftSummaries":{ "type":"list", "member":{"shape":"ZonalShiftSummary"} }, "ZonalShiftSummary":{ "type":"structure", "required":[ "awayFrom", "comment", "expiryTime", "resourceIdentifier", "startTime", "status", "zonalShiftId" ], "members":{ "awayFrom":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
" }, "expiryTime":{ "shape":"ExpiryTime", "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" }, "practiceRunOutcome":{ "shape":"PracticeRunOutcome", "documentation":"The outcome, or end state, of a practice run. The following values can be returned:
PENDING: Outcome value when the practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "resourceIdentifier":{ "shape":"ResourceIdentifier", "documentation":"The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" }, "startTime":{ "shape":"StartTime", "documentation":"The time (UTC) when the zonal shift starts.
" }, "status":{ "shape":"ZonalShiftStatus", "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The identifier of a zonal shift.
" } }, "documentation":"Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.
Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.
" }, "ZonalShiftsInResource":{ "type":"list", "member":{"shape":"ZonalShiftInResource"} } }, "documentation":"Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).
You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.
You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.
To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone.
Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability.
If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone.
Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact.
For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide.
" }