EnableLDAPS - AWS Directory Service

EnableLDAPS

Activates the switch for the specific directory to always use LDAP secure calls.

Request Syntax

{ "DirectoryId": "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

Type

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

Type: String

Valid Values: Client

Required: Yes

Response Elements

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

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

DirectoryUnavailableException

The specified directory is unavailable or could not be found.

HTTP Status Code: 400

InvalidLDAPSStatusException

The LDAP activities could not be performed because they are limited by the LDAPS status.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

NoAvailableCertificateException

The LDAP activities could not be performed because at least one valid certificate must be registered with the system.

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

See Also

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