:doc:`PcaConnectorAd <../../pca-connector-ad>` / Paginator / ListServicePrincipalNames

*************************
ListServicePrincipalNames
*************************



.. py:class:: PcaConnectorAd.Paginator.ListServicePrincipalNames

  ::

    
    paginator = client.get_paginator('list_service_principal_names')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PcaConnectorAd.Client.list_service_principal_names`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DirectoryRegistrationArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DirectoryRegistrationArn: string
    :param DirectoryRegistrationArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) that was returned when you called `CreateDirectoryRegistration <https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html>`__.

      

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

      
      ::

        {
            'ServicePrincipalNames': [
                {
                    'ConnectorArn': 'string',
                    'CreatedAt': datetime(2015, 1, 1),
                    'DirectoryRegistrationArn': 'string',
                    'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
                    'StatusReason': 'DIRECTORY_ACCESS_DENIED'|'DIRECTORY_NOT_REACHABLE'|'DIRECTORY_RESOURCE_NOT_FOUND'|'SPN_EXISTS_ON_DIFFERENT_AD_OBJECT'|'SPN_LIMIT_EXCEEDED'|'INTERNAL_FAILURE',
                    'UpdatedAt': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ServicePrincipalNames** *(list) --* 

          The service principal name, if any, that the connector uses to authenticate with Active Directory.

          
          

          - *(dict) --* 

            The service principal name that the connector uses to authenticate with Active Directory.

            
            

            - **ConnectorArn** *(string) --* 

              The Amazon Resource Name (ARN) that was returned when you called `CreateConnector <https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html>`__.

              
            

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

              The date and time that the service principal name was created.

              
            

            - **DirectoryRegistrationArn** *(string) --* 

              The Amazon Resource Name (ARN) that was returned when you called `CreateDirectoryRegistration <https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html>`__.

              
            

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

              The status of a service principal name.

              
            

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

              Additional information for the status of a service principal name if the status is failed.

              
            

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

              Time when the service principal name was updated.

              
        
      
    