:doc:`PrivateCAConnectorforSCEP <../../pca-connector-scep>` / Client / list_connectors

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



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

  

  Lists the connectors belonging to your Amazon Web Services account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListConnectors>`_  


  **Request Syntax**
  ::

    response = client.list_connectors(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a ``NextToken`` value that you can use in a subsequent call to get the next batch of objects.

    

  
  :type NextToken: string
  :param NextToken: 

    When you request a list of objects with a ``MaxResults`` setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a ``NextToken`` value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    

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

    
    ::

      {
          'Connectors': [
              {
                  'Arn': 'string',
                  'CertificateAuthorityArn': 'string',
                  'Type': 'GENERAL_PURPOSE'|'INTUNE',
                  'MobileDeviceManagement': {
                      'Intune': {
                          'AzureApplicationId': 'string',
                          'Domain': 'string'
                      }
                  },
                  'OpenIdConfiguration': {
                      'Issuer': 'string',
                      'Subject': 'string',
                      'Audience': 'string'
                  },
                  'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
                  'StatusReason': 'INTERNAL_FAILURE'|'PRIVATECA_ACCESS_DENIED'|'PRIVATECA_INVALID_STATE'|'PRIVATECA_RESOURCE_NOT_FOUND',
                  'Endpoint': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Connectors** *(list) --* 

        The connectors belonging to your Amazon Web Services account.

        
        

        - *(dict) --* 

          Lists the Amazon Web Services Private CA SCEP connectors belonging to your Amazon Web Services account.

          
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the connector.

            
          

          - **CertificateAuthorityArn** *(string) --* 

            The Amazon Resource Name (ARN) of the connector's associated certificate authority.

            
          

          - **Type** *(string) --* 

            The connector type.

            
          

          - **MobileDeviceManagement** *(dict) --* 

            Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure ``MobileDeviceManagement``, then the connector is for general-purpose use and this object is empty.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Intune``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **Intune** *(dict) --* 

              Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`__.

              
              

              - **AzureApplicationId** *(string) --* 

                The directory (tenant) ID from your Microsoft Entra ID app registration.

                
              

              - **Domain** *(string) --* 

                The primary domain from your Microsoft Entra ID app registration.

                
          
        
          

          - **OpenIdConfiguration** *(dict) --* 

            Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune.

            
            

            - **Issuer** *(string) --* 

              The issuer value to copy into your Microsoft Entra app registration's OIDC.

              
            

            - **Subject** *(string) --* 

              The subject value to copy into your Microsoft Entra app registration's OIDC.

              
            

            - **Audience** *(string) --* 

              The audience value to copy into your Microsoft Entra app registration's OIDC.

              
        
          

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

            The connector's status. Status can be creating, active, deleting, or failed.

            
          

          - **StatusReason** *(string) --* 

            Information about why connector creation failed, if status is ``FAILED``.

            
          

          - **Endpoint** *(string) --* 

            The connector's HTTPS public SCEP URL.

            
          

          - **CreatedAt** *(datetime) --* 

            The date and time that the challenge was created.

            
          

          - **UpdatedAt** *(datetime) --* 

            The date and time that the challenge was updated.

            
      
    
      

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

        When you request a list of objects with a ``MaxResults`` setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a ``NextToken`` value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

        
  
  **Exceptions**
  
  *   :py:class:`PrivateCAConnectorforSCEP.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`PrivateCAConnectorforSCEP.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PrivateCAConnectorforSCEP.Client.exceptions.AccessDeniedException`

  