DescribeLDAPSSettings - Amazon Directory Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Describes the status of LDAP security for the specified directory.

Request Syntax

{ "DirectoryId": "string", "Limit": number, "NextToken": "string", "Type": "string" }

Request Parameters

The request accepts the following data in JSON format.


The identifier of the directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes


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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No


The type of next token used for pagination.

Type: String

Required: No


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

Type: String

Valid Values: Client

Required: No

Response Syntax

{ "LDAPSSettingsInfo": [ { "LastUpdatedDateTime": number, "LDAPSStatus": "string", "LDAPSStatusReason": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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

Type: Array of LDAPSSettingInfo objects


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

Type: String


For information about the errors that are common to all actions, see Common Errors.


A client exception has occurred.

HTTP Status Code: 400


The specified directory does not exist in the system.

HTTP Status Code: 400


The NextToken value is not valid.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500


The operation is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: