:doc:`DirectoryService <../../ds>` / Client / describe_ldaps_settings

***********************
describe_ldaps_settings
***********************



.. py:method:: DirectoryService.Client.describe_ldaps_settings(**kwargs)

  

  Describes the status of LDAP security for the specified directory.

  

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


  **Request Syntax**
  ::

    response = client.describe_ldaps_settings(
        DirectoryId='string',
        Type='Client',
        NextToken='string',
        Limit=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    The type of next token used for pagination.

    

  
  :type Limit: integer
  :param Limit: 

    Specifies the number of items that should be displayed on one page.

    

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

    
    ::

      {
          'LDAPSSettingsInfo': [
              {
                  'LDAPSStatus': 'Enabling'|'Enabled'|'EnableFailed'|'Disabled',
                  'LDAPSStatusReason': 'string',
                  'LastUpdatedDateTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

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

        The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.

        
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.DirectoryDoesNotExistException`

  
  *   :py:class:`DirectoryService.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  