[ aws . arc-region-switch ]
get-plan-execution¶
Description¶
Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
See also: AWS API Documentation
get-plan-execution is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: stepStates
Synopsis¶
get-plan-execution
--plan-arn <value>
--execution-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--plan-arn (string)
The Amazon Resource Name (ARN) of the plan with the execution to retrieve.
--execution-id (string)
The execution identifier of a plan execution.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
planArn -> (string)
The Amazon Resource Name (ARN) of the plan.
executionId -> (string)
The execution identifier of a plan execution.
version -> (string)
The version for the plan.
updatedAt -> (timestamp)
The timestamp when the plan execution was last updated.
comment -> (string)
A comment included on the plan execution.
startTime -> (timestamp)
The time (UTC) when the plan execution started.
endTime -> (timestamp)
The time (UTC) when the plan execution ended.
mode -> (string)
The plan execution mode. Valid values arePractice, for testing without making actual changes, orRecovery, for actual traffic shifting and application recovery.
executionState -> (string)
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
executionAction -> (string)
The plan execution action. Valid values areActivate, to activate an Amazon Web Services Region, orDeactivate, to deactivate a Region.
executionRegion -> (string)
The Amazon Web Services Region for a plan execution.
stepStates -> (list)
The states of the steps in the plan execution.
(structure)
Represents the state of a step in a plan execution.
name -> (string)
The name of a step in a workflow.status -> (string)
The status of a step in a workflow. For example, a status might be Completed or Pending Approval.startTime -> (timestamp)
The timestamp when a step started execution.endTime -> (timestamp)
The timestamp when a step endeded execution.stepMode -> (string)
The mode for a step execution. The mode can be Graceful or Ungraceful.
plan -> (structure)
The details of the Region switch plan.
arn -> (string)
The Amazon Resource Name (ARN) of the plan.description -> (string)
The description for a plan.workflows -> (list)
The workflows for a plan.
(structure)
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps -> (list)
The steps that make up the workflow.
(structure)
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name -> (string)
The name of a step in a workflow.description -> (string)
The description of a step in a workflow.executionBlockConfiguration -> (tagged union structure)
The configuration for an execution block in a workflow.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customActionLambdaConfig,ec2AsgCapacityIncreaseConfig,executionApprovalConfig,arcRoutingControlConfig,globalAuroraConfig,parallelConfig,regionSwitchPlanConfig,ecsCapacityIncreaseConfig,eksResourceScalingConfig,route53HealthCheckConfig.customActionLambdaConfig -> (structure)
An Amazon Web Services Lambda execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.lambdas -> (list)
The Amazon Web Services Lambda functions for the execution block.
(structure)
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the Lambda function.retryIntervalMinutes -> (float)
The retry interval specified.regionToRun -> (string)
The Amazon Web Services Region for the function to run in.ungraceful -> (structure)
The settings for ungraceful execution.
behavior -> (string)
The ungraceful behavior for a Lambda function, which must be set toskip.ec2AsgCapacityIncreaseConfig -> (structure)
An EC2 Auto Scaling group execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.asgs -> (list)
The EC2 Auto Scaling groups for the configuration.
(structure)
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage that you specify for EC2 Auto Scaling groups.targetPercent -> (integer)
The target percentage that you specify for EC2 Auto Scaling groups.capacityMonitoringApproach -> (string)
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.executionApprovalConfig -> (structure)
A manual approval execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.approvalRole -> (string)
The IAM approval role for the configuration.arcRoutingControlConfig -> (structure)
An ARC routing control execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.regionAndRoutingControls -> (map)
The Region and ARC routing controls for the configuration.
key -> (string)
value -> (list)
(structure)
Represents the state of an ARC routing control.
routingControlArn -> (string)
The Amazon Resource Name (ARN) of a routing control.state -> (string)
The state of an ARC routing control, On or Off.globalAuroraConfig -> (structure)
An Aurora Global Database execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.behavior -> (string)
The behavior for a global database, that is, only allow switchover or also allow failover.ungraceful -> (structure)
The settings for ungraceful execution.
ungraceful -> (string)
The settings for ungraceful execution.globalClusterIdentifier -> (string)
The global cluster identifier for a global database.databaseClusterArns -> (list)
The database cluster Amazon Resource Names (ARNs) for a global database.
(string)
parallelConfig -> (structure)
A parallel configuration execution block.
steps -> (list)
The steps for a parallel execution block.
(structure)
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name -> (string)
The name of a step in a workflow.description -> (string)
The description of a step in a workflow.executionBlockConfiguration -> (tagged union structure)
The configuration for an execution block in a workflow.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customActionLambdaConfig,ec2AsgCapacityIncreaseConfig,executionApprovalConfig,arcRoutingControlConfig,globalAuroraConfig,parallelConfig,regionSwitchPlanConfig,ecsCapacityIncreaseConfig,eksResourceScalingConfig,route53HealthCheckConfig.customActionLambdaConfig -> (structure)
An Amazon Web Services Lambda execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.lambdas -> (list)
The Amazon Web Services Lambda functions for the execution block.
(structure)
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the Lambda function.retryIntervalMinutes -> (float)
The retry interval specified.regionToRun -> (string)
The Amazon Web Services Region for the function to run in.ungraceful -> (structure)
The settings for ungraceful execution.
behavior -> (string)
The ungraceful behavior for a Lambda function, which must be set toskip.ec2AsgCapacityIncreaseConfig -> (structure)
An EC2 Auto Scaling group execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.asgs -> (list)
The EC2 Auto Scaling groups for the configuration.
(structure)
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage that you specify for EC2 Auto Scaling groups.targetPercent -> (integer)
The target percentage that you specify for EC2 Auto Scaling groups.capacityMonitoringApproach -> (string)
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.executionApprovalConfig -> (structure)
A manual approval execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.approvalRole -> (string)
The IAM approval role for the configuration.arcRoutingControlConfig -> (structure)
An ARC routing control execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.regionAndRoutingControls -> (map)
The Region and ARC routing controls for the configuration.
key -> (string)
value -> (list)
(structure)
Represents the state of an ARC routing control.
routingControlArn -> (string)
The Amazon Resource Name (ARN) of a routing control.state -> (string)
The state of an ARC routing control, On or Off.globalAuroraConfig -> (structure)
An Aurora Global Database execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.behavior -> (string)
The behavior for a global database, that is, only allow switchover or also allow failover.ungraceful -> (structure)
The settings for ungraceful execution.
ungraceful -> (string)
The settings for ungraceful execution.globalClusterIdentifier -> (string)
The global cluster identifier for a global database.databaseClusterArns -> (list)
The database cluster Amazon Resource Names (ARNs) for a global database.
(string)
parallelConfig -> (structure)
A parallel configuration execution block.regionSwitchPlanConfig -> (structure)
A Region switch plan execution block.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the plan configuration.ecsCapacityIncreaseConfig -> (structure)
The capacity increase specified for the configuration.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.services -> (list)
The services specified for the configuration.
(structure)
The service for a cross account role.
crossAccountRole -> (string)
The cross account role for a service.externalId -> (string)
The external ID (secret key) for the service.clusterArn -> (string)
The cluster Amazon Resource Name (ARN) for a service.serviceArn -> (string)
The Amazon Resource Name (ARN) for a service.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage specified for the configuration.targetPercent -> (integer)
The target percentage specified for the configuration.capacityMonitoringApproach -> (string)
The monitoring approach specified for the configuration, for example,Most_Recent.eksResourceScalingConfig -> (structure)
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.kubernetesResourceType -> (structure)
The Kubernetes resource type for the configuration.
apiVersion -> (string)
The API version type for the Kubernetes resource.kind -> (string)
The kind for the Kubernetes resource.scalingResources -> (list)
The scaling resources for the configuration.
(map)
key -> (string)
value -> (map)
key -> (string)
value -> (structure)
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace -> (string)
The namespace for the Kubernetes resource.name -> (string)
The name for the Kubernetes resource.hpaName -> (string)
The hpaname for the Kubernetes resource.eksClusters -> (list)
The clusters for the configuration.
(structure)
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.clusterArn -> (string)
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage for the configuration.targetPercent -> (integer)
The target percentage for the configuration.capacityMonitoringApproach -> (string)
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.route53HealthCheckConfig -> (structure)
The Amazon Route 53 health check configuration.
timeoutMinutes -> (integer)
The Amazon Route 53 health check configuration time out (in minutes).crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.hostedZoneId -> (string)
The Amazon Route 53 health check configuration hosted zone ID.recordName -> (string)
The Amazon Route 53 health check configuration record name.recordSets -> (list)
The Amazon Route 53 health check configuration record sets.
(structure)
The Amazon Route 53 record set.
recordSetIdentifier -> (string)
The Amazon Route 53 record set identifier.region -> (string)
The Amazon Route 53 record set Region.executionBlockType -> (string)
The type of an execution block in a workflow.regionSwitchPlanConfig -> (structure)
A Region switch plan execution block.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.arn -> (string)
The Amazon Resource Name (ARN) of the plan configuration.ecsCapacityIncreaseConfig -> (structure)
The capacity increase specified for the configuration.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.services -> (list)
The services specified for the configuration.
(structure)
The service for a cross account role.
crossAccountRole -> (string)
The cross account role for a service.externalId -> (string)
The external ID (secret key) for the service.clusterArn -> (string)
The cluster Amazon Resource Name (ARN) for a service.serviceArn -> (string)
The Amazon Resource Name (ARN) for a service.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage specified for the configuration.targetPercent -> (integer)
The target percentage specified for the configuration.capacityMonitoringApproach -> (string)
The monitoring approach specified for the configuration, for example,Most_Recent.eksResourceScalingConfig -> (structure)
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes -> (integer)
The timeout value specified for the configuration.kubernetesResourceType -> (structure)
The Kubernetes resource type for the configuration.
apiVersion -> (string)
The API version type for the Kubernetes resource.kind -> (string)
The kind for the Kubernetes resource.scalingResources -> (list)
The scaling resources for the configuration.
(map)
key -> (string)
value -> (map)
key -> (string)
value -> (structure)
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace -> (string)
The namespace for the Kubernetes resource.name -> (string)
The name for the Kubernetes resource.hpaName -> (string)
The hpaname for the Kubernetes resource.eksClusters -> (list)
The clusters for the configuration.
(structure)
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.clusterArn -> (string)
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.ungraceful -> (structure)
The settings for ungraceful execution.
minimumSuccessPercentage -> (integer)
The minimum success percentage for the configuration.targetPercent -> (integer)
The target percentage for the configuration.capacityMonitoringApproach -> (string)
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.route53HealthCheckConfig -> (structure)
The Amazon Route 53 health check configuration.
timeoutMinutes -> (integer)
The Amazon Route 53 health check configuration time out (in minutes).crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.hostedZoneId -> (string)
The Amazon Route 53 health check configuration hosted zone ID.recordName -> (string)
The Amazon Route 53 health check configuration record name.recordSets -> (list)
The Amazon Route 53 health check configuration record sets.
(structure)
The Amazon Route 53 record set.
recordSetIdentifier -> (string)
The Amazon Route 53 record set identifier.region -> (string)
The Amazon Route 53 record set Region.executionBlockType -> (string)
The type of an execution block in a workflow.workflowTargetAction -> (string)
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.workflowTargetRegion -> (string)
The Amazon Web Services Region that the workflow targets.workflowDescription -> (string)
The description of the workflow.executionRole -> (string)
The execution role for a plan.recoveryTimeObjectiveMinutes -> (integer)
The recovery time objective for a plan.associatedAlarms -> (map)
The associated application health alarms for a plan.
key -> (string)
value -> (structure)
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole -> (string)
The cross account role for the configuration.externalId -> (string)
The external ID (secret key) for the configuration.resourceIdentifier -> (string)
The resource identifier for alarms that you associate with a plan.alarmType -> (string)
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.triggers -> (list)
The triggers for a plan.
(structure)
Defines a condition that can automatically trigger the execution of a Region switch plan.
description -> (string)
The description for a trigger.targetRegion -> (string)
The Amazon Web Services Region for a trigger.action -> (string)
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.conditions -> (list)
The conditions that must be met for the trigger to fire.
(structure)
Defines a condition that must be met for a trigger to fire.
associatedAlarmName -> (string)
The name of the CloudWatch alarm associated with the condition.condition -> (string)
The condition that must be met. Valid values include ALARM and OK.minDelayMinutesBetweenExecutions -> (integer)
The minimum time, in minutes, that must elapse between automatic executions of the plan.name -> (string)
The name for a plan.regions -> (list)
The Amazon Web Services Regions for a plan.
(string)
recoveryApproach -> (string)
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).primaryRegion -> (string)
The primary Region for a plan.owner -> (string)
The owner of a plan.version -> (string)
The version for the plan.updatedAt -> (timestamp)
The timestamp when the plan was last updated.
actualRecoveryTime -> (string)
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.
nextToken -> (string)
Specifies that you want to receive the next page of results. Valid only if you received anextTokenresponse 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’snextTokenresponse to request the next page of results.