Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ds ]



Describes the status of LDAP security for the specified directory.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--directory-id <value>
[--type <value>]
[--next-token <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--directory-id (string)

The identifier of the directory.

--type (string)

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

Possible values:

  • Client

--next-token (string)

The type of next token used for pagination.

--limit (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


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.


Contains general information about the LDAPS settings.

LDAPSStatus -> (string)

The state of the LDAPS settings.

LDAPSStatusReason -> (string)

Describes a state change for LDAPS.

LastUpdatedDateTime -> (timestamp)

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.