Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetPlanInRegion

Retrieves information about a Region switch plan in a specific AWS Region. This operation is useful for getting Region-specific information about a plan.

Request Syntax


{
   "arn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the plan in Region.

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})

Required: Yes

Response Syntax


{
   "plan": { 
      "arn": "string",
      "associatedAlarms": { 
         "string" : { 
            "alarmType": "string",
            "crossAccountRole": "string",
            "externalId": "string",
            "resourceIdentifier": "string"
         }
      },
      "description": "string",
      "executionRole": "string",
      "name": "string",
      "owner": "string",
      "primaryRegion": "string",
      "recoveryApproach": "string",
      "recoveryTimeObjectiveMinutes": number,
      "regions": [ "string" ],
      "reportConfiguration": { 
         "reportOutput": [ 
            { ... }
         ]
      },
      "triggers": [ 
         { 
            "action": "string",
            "conditions": [ 
               { 
                  "associatedAlarmName": "string",
                  "condition": "string"
               }
            ],
            "description": "string",
            "minDelayMinutesBetweenExecutions": number,
            "targetRegion": "string"
         }
      ],
      "updatedAt": number,
      "version": "string",
      "workflows": [ 
         { 
            "steps": [ 
               { 
                  "description": "string",
                  "executionBlockConfiguration": { ... },
                  "executionBlockType": "string",
                  "name": "string"
               }
            ],
            "workflowDescription": "string",
            "workflowTargetAction": "string",
            "workflowTargetRegion": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

plan

The details of the Region switch plan.

Type: Plan object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404