:doc:`mgn <../../mgn>` / Paginator / ListConnectors

**************
ListConnectors
**************



.. py:class:: mgn.Paginator.ListConnectors

  ::

    
    paginator = client.get_paginator('list_connectors')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`mgn.Client.list_connectors`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/ListConnectors>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters={
              'connectorIDs': [
                  'string',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: dict
    :param filters: 

      List Connectors Request filters.

      

    
      - **connectorIDs** *(list) --* 

        List Connectors Request Filters connector IDs.

        

      
        - *(string) --* 

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

      
      ::

        {
            'items': [
                {
                    'connectorID': 'string',
                    'name': 'string',
                    'ssmInstanceID': 'string',
                    'arn': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'ssmCommandConfig': {
                        's3OutputEnabled': True|False,
                        'outputS3BucketName': 'string',
                        'cloudWatchOutputEnabled': True|False,
                        'cloudWatchLogGroupName': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          List connectors response items.

          
          

          - *(dict) --* 
            

            - **connectorID** *(string) --* 

              Connector ID.

              
            

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

              Connector name.

              
            

            - **ssmInstanceID** *(string) --* 

              Connector SSM instance ID.

              
            

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

              Connector arn.

              
            

            - **tags** *(dict) --* 

              Connector tags.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **ssmCommandConfig** *(dict) --* 

              Connector SSM command config.

              
              

              - **s3OutputEnabled** *(boolean) --* 

                Connector SSM command config S3 output enabled.

                
              

              - **outputS3BucketName** *(string) --* 

                Connector SSM command config output S3 bucket name.

                
              

              - **cloudWatchOutputEnabled** *(boolean) --* 

                Connector SSM command config CloudWatch output enabled.

                
              

              - **cloudWatchLogGroupName** *(string) --* 

                Connector SSM command config CloudWatch log group name.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    