:doc:`ARCRegionswitch <../../arc-region-switch>` / Client / list_plans_in_region

********************
list_plans_in_region
********************



.. py:method:: ARCRegionswitch.Client.list_plans_in_region(**kwargs)

  

  Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

  

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


  **Request Syntax**
  ::

    response = client.list_plans_in_region(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The number of objects that you want to return with this call.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'plans': [
              {
                  'arn': 'string',
                  'owner': 'string',
                  'name': 'string',
                  'regions': [
                      'string',
                  ],
                  'recoveryApproach': 'activeActive'|'activePassive',
                  'primaryRegion': 'string',
                  'version': 'string',
                  'updatedAt': datetime(2015, 1, 1),
                  'description': 'string',
                  'executionRole': 'string',
                  'activePlanExecution': 'string',
                  'recoveryTimeObjectiveMinutes': 123
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **plans** *(list) --* 

        The plans that were requested.

        
        

        - *(dict) --* 

          A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

          
          

          - **arn** *(string) --* 

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

            
          

          - **owner** *(string) --* 

            The owner of a Region switch plan.

            
          

          - **name** *(string) --* 

            The name of a Region switch plan.

            
          

          - **regions** *(list) --* 

            The Amazon Web Services Region specified for a Region switch 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.

            
          

          - **version** *(string) --* 

            The version for the plan.

            
          

          - **updatedAt** *(datetime) --* 

            The timestamp when the plan execution was last updated.

            
          

          - **description** *(string) --* 

            The description of a Region switch plan.

            
          

          - **executionRole** *(string) --* 

            The execution role is a way to categorize a Region switch plan.

            
          

          - **activePlanExecution** *(string) --* 

            Specifies if this is the active plan execution at this time.

            
          

          - **recoveryTimeObjectiveMinutes** *(integer) --* 

            The recovery time objective that you've specified.

            
      
    
      

      - **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**
  
  *   :py:class:`ARCRegionswitch.Client.exceptions.AccessDeniedException`

  