Skip to content
AWS for Query.Farm

aws.ds.describe_directories

Example SQL Queries

SELECT * FROM
aws.ds.describe_directories;

Description

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Table Definition

Column NameColumn Data Type
directory_ids Input Column

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

VARCHAR[]
Show child fields
directory_ids[]
_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
access_url

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

VARCHAR
alias

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

VARCHAR
connect_settings

A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

STRUCT(
    "vpc_id" VARCHAR,
    "subnet_ids" VARCHAR[],
    "customer_user_name" VARCHAR,
    "security_group_id" VARCHAR,
    "availability_zones" VARCHAR[],
    "connect_ips" VARCHAR[]
)
Show child fields
connect_settings.availability_zones[]
connect_settings.connect_ips[]
connect_settings.customer_user_name

The user name of the service account in your self-managed directory.

connect_settings.security_group_id

The security group identifier for the AD Connector directory.

connect_settings.subnet_ids[]
connect_settings.vpc_id

The identifier of the VPC that the AD Connector is in.

description

The description for the directory.

VARCHAR
desired_number_of_domain_controllers

The desired number of domain controllers in the directory if the directory is Microsoft AD.

BIGINT
directory_id

The directory identifier.

VARCHAR
dns_ip_addrs

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.

VARCHAR[]
Show child fields
dns_ip_addrs[]
edition

The edition associated with this directory.

VARCHAR
launch_time

Specifies when the directory was created.

TIMESTAMP_S
name

The fully qualified name of the directory.

VARCHAR
os_version

The operating system (OS) version of the directory.

VARCHAR
owner_directory_description

Describes the Managed Microsoft AD directory in the directory owner account.

STRUCT(
    "directory_id" VARCHAR,
    "account_id" VARCHAR,
    "dns_ip_addrs" VARCHAR[],
    "vpc_settings" STRUCT(
        "vpc_id" VARCHAR,
        "subnet_ids" VARCHAR[],
        "security_group_id" VARCHAR,
        "availability_zones" VARCHAR[]
    ),
    "radius_settings" STRUCT(
        "radius_servers" VARCHAR[],
        "radius_port" BIGINT,
        "radius_timeout" BIGINT,
        "radius_retries" BIGINT,
        "shared_secret" VARCHAR,
        "authentication_protocol" VARCHAR,
        "display_label" VARCHAR,
        "use_same_username" BOOLEAN
    ),
    "radius_status" VARCHAR
)
Show child fields
owner_directory_description.account_id

Identifier of the directory owner account.

owner_directory_description.directory_id

Identifier of the Managed Microsoft AD directory in the directory owner account.

owner_directory_description.dns_ip_addrs[]
owner_directory_description.radius_settings

A RadiusSettings object that contains information about the RADIUS server.

Show child fields
owner_directory_description.radius_settings.authentication_protocol

The protocol specified for your RADIUS endpoints.

owner_directory_description.radius_settings.display_label

Not currently used.

owner_directory_description.radius_settings.radius_port

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

owner_directory_description.radius_settings.radius_retries

The maximum number of times that communication with the RADIUS server is attempted.

owner_directory_description.radius_settings.radius_servers[]
owner_directory_description.radius_settings.radius_timeout

The amount of time, in seconds, to wait for the RADIUS server to respond.

owner_directory_description.radius_settings.shared_secret

Required for enabling RADIUS on the directory.

owner_directory_description.radius_settings.use_same_username

Not currently used.

owner_directory_description.radius_status

Information about the status of the RADIUS server.

owner_directory_description.vpc_settings

Information about the VPC settings for the directory.

Show child fields
owner_directory_description.vpc_settings.availability_zones[]
owner_directory_description.vpc_settings.security_group_id

The domain controller security group identifier for the directory.

owner_directory_description.vpc_settings.subnet_ids[]
owner_directory_description.vpc_settings.vpc_id

The identifier of the VPC that the directory is in.

radius_settings

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

STRUCT(
    "radius_servers" VARCHAR[],
    "radius_port" BIGINT,
    "radius_timeout" BIGINT,
    "radius_retries" BIGINT,
    "shared_secret" VARCHAR,
    "authentication_protocol" VARCHAR,
    "display_label" VARCHAR,
    "use_same_username" BOOLEAN
)
Show child fields
radius_settings.authentication_protocol

The protocol specified for your RADIUS endpoints.

radius_settings.display_label

Not currently used.

radius_settings.radius_port

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

radius_settings.radius_retries

The maximum number of times that communication with the RADIUS server is attempted.

radius_settings.radius_servers[]
radius_settings.radius_timeout

The amount of time, in seconds, to wait for the RADIUS server to respond.

radius_settings.shared_secret

Required for enabling RADIUS on the directory.

radius_settings.use_same_username

Not currently used.

radius_status

The status of the RADIUS MFA server connection.

VARCHAR
regions_info

Lists the Regions where the directory has replicated.

STRUCT(
    "primary_region" VARCHAR,
    "additional_regions" VARCHAR[]
)
Show child fields
regions_info.additional_regions[]
regions_info.primary_region

The Region where the Managed Microsoft AD directory was originally created.

share_method

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

VARCHAR
share_notes

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

VARCHAR
share_status

Current directory status of the shared Managed Microsoft AD directory.

VARCHAR
short_name

The short name of the directory.

VARCHAR
size

The directory size.

VARCHAR
sso_enabled

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

BOOLEAN
stage

The current stage of the directory.

VARCHAR
stage_last_updated_date_time

The date and time that the stage was last updated.

TIMESTAMP_S
stage_reason

Additional information about the directory stage.

VARCHAR
type

The directory size.

VARCHAR
vpc_settings

A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed Microsoft AD directory.

STRUCT(
    "vpc_id" VARCHAR,
    "subnet_ids" VARCHAR[],
    "security_group_id" VARCHAR,
    "availability_zones" VARCHAR[]
)
Show child fields
vpc_settings.availability_zones[]
vpc_settings.security_group_id

The domain controller security group identifier for the directory.

vpc_settings.subnet_ids[]
vpc_settings.vpc_id

The identifier of the VPC that the directory is in.