DirectoryService / Client / describe_ldaps_settings

describe_ldaps_settings#

DirectoryService.Client.describe_ldaps_settings(**kwargs)#

Describes the status of LDAP security for the specified directory.

Request Syntax

response = client.describe_ldaps_settings(
    DirectoryId='string',
    Type='Client',
    NextToken='string',
    Limit=123
)

Parameters:

DirectoryId (string) –
[REQUIRED]

The identifier of the directory.
Type (string) – The type of LDAP security to enable. Currently only the value Client is supported.
NextToken (string) – The type of next token used for pagination.
Limit (integer) – Specifies the number of items that should be displayed on one page.

Return type:

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

DirectoryService.Client.exceptions.DirectoryDoesNotExistException
DirectoryService.Client.exceptions.UnsupportedOperationException
DirectoryService.Client.exceptions.InvalidNextTokenException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException