:doc:`Route53RecoveryControlConfig <../../route53-recovery-control-config>` / Paginator / ListControlPanels

*****************
ListControlPanels
*****************



.. py:class:: Route53RecoveryControlConfig.Paginator.ListControlPanels

  ::

    
    paginator = client.get_paginator('list_control_panels')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Route53RecoveryControlConfig.Client.list_control_panels`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListControlPanels>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ClusterArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ClusterArn: string
    :param ClusterArn: 

      The Amazon Resource Name (ARN) of a cluster.

      

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

      
      ::

        {
            'ControlPanels': [
                {
                    'ClusterArn': 'string',
                    'ControlPanelArn': 'string',
                    'DefaultControlPanel': True|False,
                    'Name': 'string',
                    'RoutingControlCount': 123,
                    'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
                    'Owner': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        200 response - Success.

        
        

        - **ControlPanels** *(list) --* 

          The result of a successful ListControlPanel request.

          
          

          - *(dict) --* 

            A control panel represents a group of routing controls that can be changed together in a single transaction.

            
            

            - **ClusterArn** *(string) --* 

              The Amazon Resource Name (ARN) of the cluster that includes the control panel.

              
            

            - **ControlPanelArn** *(string) --* 

              The Amazon Resource Name (ARN) of the control panel.

              
            

            - **DefaultControlPanel** *(boolean) --* 

              A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

              
            

            - **Name** *(string) --* 

              The name of the control panel. You can use any non-white space character in the name.

              
            

            - **RoutingControlCount** *(integer) --* 

              The number of routing controls in the control panel.

              
            

            - **Status** *(string) --* 

              The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

              
            

            - **Owner** *(string) --* 

              The Amazon Web Services account ID of the control panel owner.

              
        
      
    