:doc:`mgn <../../mgn>` / Client / list_connectors

***************
list_connectors
***************



.. py:method:: mgn.Client.list_connectors(**kwargs)

  

  List Connectors.

  

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


  **Request Syntax**
  ::

    response = client.list_connectors(
        filters={
            'connectorIDs': [
                'string',
            ]
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type filters: dict
  :param filters: 

    List Connectors Request filters.

    

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

      List Connectors Request Filters connector IDs.

      

    
      - *(string) --* 

      
  
  
  :type maxResults: integer
  :param maxResults: 

    List Connectors Request max results.

    

  
  :type nextToken: string
  :param nextToken: 

    List Connectors Request next token.

    

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

        List connectors response next token.

        
  
  **Exceptions**
  
  *   :py:class:`mgn.Client.exceptions.UninitializedAccountException`

  
  *   :py:class:`mgn.Client.exceptions.ValidationException`

  