Awso_arc_zonal_shift_asyncSourceval cancel_practice_run :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.CancelPracticeRunRequest.t ->
(Awso_arc_zonal_shift.Values.CancelPracticeRunResponse.t,
Awso_arc_zonal_shift.Values.CancelPracticeRunResponse.error)
Result.t
Async.Deferred.tval cancel_zonal_shift :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.CancelZonalShiftRequest.t ->
(Awso_arc_zonal_shift.Values.ZonalShift.t,
Awso_arc_zonal_shift.Values.ZonalShift.error)
Result.t
Async.Deferred.tval create_practice_run_configuration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.CreatePracticeRunConfigurationRequest.t ->
(Awso_arc_zonal_shift.Values.CreatePracticeRunConfigurationResponse.t,
Awso_arc_zonal_shift.Values.CreatePracticeRunConfigurationResponse.error)
Result.t
Async.Deferred.tval delete_practice_run_configuration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.DeletePracticeRunConfigurationRequest.t ->
(Awso_arc_zonal_shift.Values.DeletePracticeRunConfigurationResponse.t,
Awso_arc_zonal_shift.Values.DeletePracticeRunConfigurationResponse.error)
Result.t
Async.Deferred.tval get_autoshift_observer_notification_status :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.GetAutoshiftObserverNotificationStatusRequest.t ->
(Awso_arc_zonal_shift.Values.GetAutoshiftObserverNotificationStatusResponse.t,
Awso_arc_zonal_shift.Values.GetAutoshiftObserverNotificationStatusResponse.error)
Result.t
Async.Deferred.tval get_managed_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.GetManagedResourceRequest.t ->
(Awso_arc_zonal_shift.Values.GetManagedResourceResponse.t,
Awso_arc_zonal_shift.Values.GetManagedResourceResponse.error)
Result.t
Async.Deferred.tval list_autoshifts :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.ListAutoshiftsRequest.t ->
(Awso_arc_zonal_shift.Values.ListAutoshiftsResponse.t,
Awso_arc_zonal_shift.Values.ListAutoshiftsResponse.error)
Result.t
Async.Deferred.tval list_managed_resources :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.ListManagedResourcesRequest.t ->
(Awso_arc_zonal_shift.Values.ListManagedResourcesResponse.t,
Awso_arc_zonal_shift.Values.ListManagedResourcesResponse.error)
Result.t
Async.Deferred.tval list_zonal_shifts :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.ListZonalShiftsRequest.t ->
(Awso_arc_zonal_shift.Values.ListZonalShiftsResponse.t,
Awso_arc_zonal_shift.Values.ListZonalShiftsResponse.error)
Result.t
Async.Deferred.tval start_practice_run :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.StartPracticeRunRequest.t ->
(Awso_arc_zonal_shift.Values.StartPracticeRunResponse.t,
Awso_arc_zonal_shift.Values.StartPracticeRunResponse.error)
Result.t
Async.Deferred.tval start_zonal_shift :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.StartZonalShiftRequest.t ->
(Awso_arc_zonal_shift.Values.ZonalShift.t,
Awso_arc_zonal_shift.Values.ZonalShift.error)
Result.t
Async.Deferred.tval update_autoshift_observer_notification_status :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.UpdateAutoshiftObserverNotificationStatusRequest.t ->
(Awso_arc_zonal_shift.Values.UpdateAutoshiftObserverNotificationStatusResponse.t,
Awso_arc_zonal_shift.Values.UpdateAutoshiftObserverNotificationStatusResponse.error)
Result.t
Async.Deferred.tval update_practice_run_configuration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.UpdatePracticeRunConfigurationRequest.t ->
(Awso_arc_zonal_shift.Values.UpdatePracticeRunConfigurationResponse.t,
Awso_arc_zonal_shift.Values.UpdatePracticeRunConfigurationResponse.error)
Result.t
Async.Deferred.tval update_zonal_autoshift_configuration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.UpdateZonalAutoshiftConfigurationRequest.t ->
(Awso_arc_zonal_shift.Values.UpdateZonalAutoshiftConfigurationResponse.t,
Awso_arc_zonal_shift.Values.UpdateZonalAutoshiftConfigurationResponse.error)
Result.t
Async.Deferred.tval update_zonal_shift :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_arc_zonal_shift.Values.UpdateZonalShiftRequest.t ->
(Awso_arc_zonal_shift.Values.ZonalShift.t,
Awso_arc_zonal_shift.Values.ZonalShift.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_arc_zonal_shift.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]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 Application Recovery Controller Developer Guide.
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
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 Application Recovery Controller Developer Guide.
Lists information about zonal shifts in Amazon Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that 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 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.
A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts. You can start a zonal shift in 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 Amazon EC2 Auto Scaling groups, Amazon Elastic Kubernetes Service, Network Load Balancers, and Application Load Balancer.
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 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with 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.
You do not have sufficient access to perform this action.
The request could not be processed because of conflict in the current state of the resource.
There was an internal server error.
The input requested a resource that was not found.
The request was denied due to request throttling.
The input fails to satisfy the constraints specified by an Amazon Web Services service.
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, ARC shifts traffic for the resource weekly for practice runs. Practice runs are required for zonal autoshift. The zonal shifts that 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.
module AutoshiftObserverNotificationStatus =
Awso_arc_zonal_shift.Values.AutoshiftObserverNotificationStatusCancel a zonal shift in Amazon 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.
Update an active zonal shift in Amazon 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.
module UpdateZonalAutoshiftConfigurationResponse =
Awso_arc_zonal_shift.Values.UpdateZonalAutoshiftConfigurationResponseThe 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 configuration, 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 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.
module UpdateZonalAutoshiftConfigurationRequest =
Awso_arc_zonal_shift.Values.UpdateZonalAutoshiftConfigurationRequestThe 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 configuration, 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 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.
module UpdatePracticeRunConfigurationResponse =
Awso_arc_zonal_shift.Values.UpdatePracticeRunConfigurationResponseUpdate 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.
module UpdatePracticeRunConfigurationRequest =
Awso_arc_zonal_shift.Values.UpdatePracticeRunConfigurationRequestUpdate 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.
module UpdateAutoshiftObserverNotificationStatusResponse =
Awso_arc_zonal_shift.Values.UpdateAutoshiftObserverNotificationStatusResponseUpdate 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, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, 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 Application Recovery Controller Developer Guide.
module UpdateAutoshiftObserverNotificationStatusRequest =
Awso_arc_zonal_shift.Values.UpdateAutoshiftObserverNotificationStatusRequestUpdate 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, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, 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 Application Recovery Controller Developer Guide.
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 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC by Amazon Web Services services. Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift: Amazon EC2 Auto Scaling groups Amazon Elastic Kubernetes Service Application Load Balancer Network Load Balancer 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 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 Application Recovery Controller Developer Guide.
Start an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift. For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Start an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift. For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Lists all active and completed zonal shifts in Amazon 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 ARC started on your behalf for zonal autoshift. For more information about listing autoshifts, see ">ListAutoshifts.
Lists all active and completed zonal shifts in Amazon 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 ARC started on your behalf for zonal autoshift. For more information about listing autoshifts, see ">ListAutoshifts.
module ListManagedResourcesResponse =
Awso_arc_zonal_shift.Values.ListManagedResourcesResponseLists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon 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.
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon 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.
Returns the 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.
Returns the 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.
Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
module GetAutoshiftObserverNotificationStatusResponse =
Awso_arc_zonal_shift.Values.GetAutoshiftObserverNotificationStatusResponseReturns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent.
module GetAutoshiftObserverNotificationStatusRequest =
Awso_arc_zonal_shift.Values.GetAutoshiftObserverNotificationStatusRequestReturns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent.
module DeletePracticeRunConfigurationResponse =
Awso_arc_zonal_shift.Values.DeletePracticeRunConfigurationResponseDeletes 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.
module DeletePracticeRunConfigurationRequest =
Awso_arc_zonal_shift.Values.DeletePracticeRunConfigurationRequestDeletes 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.
module CreatePracticeRunConfigurationResponse =
Awso_arc_zonal_shift.Values.CreatePracticeRunConfigurationResponseA 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, 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 Application Recovery Controller Developer Guide.
module CreatePracticeRunConfigurationRequest =
Awso_arc_zonal_shift.Values.CreatePracticeRunConfigurationRequestA 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, 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 Application Recovery Controller Developer Guide.
Cancel a zonal shift in Amazon 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.
Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.
Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.