:doc:`ARCRegionswitch <../../arc-region-switch>` / Paginator / GetPlanEvaluationStatus

***********************
GetPlanEvaluationStatus
***********************



.. py:class:: ARCRegionswitch.Paginator.GetPlanEvaluationStatus

  ::

    
    paginator = client.get_paginator('get_plan_evaluation_status')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ARCRegionswitch.Client.get_plan_evaluation_status`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/arc-region-switch-2022-07-26/GetPlanEvaluationStatus>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          planArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type planArn: string
    :param planArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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) --* 

          A token to resume pagination.

          
    