@aws-sdk/client-directory-service-node

Description

AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-directory-service-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(DirectoryServiceClient) and the commands you need, for example AcceptSharedDirectoryCommand:

//JavaScript
const {
  DirectoryServiceClient
} = require("@aws-sdk/client-directory-service-node/DirectoryServiceClient");
const {
  AcceptSharedDirectoryCommand
} = require("@aws-sdk/client-directory-service-node/commands/AcceptSharedDirectoryCommand");

//TypeScript
import { DirectoryServiceClient } from "@aws-sdk/client-directory-service-node/DirectoryServiceClient";
import { AcceptSharedDirectoryCommand } from "@aws-sdk/client-directory-service-node/commands/AcceptSharedDirectoryCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

const directoryService = new DirectoryServiceClient({region: 'region'});
//clients can be shared by different commands
const params = {
  SharedDirectoryId: /**a string value*/,
};
const acceptSharedDirectoryCommand = new AcceptSharedDirectoryCommand(params);
directoryService.send(acceptSharedDirectoryCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await directoryService.send(acceptSharedDirectoryCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
directoryService.send(acceptSharedDirectoryCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-directory-service-node/DirectoryService";
const directoryService = new AWS.DirectoryService({ region: "region" });
directoryService.acceptSharedDirectory(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await directoryService.send(acceptSharedDirectoryCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-directory-service-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.