GetPlanEvaluationStatus
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.
Request Parameters
- maxResults
-
The number of objects that you want to return with this call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
nextTokenresponse 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- planArn
-
The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
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 Elements
The following elements are returned by the service.
- evaluationState
-
The evaluation state for the plan.
Type: String
Valid Values:
passed | actionRequired | pendingEvaluation | unknown - lastEvaluatedVersion
-
The version of the last evaluation of the plan.
Type: String
- lastEvaluationTime
-
The time of the last time that Region switch ran an evaluation of the plan.
Type: Timestamp
- nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
nextTokenresponse 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- planArn
-
The Amazon Resource Name (ARN) of the plan.
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}) - region
-
The AWS Region for the plan.
Type: String
Pattern:
[a-z]{2}-[a-z-]+-\d+ - warnings
-
The current evaluation warnings for the plan.
Type: Array of ResourceWarning objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
