View a markdown version of this page

Directory Service examples using AWS CLI - AWS SDK Code Examples
Actions

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Directory Service examples using AWS CLI

The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Directory Service.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.

Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use describe-directories.

AWS CLI

To get details about your directories

The following describe-directories example displays details about the specified directory.

aws ds describe-directories \
    --directory-id d-a1b2c3d4e5

Output:

{
    "DirectoryDescriptions": [
        {
            "DirectoryId": "d-a1b2c3d4e5",
            "Name": "mydirectory.example.com",
            "ShortName": "mydirectory",
            "Size": "Small",
            "Edition": "Standard",
            "Alias": "d-a1b2c3d4e5",
            "AccessUrl": "d-a1b2c3d4e5.awsapps.com",
            "Stage": "Active",
            "ShareStatus": "Shared",
            "ShareMethod": "HANDSHAKE",
            "ShareNotes": "These are my share notes",
            "LaunchTime": "2019-07-08T15:33:46.327000-07:00",
            "StageLastUpdatedDateTime": "2019-07-08T15:59:12.307000-07:00",
            "Type": "SharedMicrosoftAD",
            "SsoEnabled": false,
            "DesiredNumberOfDomainControllers": 0,
            "OwnerDirectoryDescription": {
                "DirectoryId": "d-b2c3d4e5f6",
                "AccountId": "123456789111",
                "DnsIpAddrs": [
                    "203.113.0.248",
                    "203.113.0.253"
                ],
                "VpcSettings": {
                    "VpcId": "vpc-a1b2c3d4",
                    "SubnetIds": [
                        "subnet-a1b2c3d4",
                        "subnet-d4c3b2a1"
                    ],
                    "AvailabilityZones": [
                        "us-west-2a",
                        "us-west-2c"
                    ]
                }
            }
        }
    ]
}

For more information, see Viewing AWS Managed Microsoft AD directory information in the AWS Directory Service Administration Guide.

The following code example shows how to use describe-trusts.

AWS CLI

To get details about your trust relationships

The following describe-trusts example displays details about the trust relationships for the specified directory.

aws ds describe-trusts \
    --directory-id d-a1b2c3d4e5

Output:

{
    "Trusts": [
        {
            "DirectoryId": "d-a1b2c3d4e5",
            "TrustId": "t-9a8b7c6d5e",
            "RemoteDomainName": "other.example.com",
            "TrustType": "Forest",
            "TrustDirection": "Two-Way",
            "TrustState": "Verified",
            "CreatedDateTime": "2017-06-20T18:08:45.614000-07:00",
            "LastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00",
            "StateLastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00",
            "SelectiveAuth": "Disabled"
        }
    ]
}

For more information, see Creating a trust relationship between your AWS Managed Microsoft AD and self-managed AD in the AWS Directory Service Administration Guide.

The following code example shows how to use disable-directory-data-access.

AWS CLI

To disable Directory Service Data API for a directory

The following disable-directory-data-access example disables the Directory Service Data API for the specified directory.

aws ds disable-directory-data-access \
    --directory-id d-1234567890

This command produces no output.

For more information, see Enabling or disabling user and group management or AWS Directory Service Data in the AWS Directory Service Administration Guide.

The following code example shows how to use enable-directory-data-access.

AWS CLI

To enable Directory Service Data API for a directory

The following enable-directory-data-access example enables the Directory Service Data API for the specified directory.

aws ds enable-directory-data-access \
    --directory-id d-1234567890

This command produces no output.

For more information, see Enabling or disabling user and group management or AWS Directory Service Data in the AWS Directory Service Administration Guide.

The following code example shows how to use reset-user-password.

AWS CLI

To reset a user password in a directory

The following reset-user-password example resets and enables the specified user in the specified directory.

aws ds reset-user-password \
    --directory-id d-1234567890 \
    --user-name 'john.doe' \
    --new-password 'password'

This command produces no output.

For more information, see Resetting and enabling an AWS Managed Microsoft AD user's password in the AWS Directory Service Administration Guide.