Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.
You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.
" }, "CancelPlanExecution":{ "name":"CancelPlanExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelPlanExecutionRequest"}, "output":{"shape":"CancelPlanExecutionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.
You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.
" }, "CreatePlan":{ "name":"CreatePlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlanRequest"}, "output":{"shape":"CreatePlanResponse"}, "documentation":"Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.
", "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "DeletePlan":{ "name":"DeletePlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlanRequest"}, "output":{"shape":"DeletePlanResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"IllegalStateException"} ], "documentation":"Deletes a Region switch plan. You must specify the ARN of the plan to delete.
You cannot delete a plan that has an active execution in progress.
", "idempotent":true, "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "GetPlan":{ "name":"GetPlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlanRequest"}, "output":{"shape":"GetPlanResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.
", "readonly":true, "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "GetPlanEvaluationStatus":{ "name":"GetPlanEvaluationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlanEvaluationStatusRequest"}, "output":{"shape":"GetPlanEvaluationStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
", "readonly":true }, "GetPlanExecution":{ "name":"GetPlanExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlanExecutionRequest"}, "output":{"shape":"GetPlanExecutionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
", "readonly":true }, "GetPlanInRegion":{ "name":"GetPlanInRegion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlanInRegionRequest"}, "output":{"shape":"GetPlanInRegionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.
", "readonly":true }, "ListPlanExecutionEvents":{ "name":"ListPlanExecutionEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlanExecutionEventsRequest"}, "output":{"shape":"ListPlanExecutionEventsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.
", "readonly":true }, "ListPlanExecutions":{ "name":"ListPlanExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlanExecutionsRequest"}, "output":{"shape":"ListPlanExecutionsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.
", "readonly":true }, "ListPlans":{ "name":"ListPlans", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlansRequest"}, "output":{"shape":"ListPlansResponse"}, "documentation":"Lists all Region switch plans in your Amazon Web Services account.
", "readonly":true, "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "ListPlansInRegion":{ "name":"ListPlansInRegion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlansInRegionRequest"}, "output":{"shape":"ListPlansInRegionResponse"}, "errors":[ {"shape":"AccessDeniedException"} ], "documentation":"Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
", "readonly":true }, "ListRoute53HealthChecks":{ "name":"ListRoute53HealthChecks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRoute53HealthChecksRequest"}, "output":{"shape":"ListRoute53HealthChecksResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"List the Amazon Route 53 health checks.
", "readonly":true, "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "ListRoute53HealthChecksInRegion":{ "name":"ListRoute53HealthChecksInRegion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRoute53HealthChecksInRegionRequest"}, "output":{"shape":"ListRoute53HealthChecksInRegionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"IllegalArgumentException"}, {"shape":"InternalServerException"} ], "documentation":"List the Amazon Route 53 health checks in a specific Amazon Web Services Region.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the tags attached to a Region switch resource.
", "readonly":true, "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "StartPlanExecution":{ "name":"StartPlanExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartPlanExecutionRequest"}, "output":{"shape":"StartPlanExecutionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"IllegalStateException"}, {"shape":"AccessDeniedException"}, {"shape":"IllegalArgumentException"} ], "documentation":"Starts the execution of a Region switch plan. You can execute a plan in either graceful or ungraceful mode.
Specifing ungraceful mode either changes the behavior of the execution blocks in a workflow or skips specific execution blocks.
Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.
", "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Removes tags from a Region switch resource.
", "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "UpdatePlan":{ "name":"UpdatePlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePlanRequest"}, "output":{"shape":"UpdatePlanResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
", "staticContextParams":{ "UseControlPlaneEndpoint":{"value":true} } }, "UpdatePlanExecution":{ "name":"UpdatePlanExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePlanExecutionRequest"}, "output":{"shape":"UpdatePlanExecutionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"IllegalStateException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
" }, "UpdatePlanExecutionStep":{ "name":"UpdatePlanExecutionStep", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePlanExecutionStepRequest"}, "output":{"shape":"UpdatePlanExecutionStepResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
" } }, "shapes":{ "AbbreviatedExecution":{ "type":"structure", "required":[ "planArn", "executionId", "startTime", "mode", "executionState", "executionAction", "executionRegion" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "version":{ "shape":"String", "documentation":"The version for the plan.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the plan execution was last updated.
" }, "comment":{ "shape":"String", "documentation":"An optional comment about the plan execution.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The timestamp when the plan execution was started.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The timestamp when the plan execution was ended.
" }, "mode":{ "shape":"ExecutionMode", "documentation":"The plan execution mode. Valid values are graceful, for graceful executions, or ungraceful, for ungraceful executions.
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
" }, "executionAction":{ "shape":"ExecutionAction", "documentation":"The plan execution action. Valid values are activate, to activate an Amazon Web Services Region, or deactivate, to deactivate a Region.
The Amazon Web Services Region for a plan execution.
" }, "recoveryExecutionId":{ "shape":"String", "documentation":"The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.
" }, "actualRecoveryTime":{ "shape":"Duration", "documentation":"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.
" } }, "documentation":"A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.
" }, "AbbreviatedExecutionsList":{ "type":"list", "member":{"shape":"AbbreviatedExecution"} }, "AbbreviatedPlan":{ "type":"structure", "required":[ "arn", "owner", "name", "regions", "recoveryApproach" ], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the Region switch plan.
" }, "owner":{ "shape":"AccountId", "documentation":"The owner of a Region switch plan.
" }, "name":{ "shape":"PlanName", "documentation":"The name of a Region switch plan.
" }, "regions":{ "shape":"RegionList", "documentation":"The Amazon Web Services Region specified for a Region switch plan.
" }, "recoveryApproach":{ "shape":"RecoveryApproach", "documentation":"The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
" }, "primaryRegion":{ "shape":"Region", "documentation":"The primary Region for a plan.
" }, "version":{ "shape":"String", "documentation":"The version for the plan.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the plan execution was last updated.
" }, "description":{ "shape":"String", "documentation":"The description of a Region switch plan.
" }, "executionRole":{ "shape":"String", "documentation":"The execution role is a way to categorize a Region switch plan.
" }, "activePlanExecution":{ "shape":"ExecutionId", "documentation":"Specifies if this is the active plan execution at this time.
" }, "recoveryTimeObjectiveMinutes":{ "shape":"AbbreviatedPlanRecoveryTimeObjectiveMinutesInteger", "documentation":"The recovery time objective that you've specified.
" } }, "documentation":"A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.
" }, "AbbreviatedPlanRecoveryTimeObjectiveMinutesInteger":{ "type":"integer", "box":true, "max":10080, "min":1 }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
HTTP Status Code: 403
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccountId":{ "type":"string", "pattern":"\\d{12}" }, "AlarmCondition":{ "type":"string", "enum":[ "red", "green" ] }, "AlarmType":{ "type":"string", "enum":[ "applicationHealth", "trigger" ] }, "Approval":{ "type":"string", "enum":[ "approve", "decline" ] }, "ApprovePlanExecutionStepRequest":{ "type":"structure", "required":[ "planArn", "executionId", "stepName", "approval" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "stepName":{ "shape":"StepName", "documentation":"The name of a step in a plan execution.
" }, "approval":{ "shape":"Approval", "documentation":"The status of approval for a plan execution step.
" }, "comment":{ "shape":"ExecutionComment", "documentation":"A comment that you can enter about a plan execution.
" } } }, "ApprovePlanExecutionStepResponse":{ "type":"structure", "members":{} }, "ArcRoutingControlConfiguration":{ "type":"structure", "required":["regionAndRoutingControls"], "members":{ "timeoutMinutes":{ "shape":"ArcRoutingControlConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "regionAndRoutingControls":{ "shape":"RegionAndRoutingControls", "documentation":"The Region and ARC routing controls for the configuration.
" } }, "documentation":"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.
" }, "ArcRoutingControlConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "ArcRoutingControlState":{ "type":"structure", "required":[ "routingControlArn", "state" ], "members":{ "routingControlArn":{ "shape":"RoutingControlArn", "documentation":"The Amazon Resource Name (ARN) of a routing control.
" }, "state":{ "shape":"RoutingControlStateChange", "documentation":"The state of an ARC routing control, On or Off.
" } }, "documentation":"Represents the state of an ARC routing control.
" }, "ArcRoutingControlStates":{ "type":"list", "member":{"shape":"ArcRoutingControlState"} }, "Asg":{ "type":"structure", "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "arn":{ "shape":"AsgArn", "documentation":"The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
" } }, "documentation":"Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
" }, "AsgArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:autoscaling:[a-z0-9-]+:\\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\\S\\s]{1,255}" }, "AsgList":{ "type":"list", "member":{"shape":"Asg"}, "max":2, "min":2 }, "AssociatedAlarm":{ "type":"structure", "required":[ "resourceIdentifier", "alarmType" ], "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "resourceIdentifier":{ "shape":"String", "documentation":"The resource identifier for alarms that you associate with a plan.
" }, "alarmType":{ "shape":"AlarmType", "documentation":"The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
" } }, "documentation":"An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
" }, "AssociatedAlarmMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AssociatedAlarm"} }, "AuroraClusterArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:rds:[a-z0-9-]+:\\d{12}:cluster:[A-Za-z][0-9A-Za-z-:._]*" }, "AuroraClusterArns":{ "type":"list", "member":{"shape":"AuroraClusterArn"} }, "CancelPlanExecutionRequest":{ "type":"structure", "required":[ "planArn", "executionId" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "comment":{ "shape":"ExecutionComment", "documentation":"A comment that you can enter about canceling a plan execution step.
" } } }, "CancelPlanExecutionResponse":{ "type":"structure", "members":{} }, "CreatePlanRequest":{ "type":"structure", "required":[ "workflows", "executionRole", "name", "regions", "recoveryApproach" ], "members":{ "description":{ "shape":"String", "documentation":"The description of a Region switch plan.
" }, "workflows":{ "shape":"WorkflowList", "documentation":"An array of workflows included in a Region switch plan.
" }, "executionRole":{ "shape":"IamRoleArn", "documentation":"An execution role is a way to categorize a Region switch plan.
" }, "recoveryTimeObjectiveMinutes":{ "shape":"CreatePlanRequestRecoveryTimeObjectiveMinutesInteger", "documentation":"Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.
" }, "associatedAlarms":{ "shape":"AssociatedAlarmMap", "documentation":"The alarms associated with a Region switch plan.
" }, "triggers":{ "shape":"TriggerList", "documentation":"The triggers associated with a Region switch plan.
" }, "reportConfiguration":{"shape":"ReportConfiguration"}, "name":{ "shape":"PlanName", "documentation":"The name of a Region switch plan.
" }, "regions":{ "shape":"RegionList", "documentation":"An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
" }, "recoveryApproach":{ "shape":"RecoveryApproach", "documentation":"The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
" }, "primaryRegion":{ "shape":"Region", "documentation":"The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.
" }, "tags":{ "shape":"Tags", "documentation":"The tags to apply to the Region switch plan.
" } } }, "CreatePlanRequestRecoveryTimeObjectiveMinutesInteger":{ "type":"integer", "box":true, "max":10080, "min":1 }, "CreatePlanResponse":{ "type":"structure", "members":{ "plan":{ "shape":"Plan", "documentation":"The details of the created Region switch plan.
" } } }, "CustomActionLambdaConfiguration":{ "type":"structure", "required":[ "lambdas", "retryIntervalMinutes", "regionToRun" ], "members":{ "timeoutMinutes":{ "shape":"CustomActionLambdaConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "lambdas":{ "shape":"LambdaList", "documentation":"The Amazon Web Services Lambda functions for the execution block.
" }, "retryIntervalMinutes":{ "shape":"Float", "documentation":"The retry interval specified.
" }, "regionToRun":{ "shape":"RegionToRunIn", "documentation":"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).
The settings for ungraceful execution.
" } }, "documentation":"Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.
" }, "CustomActionLambdaConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "DeletePlanRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" } } }, "DeletePlanResponse":{ "type":"structure", "members":{} }, "DocumentDbClusterArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:rds:[a-z0-9-]+:\\d{12}:cluster:[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}" }, "DocumentDbClusterArns":{ "type":"list", "member":{"shape":"DocumentDbClusterArn"} }, "DocumentDbConfiguration":{ "type":"structure", "required":[ "behavior", "globalClusterIdentifier", "databaseClusterArns" ], "members":{ "timeoutMinutes":{ "shape":"DocumentDbConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "behavior":{ "shape":"DocumentDbDefaultBehavior", "documentation":"The behavior for a global cluster, that is, only allow switchover or also allow failover.
" }, "ungraceful":{ "shape":"DocumentDbUngraceful", "documentation":"The settings for ungraceful execution.
" }, "globalClusterIdentifier":{ "shape":"DocumentDbGlobalClusterIdentifier", "documentation":"The global cluster identifier for a DocumentDB global cluster.
" }, "databaseClusterArns":{ "shape":"DocumentDbClusterArns", "documentation":"The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
" } }, "documentation":"Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
" }, "DocumentDbConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "DocumentDbDefaultBehavior":{ "type":"string", "enum":[ "switchoverOnly", "failover" ] }, "DocumentDbGlobalClusterIdentifier":{ "type":"string", "pattern":"[A-Za-z][0-9A-Za-z-:._]*" }, "DocumentDbUngraceful":{ "type":"structure", "members":{ "ungraceful":{ "shape":"DocumentDbUngracefulBehavior", "documentation":"The settings for ungraceful execution.
" } }, "documentation":"Configuration for handling failures when performing operations on DocumentDB global clusters.
" }, "DocumentDbUngracefulBehavior":{ "type":"string", "enum":["failover"] }, "Duration":{ "type":"string", "pattern":"P(?!$)(\\d+Y)?(\\d+M)?(\\d+D)?(T(?=\\d)(\\d+H)?(\\d+M)?(\\d+S)?)?" }, "Ec2AsgCapacityIncreaseConfiguration":{ "type":"structure", "required":["asgs"], "members":{ "timeoutMinutes":{ "shape":"Ec2AsgCapacityIncreaseConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "asgs":{ "shape":"AsgList", "documentation":"The EC2 Auto Scaling groups for the configuration.
" }, "ungraceful":{ "shape":"Ec2Ungraceful", "documentation":"The settings for ungraceful execution.
" }, "targetPercent":{ "shape":"Integer", "documentation":"The target percentage that you specify for EC2 Auto Scaling groups.
" }, "capacityMonitoringApproach":{ "shape":"Ec2AsgCapacityMonitoringApproach", "documentation":"The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
" } }, "documentation":"Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
" }, "Ec2AsgCapacityIncreaseConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "Ec2AsgCapacityMonitoringApproach":{ "type":"string", "enum":[ "sampledMaxInLast24Hours", "autoscalingMaxInLast24Hours" ] }, "Ec2Ungraceful":{ "type":"structure", "required":["minimumSuccessPercentage"], "members":{ "minimumSuccessPercentage":{ "shape":"Ec2UngracefulMinimumSuccessPercentageInteger", "documentation":"The minimum success percentage that you specify for EC2 Auto Scaling groups.
" } }, "documentation":"Configuration for handling failures when performing operations on EC2 resources.
" }, "Ec2UngracefulMinimumSuccessPercentageInteger":{ "type":"integer", "box":true, "max":99, "min":0 }, "EcsCapacityIncreaseConfiguration":{ "type":"structure", "required":["services"], "members":{ "timeoutMinutes":{ "shape":"EcsCapacityIncreaseConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "services":{ "shape":"ServiceList", "documentation":"The services specified for the configuration.
" }, "ungraceful":{ "shape":"EcsUngraceful", "documentation":"The settings for ungraceful execution.
" }, "targetPercent":{ "shape":"Integer", "documentation":"The target percentage specified for the configuration.
" }, "capacityMonitoringApproach":{ "shape":"EcsCapacityMonitoringApproach", "documentation":"The monitoring approach specified for the configuration, for example, Most_Recent.
The configuration for an Amazon Web Services ECS capacity increase.
" }, "EcsCapacityIncreaseConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "EcsCapacityMonitoringApproach":{ "type":"string", "enum":[ "sampledMaxInLast24Hours", "containerInsightsMaxInLast24Hours" ] }, "EcsClusterArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\\d{12}:cluster/[a-zA-Z0-9_-]{1,255}" }, "EcsServiceArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\\d{12}:service/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]{1,255}" }, "EcsUngraceful":{ "type":"structure", "required":["minimumSuccessPercentage"], "members":{ "minimumSuccessPercentage":{ "shape":"EcsUngracefulMinimumSuccessPercentageInteger", "documentation":"The minimum success percentage specified for the configuration.
" } }, "documentation":"The settings for ungraceful execution.
" }, "EcsUngracefulMinimumSuccessPercentageInteger":{ "type":"integer", "box":true, "max":99, "min":0 }, "EksCapacityMonitoringApproach":{ "type":"string", "enum":["sampledMaxInLast24Hours"] }, "EksCluster":{ "type":"structure", "required":["clusterArn"], "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "clusterArn":{ "shape":"EksClusterArn", "documentation":"The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
" } }, "documentation":"The Amazon Web Services EKS cluster execution block configuration.
" }, "EksClusterArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}" }, "EksClusters":{ "type":"list", "member":{"shape":"EksCluster"}, "min":2 }, "EksResourceScalingConfiguration":{ "type":"structure", "required":["kubernetesResourceType"], "members":{ "timeoutMinutes":{ "shape":"EksResourceScalingConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "kubernetesResourceType":{ "shape":"KubernetesResourceType", "documentation":"The Kubernetes resource type for the configuration.
" }, "scalingResources":{ "shape":"KubernetesScalingApps", "documentation":"The scaling resources for the configuration.
" }, "eksClusters":{ "shape":"EksClusters", "documentation":"The clusters for the configuration.
" }, "ungraceful":{ "shape":"EksResourceScalingUngraceful", "documentation":"The settings for ungraceful execution.
" }, "targetPercent":{ "shape":"EksResourceScalingConfigurationTargetPercentInteger", "documentation":"The target percentage for the configuration.
" }, "capacityMonitoringApproach":{ "shape":"EksCapacityMonitoringApproach", "documentation":"The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
" } }, "documentation":"The Amazon Web Services EKS resource scaling configuration.
" }, "EksResourceScalingConfigurationTargetPercentInteger":{ "type":"integer", "box":true, "min":1 }, "EksResourceScalingConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "EksResourceScalingUngraceful":{ "type":"structure", "required":["minimumSuccessPercentage"], "members":{ "minimumSuccessPercentage":{ "shape":"EksResourceScalingUngracefulMinimumSuccessPercentageInteger", "documentation":"The minimum success percentage for the configuration.
" } }, "documentation":"The ungraceful settings for Amazon Web Services EKS resource scaling.
" }, "EksResourceScalingUngracefulMinimumSuccessPercentageInteger":{ "type":"integer", "box":true, "max":99, "min":0 }, "EvaluationStatus":{ "type":"string", "enum":[ "passed", "actionRequired", "pendingEvaluation", "unknown" ] }, "ExecutionAction":{ "type":"string", "enum":[ "activate", "deactivate", "postRecovery" ] }, "ExecutionApprovalConfiguration":{ "type":"structure", "required":["approvalRole"], "members":{ "timeoutMinutes":{ "shape":"ExecutionApprovalConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "approvalRole":{ "shape":"RoleArn", "documentation":"The IAM approval role for the configuration.
" } }, "documentation":"Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.
" }, "ExecutionApprovalConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "ExecutionBlockConfiguration":{ "type":"structure", "members":{ "customActionLambdaConfig":{ "shape":"CustomActionLambdaConfiguration", "documentation":"An Amazon Web Services Lambda execution block.
" }, "ec2AsgCapacityIncreaseConfig":{ "shape":"Ec2AsgCapacityIncreaseConfiguration", "documentation":"An EC2 Auto Scaling group execution block.
" }, "executionApprovalConfig":{ "shape":"ExecutionApprovalConfiguration", "documentation":"A manual approval execution block.
" }, "arcRoutingControlConfig":{ "shape":"ArcRoutingControlConfiguration", "documentation":"An ARC routing control execution block.
" }, "globalAuroraConfig":{ "shape":"GlobalAuroraConfiguration", "documentation":"An Aurora Global Database execution block.
" }, "parallelConfig":{ "shape":"ParallelExecutionBlockConfiguration", "documentation":"A parallel configuration execution block.
" }, "regionSwitchPlanConfig":{ "shape":"RegionSwitchPlanConfiguration", "documentation":"A Region switch plan execution block.
" }, "ecsCapacityIncreaseConfig":{ "shape":"EcsCapacityIncreaseConfiguration", "documentation":"The capacity increase specified for the configuration.
" }, "eksResourceScalingConfig":{ "shape":"EksResourceScalingConfiguration", "documentation":"An Amazon Web Services EKS resource scaling execution block.
" }, "route53HealthCheckConfig":{ "shape":"Route53HealthCheckConfiguration", "documentation":"The Amazon Route 53 health check configuration.
" }, "documentDbConfig":{"shape":"DocumentDbConfiguration"}, "rdsPromoteReadReplicaConfig":{ "shape":"RdsPromoteReadReplicaConfiguration", "documentation":"An Amazon RDS promote read replica execution block.
" }, "rdsCreateCrossRegionReadReplicaConfig":{ "shape":"RdsCreateCrossRegionReplicaConfiguration", "documentation":"An Amazon RDS create cross-Region replica execution block.
" } }, "documentation":"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.
", "union":true }, "ExecutionBlockType":{ "type":"string", "enum":[ "CustomActionLambda", "ManualApproval", "AuroraGlobalDatabase", "EC2AutoScaling", "ARCRoutingControl", "ARCRegionSwitchPlan", "Parallel", "ECSServiceScaling", "EKSResourceScaling", "Route53HealthCheck", "DocumentDb", "RdsPromoteReadReplica", "RdsCreateCrossRegionReplica" ] }, "ExecutionComment":{ "type":"string", "max":1024, "min":0 }, "ExecutionEvent":{ "type":"structure", "required":["eventId"], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"The timestamp for an execution event.
" }, "type":{ "shape":"ExecutionEventType", "documentation":"The type of an execution event.
" }, "stepName":{ "shape":"StepName", "documentation":"The step name for an execution event.
" }, "executionBlockType":{ "shape":"ExecutionBlockType", "documentation":"The execution block type for an execution event.
" }, "resources":{ "shape":"Resources", "documentation":"The resources for an execution event.
" }, "error":{ "shape":"String", "documentation":"Errors for an execution event.
" }, "description":{ "shape":"String", "documentation":"The description for an execution event.
" }, "eventId":{ "shape":"String", "documentation":"The event ID for an execution event.
" }, "previousEventId":{ "shape":"String", "documentation":"The event ID of the previous execution event.
" } }, "documentation":"Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.
" }, "ExecutionEventList":{ "type":"list", "member":{"shape":"ExecutionEvent"} }, "ExecutionEventType":{ "type":"string", "enum":[ "unknown", "executionPending", "executionStarted", "executionSucceeded", "executionFailed", "executionPausing", "executionPaused", "executionCanceling", "executionCanceled", "executionPendingApproval", "executionBehaviorChangedToUngraceful", "executionBehaviorChangedToGraceful", "executionPendingChildPlanManualApproval", "executionSuccessMonitoringApplicationHealth", "stepStarted", "stepUpdate", "stepSucceeded", "stepFailed", "stepSkipped", "stepPausedByError", "stepPausedByOperator", "stepCanceled", "stepPendingApproval", "stepExecutionBehaviorChangedToUngraceful", "stepPendingApplicationHealthMonitor", "planEvaluationWarning" ] }, "ExecutionId":{"type":"string"}, "ExecutionMode":{ "type":"string", "enum":[ "graceful", "ungraceful" ] }, "ExecutionState":{ "type":"string", "enum":[ "inProgress", "pausedByFailedStep", "pausedByOperator", "completed", "completedWithExceptions", "canceled", "planExecutionTimedOut", "pendingManualApproval", "failed", "pending", "completedMonitoringApplicationHealth" ] }, "FailedReportErrorCode":{ "type":"string", "enum":[ "insufficientPermissions", "invalidResource", "configurationError" ] }, "FailedReportOutput":{ "type":"structure", "members":{ "errorCode":{ "shape":"FailedReportErrorCode", "documentation":"The error code for the failed report generation.
" }, "errorMessage":{ "shape":"String", "documentation":"The error message for the failed report generation.
" } }, "documentation":"Information about a report generation that failed.
" }, "Float":{ "type":"float", "box":true }, "GeneratedReport":{ "type":"structure", "members":{ "reportGenerationTime":{ "shape":"Timestamp", "documentation":"The timestamp when the report was generated.
" }, "reportOutput":{ "shape":"ReportOutput", "documentation":"The output location or cause of a failure in report generation.
" } }, "documentation":"Information about a generated execution report.
" }, "GeneratedReportDetails":{ "type":"list", "member":{"shape":"GeneratedReport"}, "max":1, "min":0 }, "GetPlanEvaluationStatusRequest":{ "type":"structure", "required":["planArn"], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The number of objects that you want to return with this call.
" }, "nextToken":{ "shape":"NextToken", "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 Amazon Resource Name (ARN) of the plan.
" }, "lastEvaluationTime":{ "shape":"Timestamp", "documentation":"The time of the last time that Region switch ran an evaluation of the plan.
" }, "lastEvaluatedVersion":{ "shape":"String", "documentation":"The version of the last evaluation of the plan.
" }, "region":{ "shape":"Region", "documentation":"The Amazon Web Services Region for the plan.
" }, "evaluationState":{ "shape":"EvaluationStatus", "documentation":"The evaluation state for the plan.
" }, "warnings":{ "shape":"PlanWarnings", "documentation":"The current evaluation warnings for the plan.
" }, "nextToken":{ "shape":"NextToken", "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 Amazon Resource Name (ARN) of the plan with the execution to retrieve.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "maxResults":{ "shape":"GetPlanExecutionStepStatesMaxResults", "documentation":"The number of objects that you want to return with this call.
" }, "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 Amazon Resource Name (ARN) of the plan.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "version":{ "shape":"String", "documentation":"The version for the plan.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the plan execution was last updated.
" }, "comment":{ "shape":"String", "documentation":"A comment included on the plan execution.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time (UTC) when the plan execution started.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The time (UTC) when the plan execution ended.
" }, "mode":{ "shape":"ExecutionMode", "documentation":"The plan execution mode. Valid values are graceful, for graceful executions, or ungraceful, for ungraceful executions.
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
" }, "executionAction":{ "shape":"ExecutionAction", "documentation":"The plan execution action. Valid values are activate, to activate an Amazon Web Services Region, or deactivate, to deactivate a Region.
The Amazon Web Services Region for a plan execution.
" }, "recoveryExecutionId":{ "shape":"String", "documentation":"The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.
" }, "stepStates":{ "shape":"StepStates", "documentation":"The states of the steps in the plan execution.
" }, "plan":{ "shape":"Plan", "documentation":"The details of the Region switch plan.
" }, "actualRecoveryTime":{ "shape":"Duration", "documentation":"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.
" }, "generatedReportDetails":{ "shape":"GeneratedReportDetails", "documentation":"Information about the location of a generated report, or the cause of its failure.
" }, "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 Amazon Resource Name (ARN) of the plan in Region.
" } } }, "GetPlanInRegionResponse":{ "type":"structure", "members":{ "plan":{ "shape":"Plan", "documentation":"The details of the Region switch plan.
" } } }, "GetPlanRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" } } }, "GetPlanResponse":{ "type":"structure", "members":{ "plan":{ "shape":"Plan", "documentation":"The detailed information about the requested Region switch plan.
" } } }, "GlobalAuroraConfiguration":{ "type":"structure", "required":[ "behavior", "globalClusterIdentifier", "databaseClusterArns" ], "members":{ "timeoutMinutes":{ "shape":"GlobalAuroraConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "behavior":{ "shape":"GlobalAuroraDefaultBehavior", "documentation":"The behavior for a global database, that is, only allow switchover or also allow failover.
" }, "ungraceful":{ "shape":"GlobalAuroraUngraceful", "documentation":"The settings for ungraceful execution.
" }, "globalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"The global cluster identifier for a global database.
" }, "databaseClusterArns":{ "shape":"AuroraClusterArns", "documentation":"The database cluster Amazon Resource Names (ARNs) for a global database.
" } }, "documentation":"Configuration for Amazon Aurora global databases used in a Region switch plan.
" }, "GlobalAuroraConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "GlobalAuroraDefaultBehavior":{ "type":"string", "enum":[ "switchoverOnly", "failover" ] }, "GlobalAuroraUngraceful":{ "type":"structure", "members":{ "ungraceful":{ "shape":"GlobalAuroraUngracefulBehavior", "documentation":"The settings for ungraceful execution.
" } }, "documentation":"Configuration for handling failures when performing operations on Aurora global databases.
" }, "GlobalAuroraUngracefulBehavior":{ "type":"string", "enum":["failover"] }, "GlobalClusterIdentifier":{ "type":"string", "max":255, "min":1, "pattern":"[A-Za-z][0-9A-Za-z-:._]*" }, "IamRoleArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+" }, "IllegalArgumentException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request processing has an invalid argument.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "IllegalStateException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The operation failed because the current state of the resource doesn't allow the operation to proceed.
HTTP Status Code: 400
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KubernetesNamespace":{ "type":"string", "pattern":"[a-z0-9][a-z0-9-]{0,61}[a-z0-9]" }, "KubernetesResourceType":{ "type":"structure", "required":[ "apiVersion", "kind" ], "members":{ "apiVersion":{ "shape":"String", "documentation":"The API version type for the Kubernetes resource.
" }, "kind":{ "shape":"String", "documentation":"The kind for the Kubernetes resource.
" } }, "documentation":"Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
" }, "KubernetesScalingApplication":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"RegionalScalingResource"} }, "KubernetesScalingApps":{ "type":"list", "member":{"shape":"KubernetesScalingApplication"}, "min":1 }, "KubernetesScalingResource":{ "type":"structure", "required":[ "namespace", "name" ], "members":{ "namespace":{ "shape":"KubernetesNamespace", "documentation":"The namespace for the Kubernetes resource.
" }, "name":{ "shape":"String", "documentation":"The name for the Kubernetes resource.
" }, "hpaName":{ "shape":"String", "documentation":"The hpaname for the Kubernetes resource.
" } }, "documentation":"Defines a Kubernetes resource to scale in an Amazon EKS cluster.
" }, "LambdaArn":{"type":"string"}, "LambdaList":{ "type":"list", "member":{"shape":"Lambdas"}, "max":2, "min":1 }, "LambdaUngraceful":{ "type":"structure", "members":{ "behavior":{ "shape":"LambdaUngracefulBehavior", "documentation":"The ungraceful behavior for a Lambda function, which must be set to skip.
Configuration for handling failures when invoking Lambda functions.
" }, "LambdaUngracefulBehavior":{ "type":"string", "enum":["skip"] }, "Lambdas":{ "type":"structure", "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "arn":{ "shape":"LambdaArn", "documentation":"The Amazon Resource Name (ARN) of the Lambda function.
" } }, "documentation":"Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
" }, "ListExecutionEventsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListExecutionsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListPlanExecutionEventsRequest":{ "type":"structure", "required":[ "planArn", "executionId" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "maxResults":{ "shape":"ListExecutionEventsMaxResults", "documentation":"The number of objects that you want to return with this call.
" }, "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 name of the plan execution event.
" } } }, "ListPlanExecutionEventsResponse":{ "type":"structure", "members":{ "items":{ "shape":"ExecutionEventList", "documentation":"The items in the plan execution event.
" }, "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 ARN for the plan.
" }, "maxResults":{ "shape":"ListExecutionsMaxResults", "documentation":"The number of objects that you want to return with this call.
" }, "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 state of the plan execution. For example, the plan execution might be In Progress.
" } } }, "ListPlanExecutionsResponse":{ "type":"structure", "members":{ "items":{ "shape":"AbbreviatedExecutionsList", "documentation":"The items in the plan execution to return.
" }, "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.
" }, "nextToken":{ "shape":"NextToken", "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 plans that were requested.
" }, "nextToken":{ "shape":"NextToken", "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.
" }, "nextToken":{ "shape":"NextToken", "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 plans that were requested.
" }, "nextToken":{ "shape":"NextToken", "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 Amazon Resource Name (ARN) of the Arc Region Switch Plan.
" }, "hostedZoneId":{ "shape":"Route53HostedZoneId", "documentation":"The hosted zone ID for the health checks.
" }, "recordName":{ "shape":"Route53RecordName", "documentation":"The record name for the health checks.
" }, "maxResults":{ "shape":"ListRoute53HealthChecksInRegionRequestMaxResultsInteger", "documentation":"The number of objects that you want to return with this call.
" }, "nextToken":{ "shape":"NextToken", "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.
List of the health checks requested.
" }, "nextToken":{ "shape":"NextToken", "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 Amazon Resource Name (ARN) of the Amazon Route 53 health check request.
" }, "hostedZoneId":{ "shape":"Route53HostedZoneId", "documentation":"The hosted zone ID for the health checks.
" }, "recordName":{ "shape":"Route53RecordName", "documentation":"The record name for the health checks.
" }, "maxResults":{ "shape":"ListRoute53HealthChecksRequestMaxResultsInteger", "documentation":"The number of objects that you want to return with this call.
" }, "nextToken":{ "shape":"NextToken", "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.
List of the health checks requested.
" }, "nextToken":{ "shape":"NextToken", "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 Amazon Resource Name (ARN) of the resource.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "resourceTags":{ "shape":"Tags", "documentation":"The tags for a resource.
" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MinimalWorkflow":{ "type":"structure", "members":{ "action":{ "shape":"ExecutionAction", "documentation":"The action for a minimal workflow, which can be Activate or Deactivate.
" }, "name":{ "shape":"String", "documentation":"The name for a minimal workflow
" } }, "documentation":"A simplified representation of a workflow in a Region switch plan.
" }, "NextToken":{ "type":"string", "max":2048, "min":1 }, "ParallelExecutionBlockConfiguration":{ "type":"structure", "required":["steps"], "members":{ "steps":{ "shape":"Steps", "documentation":"The steps for a parallel execution block.
" } }, "documentation":"Configuration for steps that should be executed in parallel during a Region switch.
" }, "Plan":{ "type":"structure", "required":[ "arn", "workflows", "executionRole", "name", "regions", "recoveryApproach", "owner" ], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "description":{ "shape":"String", "documentation":"The description for a plan.
" }, "workflows":{ "shape":"WorkflowList", "documentation":"The workflows for a plan.
" }, "executionRole":{ "shape":"IamRoleArn", "documentation":"The execution role for a plan.
" }, "recoveryTimeObjectiveMinutes":{ "shape":"PlanRecoveryTimeObjectiveMinutesInteger", "documentation":"The recovery time objective for a plan.
" }, "associatedAlarms":{ "shape":"AssociatedAlarmMap", "documentation":"The associated application health alarms for a plan.
" }, "triggers":{ "shape":"TriggerList", "documentation":"The triggers for a plan.
" }, "reportConfiguration":{ "shape":"ReportConfiguration", "documentation":"The report configuration for a plan.
" }, "name":{ "shape":"PlanName", "documentation":"The name for a plan.
" }, "regions":{ "shape":"RegionList", "documentation":"The Amazon Web Services Regions for a plan.
" }, "recoveryApproach":{ "shape":"RecoveryApproach", "documentation":"The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
" }, "primaryRegion":{ "shape":"Region", "documentation":"The primary Region for a plan.
" }, "owner":{ "shape":"AccountId", "documentation":"The owner of a plan.
" }, "version":{ "shape":"String", "documentation":"The version for the plan.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the plan was last updated.
" } }, "documentation":"Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
" }, "PlanArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})" }, "PlanList":{ "type":"list", "member":{"shape":"AbbreviatedPlan"} }, "PlanName":{ "type":"string", "max":32, "min":1, "pattern":"[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?" }, "PlanRecoveryTimeObjectiveMinutesInteger":{ "type":"integer", "box":true, "max":10080, "min":1 }, "PlanWarnings":{ "type":"list", "member":{"shape":"ResourceWarning"} }, "RdsCreateCrossRegionReplicaConfiguration":{ "type":"structure", "required":["dbInstanceArnMap"], "members":{ "timeoutMinutes":{ "shape":"RdsCreateCrossRegionReplicaConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross-account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "dbInstanceArnMap":{ "shape":"RdsDbInstanceArnMap", "documentation":"A map of database instance ARNs for each Region in the plan.
" } }, "documentation":"Configuration for creating an Amazon RDS cross-Region read replica during post-recovery in a Region switch.
" }, "RdsCreateCrossRegionReplicaConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "RdsDbInstanceArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:rds:[a-z0-9-]+:\\d{12}:db:[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "RdsDbInstanceArnMap":{ "type":"map", "key":{"shape":"Region"}, "value":{"shape":"RdsDbInstanceArn"} }, "RdsPromoteReadReplicaConfiguration":{ "type":"structure", "required":["dbInstanceArnMap"], "members":{ "timeoutMinutes":{ "shape":"RdsPromoteReadReplicaConfigurationTimeoutMinutesInteger", "documentation":"The timeout value specified for the configuration.
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross-account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "dbInstanceArnMap":{ "shape":"RdsDbInstanceArnMap", "documentation":"A map of database instance ARNs for each Region in the plan.
" } }, "documentation":"Configuration for promoting an Amazon RDS read replica to a standalone database instance during a Region switch.
" }, "RdsPromoteReadReplicaConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "RecoveryApproach":{ "type":"string", "enum":[ "activeActive", "activePassive" ] }, "RecoveryExecutionId":{ "type":"string", "pattern":"[a-z]{2}(-[a-z]+)+-[0-9]+/[0-9a-fA-F]{16}" }, "Region":{ "type":"string", "pattern":"[a-z]{2}-[a-z-]+-\\d+" }, "RegionAndRoutingControls":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ArcRoutingControlStates"} }, "RegionList":{ "type":"list", "member":{"shape":"Region"}, "max":2, "min":2 }, "RegionSwitchPlanConfiguration":{ "type":"structure", "required":["arn"], "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan configuration.
" } }, "documentation":"Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.
" }, "RegionToRunIn":{ "type":"string", "enum":[ "activatingRegion", "deactivatingRegion", "activeRegion", "inactiveRegion" ] }, "RegionalScalingResource":{ "type":"map", "key":{"shape":"Region"}, "value":{"shape":"KubernetesScalingResource"} }, "ReportConfiguration":{ "type":"structure", "members":{ "reportOutput":{ "shape":"ReportOutputList", "documentation":"The output configuration for the report.
" } }, "documentation":"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.
" }, "ReportOutput":{ "type":"structure", "members":{ "s3ReportOutput":{ "shape":"S3ReportOutput", "documentation":"Information about a report delivered to Amazon S3.
" }, "failedReportOutput":{ "shape":"FailedReportOutput", "documentation":"The details about a failed report generation.
" } }, "documentation":"The output location or cause of a failure in report generation.
", "union":true }, "ReportOutputConfiguration":{ "type":"structure", "members":{ "s3Configuration":{ "shape":"S3ReportOutputConfiguration", "documentation":"Configuration for delivering reports to an Amazon S3 bucket.
" } }, "documentation":"Configuration for report output destinations used in a Region switch plan.
", "union":true }, "ReportOutputList":{ "type":"list", "member":{"shape":"ReportOutputConfiguration"}, "max":1, "min":1 }, "ResourceArn":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The specified resource was not found.
HTTP Status Code: 404
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceWarning":{ "type":"structure", "required":[ "version", "warningStatus", "warningUpdatedTime", "warningMessage" ], "members":{ "workflow":{ "shape":"MinimalWorkflow", "documentation":"The workflow for the resource warning.
" }, "version":{ "shape":"String", "documentation":"The version for the resource warning.
" }, "stepName":{ "shape":"StepName", "documentation":"The name of the step for the resource warning.
" }, "resourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource.
" }, "warningStatus":{ "shape":"ResourceWarningStatus", "documentation":"The status of the resource warning.
" }, "warningUpdatedTime":{ "shape":"Timestamp", "documentation":"The timestamp when the warning was last updated.
" }, "warningMessage":{ "shape":"String", "documentation":"The warning message about what needs to be corrected.
" } }, "documentation":"Represents a warning about a resource in a Region switch plan.
" }, "ResourceWarningStatus":{ "type":"string", "enum":[ "active", "resolved" ] }, "Resources":{ "type":"list", "member":{"shape":"String"} }, "RoleArn":{"type":"string"}, "Route53HealthCheck":{ "type":"structure", "required":[ "hostedZoneId", "recordName", "region" ], "members":{ "hostedZoneId":{ "shape":"Route53HostedZoneId", "documentation":"The Amazon Route 53 health check hosted zone ID.
" }, "recordName":{ "shape":"Route53RecordName", "documentation":"The Amazon Route 53 record name.
" }, "healthCheckId":{ "shape":"Route53HealthCheckId", "documentation":"The Amazon Route 53 health check ID.
" }, "status":{ "shape":"Route53HealthCheckStatus", "documentation":"The Amazon Route 53 health check status.
" }, "region":{ "shape":"Region", "documentation":"The Amazon Route 53 Region.
" } }, "documentation":"The Amazon Route 53 health check.
" }, "Route53HealthCheckConfiguration":{ "type":"structure", "required":[ "hostedZoneId", "recordName" ], "members":{ "timeoutMinutes":{ "shape":"Route53HealthCheckConfigurationTimeoutMinutesInteger", "documentation":"The Amazon Route 53 health check configuration time out (in minutes).
" }, "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for the configuration.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the configuration.
" }, "hostedZoneId":{ "shape":"Route53HostedZoneId", "documentation":"The Amazon Route 53 health check configuration hosted zone ID.
" }, "recordName":{ "shape":"Route53RecordName", "documentation":"The Amazon Route 53 health check configuration record name.
" }, "recordSets":{ "shape":"Route53ResourceRecordSetList", "documentation":"The Amazon Route 53 health check configuration record sets.
" } }, "documentation":"The Amazon Route 53 health check configuration.
" }, "Route53HealthCheckConfigurationTimeoutMinutesInteger":{ "type":"integer", "box":true, "min":1 }, "Route53HealthCheckId":{ "type":"string", "max":64, "min":1 }, "Route53HealthCheckList":{ "type":"list", "member":{"shape":"Route53HealthCheck"} }, "Route53HealthCheckStatus":{ "type":"string", "enum":[ "healthy", "unhealthy", "unknown" ] }, "Route53HostedZoneId":{ "type":"string", "max":32, "min":1 }, "Route53RecordName":{ "type":"string", "max":1024, "min":1 }, "Route53ResourceRecordSet":{ "type":"structure", "members":{ "recordSetIdentifier":{ "shape":"Route53ResourceRecordSetIdentifier", "documentation":"The Amazon Route 53 record set identifier.
" }, "region":{ "shape":"Region", "documentation":"The Amazon Route 53 record set Region.
" } }, "documentation":"The Amazon Route 53 record set.
" }, "Route53ResourceRecordSetIdentifier":{ "type":"string", "max":1024, "min":1 }, "Route53ResourceRecordSetList":{ "type":"list", "member":{"shape":"Route53ResourceRecordSet"} }, "RoutingControlArn":{"type":"string"}, "RoutingControlStateChange":{ "type":"string", "enum":[ "On", "Off" ] }, "S3ReportOutput":{ "type":"structure", "members":{ "s3ObjectKey":{ "shape":"String", "documentation":"The S3 object key where the generated report is stored.
" } }, "documentation":"Information about a report delivered to Amazon S3.
" }, "S3ReportOutputConfiguration":{ "type":"structure", "members":{ "bucketPath":{ "shape":"S3ReportOutputConfigurationBucketPathString", "documentation":"The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
" }, "bucketOwner":{ "shape":"AccountId", "documentation":"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.
" } }, "documentation":"Configuration for delivering generated reports to an Amazon S3 bucket.
" }, "S3ReportOutputConfigurationBucketPathString":{ "type":"string", "max":512, "min":3, "pattern":"(?:s3://)?[a-z0-9][a-z0-9-]{1,61}[a-z0-9](?:/[^/ ][^/]*)*/?" }, "Service":{ "type":"structure", "members":{ "crossAccountRole":{ "shape":"IamRoleArn", "documentation":"The cross account role for a service.
" }, "externalId":{ "shape":"String", "documentation":"The external ID (secret key) for the service.
" }, "clusterArn":{ "shape":"EcsClusterArn", "documentation":"The cluster Amazon Resource Name (ARN) for a service.
" }, "serviceArn":{ "shape":"EcsServiceArn", "documentation":"The Amazon Resource Name (ARN) for a service.
" } }, "documentation":"The service for a cross account role.
" }, "ServiceList":{ "type":"list", "member":{"shape":"Service"}, "max":2, "min":2 }, "StartPlanExecutionRequest":{ "type":"structure", "required":[ "planArn", "targetRegion", "action" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan to execute.
" }, "targetRegion":{ "shape":"String", "documentation":"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.
" }, "action":{ "shape":"ExecutionAction", "documentation":"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).
The plan execution mode. Valid values are graceful, for starting the execution in graceful mode, or ungraceful, for starting the execution in ungraceful mode.
An optional comment explaining why the plan execution is being started.
" }, "latestVersion":{ "shape":"String", "documentation":"A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
" }, "recoveryExecutionId":{ "shape":"RecoveryExecutionId", "documentation":"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.
" } } }, "StartPlanExecutionResponse":{ "type":"structure", "members":{ "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "plan":{ "shape":"PlanArn", "documentation":"The details of the Region switch plan.
" }, "planVersion":{ "shape":"String", "documentation":"The version of the plan, a unique number generated by Region switch.
" }, "activateRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region to activate.
" }, "deactivateRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region to deactivate.
" } } }, "Step":{ "type":"structure", "required":[ "name", "executionBlockConfiguration", "executionBlockType" ], "members":{ "name":{ "shape":"StepName", "documentation":"The name of a step in a workflow.
" }, "description":{ "shape":"String", "documentation":"The description of a step in a workflow.
" }, "executionBlockConfiguration":{ "shape":"ExecutionBlockConfiguration", "documentation":"The configuration for an execution block in a workflow.
" }, "executionBlockType":{ "shape":"ExecutionBlockType", "documentation":"The type of an execution block in a workflow.
" } }, "documentation":"Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
" }, "StepName":{"type":"string"}, "StepState":{ "type":"structure", "members":{ "name":{ "shape":"StepName", "documentation":"The name of a step in a workflow.
" }, "status":{ "shape":"StepStatus", "documentation":"The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The timestamp when a step started execution.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The timestamp when a step endeded execution.
" }, "stepMode":{ "shape":"ExecutionMode", "documentation":"The mode for a step execution. The mode can be Graceful or Ungraceful.
" } }, "documentation":"Represents the state of a step in a plan execution.
" }, "StepStates":{ "type":"list", "member":{"shape":"StepState"} }, "StepStatus":{ "type":"string", "enum":[ "notStarted", "running", "failed", "completed", "canceled", "skipped", "pendingApproval" ] }, "Steps":{ "type":"list", "member":{"shape":"Step"} }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "arn", "tags" ], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) for a tag that you add to a resource.
" }, "tags":{ "shape":"Tags", "documentation":"Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":0 }, "Timestamp":{"type":"timestamp"}, "Trigger":{ "type":"structure", "required":[ "targetRegion", "action", "conditions", "minDelayMinutesBetweenExecutions" ], "members":{ "description":{ "shape":"String", "documentation":"The description for a trigger.
" }, "targetRegion":{ "shape":"Region", "documentation":"The Amazon Web Services Region for a trigger.
" }, "action":{ "shape":"WorkflowTargetAction", "documentation":"The action to perform when the trigger fires. Valid values include activate and deactivate.
The conditions that must be met for the trigger to fire.
" }, "minDelayMinutesBetweenExecutions":{ "shape":"Integer", "documentation":"The minimum time, in minutes, that must elapse between automatic executions of the plan.
" } }, "documentation":"Defines a condition that can automatically trigger the execution of a Region switch plan.
" }, "TriggerCondition":{ "type":"structure", "required":[ "associatedAlarmName", "condition" ], "members":{ "associatedAlarmName":{ "shape":"String", "documentation":"The name of the CloudWatch alarm associated with the condition.
" }, "condition":{ "shape":"AlarmCondition", "documentation":"The condition that must be met. Valid values include green and red.
Defines a condition that must be met for a trigger to fire.
" }, "TriggerConditionList":{ "type":"list", "member":{"shape":"TriggerCondition"}, "max":10, "min":1 }, "TriggerList":{ "type":"list", "member":{"shape":"Trigger"} }, "UntagResourceRequest":{ "type":"structure", "required":[ "arn", "resourceTagKeys" ], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) for a tag you remove a resource from.
" }, "resourceTagKeys":{ "shape":"TagKeys", "documentation":"Tag keys that you remove from a resource.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdatePlanExecutionAction":{ "type":"string", "enum":[ "switchToGraceful", "switchToUngraceful", "pause", "resume" ] }, "UpdatePlanExecutionRequest":{ "type":"structure", "required":[ "planArn", "executionId", "action" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan with the execution to update.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The execution identifier of a plan execution.
" }, "action":{ "shape":"UpdatePlanExecutionAction", "documentation":"The action specified for a plan execution, for example, Switch to Graceful or Pause.
" }, "comment":{ "shape":"ExecutionComment", "documentation":"An optional comment about the plan execution.
" } } }, "UpdatePlanExecutionResponse":{ "type":"structure", "members":{} }, "UpdatePlanExecutionStepAction":{ "type":"string", "enum":[ "switchToUngraceful", "skip" ] }, "UpdatePlanExecutionStepRequest":{ "type":"structure", "required":[ "planArn", "executionId", "comment", "stepName", "actionToTake" ], "members":{ "planArn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan containing the execution step to update.
" }, "executionId":{ "shape":"ExecutionId", "documentation":"The unique identifier of the plan execution containing the step to update.
" }, "comment":{ "shape":"ExecutionComment", "documentation":"An optional comment about the plan execution.
" }, "stepName":{ "shape":"String", "documentation":"The name of the execution step to update.
" }, "actionToTake":{ "shape":"UpdatePlanExecutionStepAction", "documentation":"The updated action to take for the step. This can be used to skip or retry a step.
" } } }, "UpdatePlanExecutionStepResponse":{ "type":"structure", "members":{} }, "UpdatePlanRequest":{ "type":"structure", "required":[ "arn", "workflows", "executionRole" ], "members":{ "arn":{ "shape":"PlanArn", "documentation":"The Amazon Resource Name (ARN) of the plan.
" }, "description":{ "shape":"String", "documentation":"The updated description for the Region switch plan.
" }, "workflows":{ "shape":"WorkflowList", "documentation":"The updated workflows for the Region switch plan.
" }, "executionRole":{ "shape":"IamRoleArn", "documentation":"The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
" }, "recoveryTimeObjectiveMinutes":{ "shape":"UpdatePlanRequestRecoveryTimeObjectiveMinutesInteger", "documentation":"The updated target recovery time objective (RTO) in minutes for the plan.
" }, "associatedAlarms":{ "shape":"AssociatedAlarmMap", "documentation":"The updated CloudWatch alarms associated with the plan.
" }, "triggers":{ "shape":"TriggerList", "documentation":"The updated conditions that can automatically trigger the execution of the plan.
" }, "reportConfiguration":{ "shape":"ReportConfiguration", "documentation":"The updated report configuration for the plan.
" } } }, "UpdatePlanRequestRecoveryTimeObjectiveMinutesInteger":{ "type":"integer", "box":true, "max":10080, "min":1 }, "UpdatePlanResponse":{ "type":"structure", "members":{ "plan":{ "shape":"Plan", "documentation":"The details of the updated Region switch plan.
" } } }, "Workflow":{ "type":"structure", "required":["workflowTargetAction"], "members":{ "steps":{ "shape":"Steps", "documentation":"The steps that make up the workflow.
" }, "workflowTargetAction":{ "shape":"WorkflowTargetAction", "documentation":"The action that the workflow performs. Valid values include activate and deactivate.
The Amazon Web Services Region that the workflow targets.
" }, "workflowDescription":{ "shape":"String", "documentation":"The description of the workflow.
" } }, "documentation":"Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
" }, "WorkflowList":{ "type":"list", "member":{"shape":"Workflow"} }, "WorkflowTargetAction":{ "type":"string", "enum":[ "activate", "deactivate", "postRecovery" ] } }, "documentation":"Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another.
Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.
For more information, see Region switch in ARC in the Amazon Application Recovery Controller User Guide.
" }