:doc:`DirectoryService <../../ds>` / Paginator / DescribeLDAPSSettings

*********************
DescribeLDAPSSettings
*********************



.. py:class:: DirectoryService.Paginator.DescribeLDAPSSettings

  ::

    
    paginator = client.get_paginator('describe_ldaps_settings')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DirectoryService.Client.describe_ldaps_settings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeLDAPSSettings>`_    


    **Request Syntax**
    ::

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

      The identifier of the directory.

      

    
    :type Type: string
    :param Type: 

      The type of LDAP security to enable. Currently only the value ``Client`` is supported.

      

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

      
      ::

        {
            'LDAPSSettingsInfo': [
                {
                    'LDAPSStatus': 'Enabling'|'Enabled'|'EnableFailed'|'Disabled',
                    'LDAPSStatusReason': 'string',
                    'LastUpdatedDateTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **LDAPSSettingsInfo** *(list) --* 

          Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.

          
          

          - *(dict) --* 

            Contains general information about the LDAPS settings.

            
            

            - **LDAPSStatus** *(string) --* 

              The state of the LDAPS settings.

              
            

            - **LDAPSStatusReason** *(string) --* 

              Describes a state change for LDAPS.

              
            

            - **LastUpdatedDateTime** *(datetime) --* 

              The date and time when the LDAPS settings were last updated.

              
        
      
    