Skip to content

aws.ds.describe_settings

Example SQL Queries

SELECT * FROM
aws.ds.describe_settings
WHERE
"directory_id" = 'VALUE';

Description

Retrieves information about the configurable settings for the specified directory.

Table Definition

Column NameColumn Data Type
directory_id Required Input Column

The identifier of the directory.

VARCHAR
next_token Input Column

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

VARCHAR
status Input Column

The status of the directory settings for which to retrieve information.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
setting_entries

The list of SettingEntry objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"allowed_values" VARCHAR,
"applied_value" VARCHAR,
"requested_value" VARCHAR,
"request_status" VARCHAR,
"request_detailed_status" MAP(VARCHAR, VARCHAR),
"request_status_message" VARCHAR,
"last_updated_date_time" TIMESTAMP_S,
"last_requested_date_time" TIMESTAMP_S,
"data_type" VARCHAR
)[]
Show child fields
setting_entries[]
Show child fields
setting_entries[].allowed_values

The valid range of values for the directory setting. These values depend on the DataType of your directory.

setting_entries[].applied_value

The value of the directory setting that is applied to the directory.

setting_entries[].data_type

The data type of a directory setting. This is used to define the AllowedValues of a setting. For example a data type can be Boolean, DurationInSeconds, or Enum.

setting_entries[].last_requested_date_time

The date and time when the request to update a directory setting was last submitted.

setting_entries[].last_updated_date_time

The date and time when the directory setting was last updated.

setting_entries[].name

The name of the directory setting. For example:

TLS_1_0

setting_entries[].request_detailed_status

Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.

setting_entries[].request_status

The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed.

setting_entries[].request_status_message

The last status message for the directory status request.

setting_entries[].requested_value

The value that was last requested for the directory setting.

setting_entries[].type

The type, or category, of a directory setting. Similar settings have the same type. For example, Protocol, Cipher, or Certificate-Based Authentication.