Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeLDAPSSettings

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.

DirectoryId

The identifier of the directory.

Type: String

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

Required: Yes

Limit

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

NextToken

The type of next token used for pagination.

Type: String

Required: No

Type

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.

LDAPSSettingsInfo

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

NextToken

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

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400