Smaws_Client_ARCRegionswitch.Typestype nonrec lambdas = {arn : lambda_arn option;The Amazon Resource Name (ARN) of the Lambda function.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
type nonrec lambda_list = lambdas listtype nonrec lambda_ungraceful = {behavior : lambda_ungraceful_behavior option;The ungraceful behavior for a Lambda function, which must be set to skip.
}Configuration for handling failures when invoking Lambda functions.
type nonrec custom_action_lambda_configuration = {ungraceful : lambda_ungraceful option;The settings for ungraceful execution.
*)region_to_run : region_to_run_in;The Amazon Web Services Region for the function to run in. For recovery workflows use activatingRegion or deactivatingRegion. For post-recovery workflows, use activeRegion (the Region with customer traffic) or inactiveRegion (the Region with no customer traffic).
retry_interval_minutes : Smaws_Lib.Smithy_api.Types.float_;The retry interval specified.
*)lambdas : lambda_list;The Amazon Web Services Lambda functions for the execution block.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.
type nonrec asg = {arn : asg_arn option;The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
type nonrec asg_list = asg listtype nonrec ec2_ungraceful = {minimum_success_percentage : Smaws_Lib.Smithy_api.Types.integer;The minimum success percentage that you specify for EC2 Auto Scaling groups.
*)}Configuration for handling failures when performing operations on EC2 resources.
type nonrec ec2_asg_capacity_increase_configuration = {capacity_monitoring_approach : ec2_asg_capacity_monitoring_approach option;The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
*)target_percent : Smaws_Lib.Smithy_api.Types.integer option;The target percentage that you specify for EC2 Auto Scaling groups. The default is 100.
*)ungraceful : ec2_ungraceful option;The settings for ungraceful execution.
*)asgs : asg_list;The EC2 Auto Scaling groups for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
type nonrec execution_approval_configuration = {approval_role : role_arn;The IAM approval role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.
type nonrec arc_routing_control_state = {state : routing_control_state_change;The state of an ARC routing control, On or Off.
*)routing_control_arn : routing_control_arn;The Amazon Resource Name (ARN) of a routing control.
*)}Represents the state of an ARC routing control.
type nonrec arc_routing_control_states = arc_routing_control_state listtype nonrec region_and_routing_controls =
(Smaws_Lib.Smithy_api.Types.string_ * arc_routing_control_states) listtype nonrec arc_routing_control_configuration = {region_and_routing_controls : region_and_routing_controls;The Region and ARC routing controls for the configuration.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.
type nonrec global_aurora_ungraceful = {ungraceful : global_aurora_ungraceful_behavior option;The settings for ungraceful execution.
*)}Configuration for handling failures when performing operations on Aurora global databases.
type nonrec aurora_cluster_arns = aurora_cluster_arn listtype nonrec global_aurora_configuration = {database_cluster_arns : aurora_cluster_arns;The database cluster Amazon Resource Names (ARNs) for a global database.
*)global_cluster_identifier : global_cluster_identifier;The global cluster identifier for a global database.
*)ungraceful : global_aurora_ungraceful option;The settings for ungraceful execution.
*)behavior : global_aurora_default_behavior;The behavior for a global database, that is, only allow switchover or also allow failover.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Aurora global databases used in a Region switch plan.
type nonrec region_switch_plan_configuration = {arn : plan_arn;The Amazon Resource Name (ARN) of the plan configuration.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.
type nonrec service = {service_arn : ecs_service_arn option;The Amazon Resource Name (ARN) for a service.
*)cluster_arn : ecs_cluster_arn option;The cluster Amazon Resource Name (ARN) for a service.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the service.
*)cross_account_role : iam_role_arn option;The cross account role for a service.
*)}The service for a cross account role.
type nonrec service_list = service listtype nonrec ecs_ungraceful = {minimum_success_percentage : Smaws_Lib.Smithy_api.Types.integer;The minimum success percentage specified for the configuration.
*)}The settings for ungraceful execution.
type nonrec ecs_capacity_increase_configuration = {capacity_monitoring_approach : ecs_capacity_monitoring_approach option;The monitoring approach specified for the configuration, for example, Most_Recent.
target_percent : Smaws_Lib.Smithy_api.Types.integer option;The target percentage specified for the configuration. The default is 100.
*)ungraceful : ecs_ungraceful option;The settings for ungraceful execution.
*)services : service_list;The services specified for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}The configuration for an Amazon Web Services ECS capacity increase.
type nonrec kubernetes_resource_type = {kind : Smaws_Lib.Smithy_api.Types.string_;The kind for the Kubernetes resource.
*)api_version : Smaws_Lib.Smithy_api.Types.string_;The API version type for the Kubernetes resource.
*)}Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
type nonrec kubernetes_scaling_resource = {hpa_name : Smaws_Lib.Smithy_api.Types.string_ option;The hpaname for the Kubernetes resource.
*)name : Smaws_Lib.Smithy_api.Types.string_;The name for the Kubernetes resource.
*)namespace : kubernetes_namespace;The namespace for the Kubernetes resource.
*)}Defines a Kubernetes resource to scale in an Amazon EKS cluster.
type nonrec regional_scaling_resource =
(region * kubernetes_scaling_resource) listtype nonrec kubernetes_scaling_application =
(Smaws_Lib.Smithy_api.Types.string_ * regional_scaling_resource) listtype nonrec kubernetes_scaling_apps = kubernetes_scaling_application listtype nonrec eks_cluster = {cluster_arn : eks_cluster_arn;The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}The Amazon Web Services EKS cluster execution block configuration.
type nonrec eks_clusters = eks_cluster listtype nonrec eks_resource_scaling_ungraceful = {minimum_success_percentage : Smaws_Lib.Smithy_api.Types.integer;The minimum success percentage for the configuration.
*)}The ungraceful settings for Amazon Web Services EKS resource scaling.
type nonrec eks_resource_scaling_configuration = {capacity_monitoring_approach : eks_capacity_monitoring_approach option;The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
*)target_percent : Smaws_Lib.Smithy_api.Types.integer option;The target percentage for the configuration. The default is 100.
*)ungraceful : eks_resource_scaling_ungraceful option;The settings for ungraceful execution.
*)eks_clusters : eks_clusters option;The clusters for the configuration.
*)scaling_resources : kubernetes_scaling_apps option;The scaling resources for the configuration.
*)kubernetes_resource_type : kubernetes_resource_type;The Kubernetes resource type for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}The Amazon Web Services EKS resource scaling configuration.
type nonrec route53_resource_record_set = {region : region option;The Amazon Route 53 record set Region.
*)record_set_identifier : route53_resource_record_set_identifier option;The Amazon Route 53 record set identifier.
*)}The Amazon Route 53 record set.
type nonrec route53_resource_record_set_list = route53_resource_record_set listtype nonrec route53_health_check_configuration = {record_sets : route53_resource_record_set_list option;The Amazon Route 53 health check configuration record sets.
*)record_name : route53_record_name;The Amazon Route 53 health check configuration record name.
*)hosted_zone_id : route53_hosted_zone_id;The Amazon Route 53 health check configuration hosted zone ID.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The Amazon Route 53 health check configuration time out (in minutes).
*)}The Amazon Route 53 health check configuration.
type nonrec document_db_ungraceful = {ungraceful : document_db_ungraceful_behavior option;The settings for ungraceful execution.
*)}Configuration for handling failures when performing operations on DocumentDB global clusters.
type nonrec document_db_cluster_arns = document_db_cluster_arn listtype nonrec document_db_configuration = {database_cluster_arns : document_db_cluster_arns;The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
*)global_cluster_identifier : document_db_global_cluster_identifier;The global cluster identifier for a DocumentDB global cluster.
*)ungraceful : document_db_ungraceful option;The settings for ungraceful execution.
*)behavior : document_db_default_behavior;The behavior for a global cluster, that is, only allow switchover or also allow failover.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
type nonrec rds_db_instance_arn_map = (region * rds_db_instance_arn) listtype nonrec rds_promote_read_replica_configuration = {db_instance_arn_map : rds_db_instance_arn_map;A map of database instance ARNs for each Region in the plan.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross-account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for promoting an Amazon RDS read replica to a standalone database instance during a Region switch.
type nonrec rds_create_cross_region_replica_configuration = {db_instance_arn_map : rds_db_instance_arn_map;A map of database instance ARNs for each Region in the plan.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross-account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for creating an Amazon RDS cross-Region read replica during post-recovery in a Region switch.
type nonrec event_source_mapping = {arn : event_source_mapping_arn;The Amazon Resource Name (ARN) of the Lambda event source mapping.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}The Amazon Web Services Lambda event source mapping configuration, containing the resource ARN and optional cross-account configuration.
type nonrec region_event_source_mapping_map =
(region * event_source_mapping) listtype nonrec lambda_event_source_mapping_ungraceful = {behavior : lambda_event_source_mapping_ungraceful_behavior option;Set to skip to skip executing this event source mapping step during an ungraceful execution.
}Specifies whether to skip enabling or disabling an event source mapping during an ungraceful execution.
type nonrec lambda_event_source_mapping_configuration = {ungraceful : lambda_event_source_mapping_ungraceful option;The settings for ungraceful execution.
*)region_event_source_mappings : region_event_source_mapping_map;Per-region configuration for which Lambda event source mapping to enable or disable when activating or deactivating a region.
*)action : event_source_mapping_action;The action to take - whether to enable or disable an event source mapping.
timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Web Services Lambda event source mappings used in a Region switch plan.
type nonrec region_aurora_cluster_map = (region * aurora_cluster_arn) listA map of Region to Aurora database cluster ARN for Aurora Serverless scaling configuration.
type nonrec aurora_serverless_scaling_configuration = {target_percent : Smaws_Lib.Smithy_api.Types.integer option;The target capacity percentage for Aurora Serverless scaling.
*)region_database_cluster_arns : region_aurora_cluster_map;Per-Region configuration that maps each Region to the Aurora database cluster ARN for scaling.
*)global_cluster_identifier : global_cluster_identifier;The global cluster identifier for a global database.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Aurora Serverless scaling used in a Region switch plan.
type nonrec region_aurora_instance_arn_map =
(region * aurora_instance_arn) listtype nonrec aurora_provisioned_scaling_configuration = {instance_arns : region_aurora_instance_arn_map;Per-Region configuration that maps each Region to the Aurora database instance ARN for scaling.
*)region_database_cluster_arns : region_aurora_cluster_map;Per-Region configuration that maps each Region to the Aurora database cluster ARN for scaling.
*)global_cluster_identifier : global_cluster_identifier;The global cluster identifier for a global database.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Aurora provisioned cluster scaling used in a Region switch plan.
type nonrec neptune_ungraceful = {ungraceful : neptune_ungraceful_behavior option;The settings for ungraceful execution.
*)}Configuration for handling failures when performing operations on Neptune global databases.
type nonrec region_neptune_cluster_arn_map =
(region * neptune_cluster_arn) listA map of Region to Neptune database cluster ARN for Neptune global database configuration.
type nonrec neptune_global_database_configuration = {region_database_cluster_arns : region_neptune_cluster_arn_map;The database cluster Amazon Resource Names (ARNs) for a Neptune global database.
*)global_cluster_identifier : neptune_global_cluster_identifier;The global cluster identifier for a Neptune global database.
*)ungraceful : neptune_ungraceful option;The settings for ungraceful execution.
*)behavior : neptune_default_behavior;The behavior for a global database, that is, only allow switchover or also allow failover.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)timeout_minutes : Smaws_Lib.Smithy_api.Types.integer option;The timeout value specified for the configuration.
*)}Configuration for Amazon Neptune global databases used in a Region switch plan.
type nonrec execution_block_type = | NEPTUNE| AURORA_PROVISIONED_SCALING| AURORA_SERVERLESS_SCALING| LAMBDA_EVENT_SOURCE_MAPPING| RDS_CREATE_CROSS_REGION_REPLICA| RDS_PROMOTE_READ_REPLICA| DOCUMENTDB| ROUTE53_HEALTH_CHECK| EKS_RESOURCE_SCALING| ECS| PARALLEL| REGION_SWITCH| ROUTING_CONTROL| EC2_ASG| AURORA| EXECUTION_APPROVAL| CUSTOM_ACTION_LAMBDAtype execution_block_configuration = | NeptuneGlobalDatabaseConfig of neptune_global_database_configurationA Neptune global database execution block.
*)| AuroraProvisionedScalingConfig of aurora_provisioned_scaling_configurationAn Aurora provisioned cluster scaling execution block.
*)| AuroraServerlessScalingConfig of aurora_serverless_scaling_configurationAn Aurora Serverless scaling execution block.
*)| LambdaEventSourceMappingConfig of lambda_event_source_mapping_configurationA Lambda event source mapping execution block.
*)| RdsCreateCrossRegionReadReplicaConfig of rds_create_cross_region_replica_configurationAn Amazon RDS create cross-Region replica execution block.
*)| RdsPromoteReadReplicaConfig of rds_promote_read_replica_configurationAn Amazon RDS promote read replica execution block.
*)| DocumentDbConfig of document_db_configuration| Route53HealthCheckConfig of route53_health_check_configurationThe Amazon Route 53 health check configuration.
*)| EksResourceScalingConfig of eks_resource_scaling_configurationAn Amazon Web Services EKS resource scaling execution block.
*)| EcsCapacityIncreaseConfig of ecs_capacity_increase_configurationThe capacity increase specified for the configuration.
*)| RegionSwitchPlanConfig of region_switch_plan_configurationA Region switch plan execution block.
*)| ParallelConfig of parallel_execution_block_configurationA parallel configuration execution block.
*)| GlobalAuroraConfig of global_aurora_configurationAn Aurora Global Database execution block.
*)| ArcRoutingControlConfig of arc_routing_control_configurationAn ARC routing control execution block.
*)| ExecutionApprovalConfig of execution_approval_configurationA manual approval execution block.
*)| Ec2AsgCapacityIncreaseConfig of ec2_asg_capacity_increase_configurationAn EC2 Auto Scaling group execution block.
*)| CustomActionLambdaConfig of custom_action_lambda_configurationAn Amazon Web Services Lambda execution block.
*)Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.
and parallel_execution_block_configuration = {steps : steps;The steps for a parallel execution block.
*)}Configuration for steps that should be executed in parallel during a Region switch.
and step = {execution_block_type : execution_block_type;The type of an execution block in a workflow.
*)execution_block_configuration : execution_block_configuration;The configuration for an execution block in a workflow.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description of a step in a workflow.
*)name : step_name;The name of a step in a workflow.
*)}Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
and steps = step listtype nonrec workflow = {workflow_description : Smaws_Lib.Smithy_api.Types.string_ option;The description of the workflow.
*)workflow_target_region : region option;The Amazon Web Services Region that the workflow targets.
*)workflow_target_action : workflow_target_action;The action that the workflow performs. Valid values include activate and deactivate.
steps : steps option;The steps that make up the workflow.
*)}Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
type nonrec workflow_list = workflow listtype nonrec associated_alarm = {alarm_type : alarm_type;The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
*)resource_identifier : Smaws_Lib.Smithy_api.Types.string_;The resource identifier for alarms that you associate with a plan.
*)external_id : Smaws_Lib.Smithy_api.Types.string_ option;The external ID (secret key) for the configuration.
*)cross_account_role : iam_role_arn option;The cross account role for the configuration.
*)}An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
type nonrec associated_alarm_map =
(Smaws_Lib.Smithy_api.Types.string_ * associated_alarm) listtype nonrec trigger_condition = {condition : alarm_condition;The condition that must be met. Valid values include green and red.
associated_alarm_name : Smaws_Lib.Smithy_api.Types.string_;The name of the CloudWatch alarm associated with the condition.
*)}Defines a condition that must be met for a trigger to fire.
type nonrec trigger_condition_list = trigger_condition listtype nonrec trigger = {min_delay_minutes_between_executions : Smaws_Lib.Smithy_api.Types.integer;The minimum time, in minutes, that must elapse between automatic executions of the plan.
*)conditions : trigger_condition_list;The conditions that must be met for the trigger to fire.
*)action : workflow_target_action;The action to perform when the trigger fires. Valid values include activate and deactivate.
target_region : region;The Amazon Web Services Region for a trigger.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description for a trigger.
*)}Defines a condition that can automatically trigger the execution of a Region switch plan.
type nonrec trigger_list = trigger listtype nonrec s3_report_output_configuration = {bucket_owner : account_id option;The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
*)bucket_path : Smaws_Lib.Smithy_api.Types.string_ option;The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
*)}Configuration for delivering generated reports to an Amazon S3 bucket.
type nonrec report_output_configuration = | S3Configuration of s3_report_output_configurationConfiguration for delivering reports to an Amazon S3 bucket.
*)Configuration for report output destinations used in a Region switch plan.
type nonrec report_output_list = report_output_configuration listtype nonrec report_configuration = {report_output : report_output_list option;The output configuration for the report.
*)}Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.
type nonrec region_list = region listtype nonrec plan = {updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the plan was last updated.
*)version : Smaws_Lib.Smithy_api.Types.string_ option;The version for the plan.
*)owner : account_id;The owner of a plan.
*)primary_region : region option;The primary Region for a plan.
*)recovery_approach : recovery_approach;The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
*)regions : region_list;The Amazon Web Services Regions for a plan.
*)name : plan_name;The name for a plan.
*)report_configuration : report_configuration option;The report configuration for a plan.
*)triggers : trigger_list option;The triggers for a plan.
*)associated_alarms : associated_alarm_map option;The associated application health alarms for a plan.
*)recovery_time_objective_minutes : Smaws_Lib.Smithy_api.Types.integer option;The recovery time objective for a plan.
*)execution_role : iam_role_arn;The execution role for a plan.
*)workflows : workflow_list;The workflows for a plan.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description for a plan.
*)arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
type nonrec update_plan_response = {plan : plan option;The details of the updated Region switch plan.
*)}type nonrec update_plan_request = {report_configuration : report_configuration option;The updated report configuration for the plan.
*)triggers : trigger_list option;The updated conditions that can automatically trigger the execution of the plan.
*)associated_alarms : associated_alarm_map option;The updated CloudWatch alarms associated with the plan.
*)recovery_time_objective_minutes : Smaws_Lib.Smithy_api.Types.integer option;The updated target recovery time objective (RTO) in minutes for the plan.
*)execution_role : iam_role_arn;The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
*)workflows : workflow_list;The updated workflows for the Region switch plan.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The updated description for the Region switch plan.
*)arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}type nonrec update_plan_execution_step_request = {action_to_take : update_plan_execution_step_action;The updated action to take for the step. This can be used to skip or retry a step.
*)step_name : Smaws_Lib.Smithy_api.Types.string_;The name of the execution step to update.
*)comment : execution_comment;An optional comment about the plan execution.
*)execution_id : execution_id;The unique identifier of the plan execution containing the step to update.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan containing the execution step to update.
*)}The specified resource was not found.
HTTP Status Code: 404
You do not have sufficient access to perform this action.
HTTP Status Code: 403
type nonrec update_plan_execution_request = {comment : execution_comment option;An optional comment about the plan execution.
*)action : update_plan_execution_action;The action specified for a plan execution, for example, Switch to Graceful or Pause.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan with the execution to update.
*)}The operation failed because the current state of the resource doesn't allow the operation to proceed.
HTTP Status Code: 400
type nonrec tag_keys = tag_key listThe request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
type nonrec tag_resource_request = {arn : plan_arn;The Amazon Resource Name (ARN) for a tag that you add to a resource.
*)}type nonrec step_state = {step_mode : execution_mode option;The mode for a step execution. The mode can be Graceful or Ungraceful.
*)end_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when a step endeded execution.
*)start_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when a step started execution.
*)status : step_status option;The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
*)name : step_name option;The name of a step in a workflow.
*)}Represents the state of a step in a plan execution.
type nonrec step_states = step_state listtype nonrec start_plan_execution_response = {deactivate_region : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Web Services Region to deactivate.
*)activate_region : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Web Services Region to activate.
*)plan_version : Smaws_Lib.Smithy_api.Types.string_ option;The version of the plan, a unique number generated by Region switch.
*)plan : plan_arn option;The details of the Region switch plan.
*)execution_id : execution_id option;The execution identifier of a plan execution.
*)}type nonrec start_plan_execution_request = {recovery_execution_id : recovery_execution_id option;The execution identifier of the recovery execution that ran in the opposite region post-recovery is ran in. Required when starting a post-recovery execution.
*)latest_version : Smaws_Lib.Smithy_api.Types.string_ option;A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
*)comment : execution_comment option;An optional comment explaining why the plan execution is being started.
*)mode : execution_mode option;The plan execution mode. Valid values are graceful, for starting the execution in graceful mode, or ungraceful, for starting the execution in ungraceful mode.
action : execution_action;The action to perform. Valid values are activate (to shift traffic to the target Region) or deactivate (to shift traffic away from the target Region).
target_region : Smaws_Lib.Smithy_api.Types.string_;The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan to execute.
*)}The request processing has an invalid argument.
type nonrec s3_report_output = {s3_object_key : Smaws_Lib.Smithy_api.Types.string_ option;The S3 object key where the generated report is stored.
*)}Information about a report delivered to Amazon S3.
type nonrec route53_health_check = {region : region;The Amazon Route 53 Region.
*)status : route53_health_check_status option;The Amazon Route 53 health check status.
*)health_check_id : route53_health_check_id option;The Amazon Route 53 health check ID.
*)record_name : route53_record_name;The Amazon Route 53 record name.
*)hosted_zone_id : route53_hosted_zone_id;The Amazon Route 53 health check hosted zone ID.
*)}The Amazon Route 53 health check.
type nonrec route53_health_check_list = route53_health_check listtype nonrec resources = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec minimal_workflow = {name : Smaws_Lib.Smithy_api.Types.string_ option;The name for a minimal workflow
*)action : execution_action option;The action for a minimal workflow, which can be Activate or Deactivate.
*)}A simplified representation of a workflow in a Region switch plan.
type nonrec resource_warning = {warning_message : Smaws_Lib.Smithy_api.Types.string_;The warning message about what needs to be corrected.
*)warning_updated_time : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp when the warning was last updated.
*)warning_status : resource_warning_status;The status of the resource warning.
*)resource_arn : resource_arn option;The Amazon Resource Name (ARN) of the resource.
*)step_name : step_name option;The name of the step for the resource warning.
*)version : Smaws_Lib.Smithy_api.Types.string_;The version for the resource warning.
*)workflow : minimal_workflow option;The workflow for the resource warning.
*)}Represents a warning about a resource in a Region switch plan.
type nonrec failed_report_output = {error_message : Smaws_Lib.Smithy_api.Types.string_ option;The error message for the failed report generation.
*)error_code : failed_report_error_code option;The error code for the failed report generation.
*)}Information about a report generation that failed.
type nonrec report_output = | FailedReportOutput of failed_report_outputThe details about a failed report generation.
*)| S3ReportOutput of s3_report_outputInformation about a report delivered to Amazon S3.
*)The output location or cause of a failure in report generation.
type nonrec region_switch_plan = Smaws_Lib.CoreTypes.Resource.ttype nonrec plan_warnings = resource_warning listtype nonrec abbreviated_plan = {recovery_time_objective_minutes : Smaws_Lib.Smithy_api.Types.integer option;The recovery time objective that you've specified.
*)active_plan_execution : execution_id option;Specifies if this is the active plan execution at this time.
*)execution_role : Smaws_Lib.Smithy_api.Types.string_ option;The execution role is a way to categorize a Region switch plan.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description of a Region switch plan.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the plan execution was last updated.
*)version : Smaws_Lib.Smithy_api.Types.string_ option;The version for the plan.
*)primary_region : region option;The primary Region for a plan.
*)recovery_approach : recovery_approach;The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
*)regions : region_list;The Amazon Web Services Region specified for a Region switch plan.
*)name : plan_name;The name of a Region switch plan.
*)owner : account_id;The owner of a Region switch plan.
*)arn : plan_arn;The Amazon Resource Name (ARN) of the Region switch plan.
*)}A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.
type nonrec plan_list = abbreviated_plan listtype nonrec list_route53_health_checks_response = {next_token : next_token option;A pagination token. A response may contain no results while still including a nextToken. Continue paginating until nextToken is null to retrieve all results.
health_checks : route53_health_check_list option;List of the health checks requested.
*)}type nonrec list_route53_health_checks_request = {next_token : next_token option;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.
max_results : max_results option;The maximum number of results to return in the response.
*)record_name : route53_record_name option;The record name for the health checks.
*)hosted_zone_id : route53_hosted_zone_id option;The hosted zone ID for the health checks.
*)arn : plan_arn;The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.
*)}type nonrec list_route53_health_checks_in_region_response = {next_token : next_token option;A pagination token. A response may contain no results while still including a nextToken. Continue paginating until nextToken is null to retrieve all results.
health_checks : route53_health_check_list option;List of the health checks requested.
*)}type nonrec list_route53_health_checks_in_region_request = {next_token : next_token option;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.
max_results : max_results option;The maximum number of results to return in the response.
*)record_name : route53_record_name option;The record name for the health checks.
*)hosted_zone_id : route53_hosted_zone_id option;The hosted zone ID for the health checks.
*)arn : plan_arn;The Amazon Resource Name (ARN) of the Arc Region Switch Plan.
*)}type nonrec list_plans_response = {next_token : next_token option;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.
plans : plan_list option;The plans that were requested.
*)}type nonrec list_plans_request = {next_token : next_token option;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.
max_results : max_results option;The number of objects that you want to return with this call.
*)}type nonrec list_plans_in_region_response = {next_token : next_token option;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.
plans : plan_list option;The plans that were requested.
*)}type nonrec list_plans_in_region_request = {next_token : next_token option;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.
max_results : max_results option;The number of objects that you want to return with this call.
*)}type nonrec abbreviated_execution = {actual_recovery_time : duration option;The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
*)recovery_execution_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.
*)execution_region : Smaws_Lib.Smithy_api.Types.string_;The Amazon Web Services Region for a plan execution.
*)execution_action : execution_action;The plan execution action. Valid values are activate, to activate an Amazon Web Services Region, or deactivate, to deactivate a Region.
execution_state : execution_state;The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
*)mode : execution_mode;The plan execution mode. Valid values are graceful, for graceful executions, or ungraceful, for ungraceful executions.
end_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the plan execution was ended.
*)start_time : Smaws_Lib.Smithy_api.Types.timestamp;The timestamp when the plan execution was started.
*)comment : Smaws_Lib.Smithy_api.Types.string_ option;An optional comment about the plan execution.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the plan execution was last updated.
*)version : Smaws_Lib.Smithy_api.Types.string_ option;The version for the plan.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.
type nonrec abbreviated_executions_list = abbreviated_execution listtype nonrec list_plan_executions_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
items : abbreviated_executions_list option;The items in the plan execution to return.
*)}type nonrec list_plan_executions_request = {state : execution_state option;The state of the plan execution. For example, the plan execution might be In Progress.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
max_results : list_executions_max_results option;The number of objects that you want to return with this call.
*)plan_arn : plan_arn;The ARN for the plan.
*)}type nonrec execution_event_type = | PLAN_EVALUATION_WARNING| STEP_PENDING_APPLICATION_HEALTH_MONITOR| STEP_EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL| STEP_PENDING_APPROVAL| STEP_CANCELED| STEP_PAUSED_BY_OPERATOR| STEP_PAUSED_BY_ERROR| STEP_SKIPPED| STEP_FAILED| STEP_SUCCEEDED| STEP_UPDATE| STEP_STARTED| EXECUTION_SUCCESS_MONITORING_APPLICATION_HEALTH| EXECUTION_PENDING_CHILD_PLAN_MANUAL_APPROVAL| EXECUTION_BEHAVIOR_CHANGED_TO_GRACEFUL| EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL| EXECUTION_PENDING_APPROVAL| EXECUTION_CANCELED| EXECUTION_CANCELING| EXECUTION_PAUSED| EXECUTION_PAUSING| EXECUTION_FAILED| EXECUTION_SUCCEEDED| EXECUTION_STARTED| EXECUTION_PENDING| UNKNOWNtype nonrec execution_event = {previous_event_id : Smaws_Lib.Smithy_api.Types.string_ option;The event ID of the previous execution event.
*)event_id : Smaws_Lib.Smithy_api.Types.string_;The event ID for an execution event.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description for an execution event.
*)error : Smaws_Lib.Smithy_api.Types.string_ option;Errors for an execution event.
*)resources : resources option;The resources for an execution event.
*)execution_block_type : execution_block_type option;The execution block type for an execution event.
*)step_name : step_name option;The step name for an execution event.
*)type_ : execution_event_type option;The type of an execution event.
*)timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp for an execution event.
*)}Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.
type nonrec execution_event_list = execution_event listtype nonrec list_plan_execution_events_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
items : execution_event_list option;The items in the plan execution event.
*)}type nonrec list_plan_execution_events_request = {name : step_name option;The name of the plan execution event.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
max_results : list_execution_events_max_results option;The number of objects that you want to return with this call.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}type nonrec get_plan_response = {plan : plan option;The detailed information about the requested Region switch plan.
*)}type nonrec get_plan_in_region_response = {plan : plan option;The details of the Region switch plan.
*)}type nonrec get_plan_in_region_request = {arn : plan_arn;The Amazon Resource Name (ARN) of the plan in Region.
*)}type nonrec generated_report = {report_output : report_output option;The output location or cause of a failure in report generation.
*)report_generation_time : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the report was generated.
*)}Information about a generated execution report.
type nonrec generated_report_details = generated_report listtype nonrec get_plan_execution_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
generated_report_details : generated_report_details option;Information about the location of a generated report, or the cause of its failure.
*)actual_recovery_time : duration option;The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
*)plan : plan option;The details of the Region switch plan.
*)step_states : step_states option;The states of the steps in the plan execution.
*)recovery_execution_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.
*)execution_region : Smaws_Lib.Smithy_api.Types.string_;The Amazon Web Services Region for a plan execution.
*)execution_action : execution_action;The plan execution action. Valid values are activate, to activate an Amazon Web Services Region, or deactivate, to deactivate a Region.
execution_state : execution_state;The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
*)mode : execution_mode;The plan execution mode. Valid values are graceful, for graceful executions, or ungraceful, for ungraceful executions.
end_time : Smaws_Lib.Smithy_api.Types.timestamp option;The time (UTC) when the plan execution ended.
*)start_time : Smaws_Lib.Smithy_api.Types.timestamp;The time (UTC) when the plan execution started.
*)comment : Smaws_Lib.Smithy_api.Types.string_ option;A comment included on the plan execution.
*)updated_at : Smaws_Lib.Smithy_api.Types.timestamp option;The timestamp when the plan execution was last updated.
*)version : Smaws_Lib.Smithy_api.Types.string_ option;The version for the plan.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}type nonrec get_plan_execution_request = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
max_results : get_plan_execution_step_states_max_results option;The number of objects that you want to return with this call.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan with the execution to retrieve.
*)}type nonrec get_plan_evaluation_status_response = {next_token : next_token option;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.
warnings : plan_warnings option;The current evaluation warnings for the plan.
*)evaluation_state : evaluation_status option;The evaluation state for the plan.
*)region : region option;The Amazon Web Services Region for the plan.
*)last_evaluated_version : Smaws_Lib.Smithy_api.Types.string_ option;The version of the last evaluation of the plan.
*)last_evaluation_time : Smaws_Lib.Smithy_api.Types.timestamp option;The time of the last time that Region switch ran an evaluation of the plan.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}type nonrec get_plan_evaluation_status_request = {next_token : next_token option;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.
max_results : max_results option;The number of objects that you want to return with this call.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
*)}type nonrec create_plan_response = {plan : plan option;The details of the created Region switch plan.
*)}type nonrec create_plan_request = {primary_region : region option;The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.
*)recovery_approach : recovery_approach;The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
*)regions : region_list;An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
*)name : plan_name;The name of a Region switch plan.
*)report_configuration : report_configuration option;triggers : trigger_list option;The triggers associated with a Region switch plan.
*)associated_alarms : associated_alarm_map option;The alarms associated with a Region switch plan.
*)recovery_time_objective_minutes : Smaws_Lib.Smithy_api.Types.integer option;Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.
*)execution_role : iam_role_arn;An execution role is a way to categorize a Region switch plan.
*)workflows : workflow_list;An array of workflows included in a Region switch plan.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description of a Region switch plan.
*)}type nonrec cancel_plan_execution_request = {comment : execution_comment option;A comment that you can enter about canceling a plan execution step.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}type nonrec approve_plan_execution_step_request = {comment : execution_comment option;A comment that you can enter about a plan execution.
*)approval : approval;The status of approval for a plan execution step.
*)step_name : step_name;The name of a step in a plan execution.
*)execution_id : execution_id;The execution identifier of a plan execution.
*)plan_arn : plan_arn;The Amazon Resource Name (ARN) of the plan.
*)}