ARCRegionswitch / Client / get_plan_evaluation_status

get_plan_evaluation_status¶

ARCRegionswitch.Client.get_plan_evaluation_status(**kwargs)¶

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 Syntax

response = client.get_plan_evaluation_status(
    planArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

planArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
maxResults (integer) – The number of objects that you want to return with this call.
nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'planArn': 'string',
    'lastEvaluationTime': datetime(2015, 1, 1),
    'lastEvaluatedVersion': 'string',
    'region': 'string',
    'evaluationState': 'passed'|'actionRequired'|'pendingEvaluation'|'unknown',
    'warnings': [
        {
            'workflow': {
                'action': 'activate'|'deactivate',
                'name': 'string'
            },
            'version': 'string',
            'stepName': 'string',
            'resourceArn': 'string',
            'warningStatus': 'active'|'resolved',
            'warningUpdatedTime': datetime(2015, 1, 1),
            'warningMessage': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- planArn (string) –
  
  The Amazon Resource Name (ARN) of the plan.
- lastEvaluationTime (datetime) –
  
  The time of the last time that Region switch ran an evaluation of the plan.
- lastEvaluatedVersion (string) –
  
  The version of the last evaluation of the plan.
- region (string) –
  
  The Amazon Web Services Region for the plan.
- evaluationState (string) –
  
  The evaluation state for the plan.
- warnings (list) –
  
  The current evaluation warnings for the plan.
  - (dict) –
    
    Represents a warning about a resource in a Region switch plan.
    - workflow (dict) –
      
      The workflow for the resource warning.
      - action (string) –
        
        The action for a minimal workflow, which can be Activate or Deactivate.
      - name (string) –
        
        The name for a minimal workflow
    - version (string) –
      
      The version for the resource warning.
    - stepName (string) –
      
      The name of the step for the resource warning.
    - resourceArn (string) –
      
      The Amazon Resource Name (ARN) of the resource.
    - warningStatus (string) –
      
      The status of the resource warning.
    - warningUpdatedTime (datetime) –
      
      The timestamp when the warning was last updated.
    - warningMessage (string) –
      
      The warning message about what needs to be corrected.
- nextToken (string) –
  
  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.

Exceptions

ARCRegionswitch.Client.exceptions.ResourceNotFoundException
ARCRegionswitch.Client.exceptions.AccessDeniedException