[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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.