Class: AWS.DirectoryService

Inherits:
AWS.Service show all
Identifier:
directoryservice
API Version:
2015-04-16
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using DirectoryService

var directoryservice = new AWS.DirectoryService();
directoryservice.addIpRoutes(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DirectoryService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var directoryservice = new AWS.DirectoryService({apiVersion: '2015-04-16'});

You can also set the API version globally in AWS.config.apiVersions using the directoryservice service identifier:

AWS.config.apiVersions = {
  directoryservice: '2015-04-16',
  // other service API versions
};

var directoryservice = new AWS.DirectoryService();

Version:

  • 2015-04-16

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DirectoryService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DirectoryService object

var directoryservice = new AWS.DirectoryService({apiVersion: '2015-04-16'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DirectoryService.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DirectoryService.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DirectoryService.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addIpRoutes(params = {}, callback) ⇒ AWS.Request

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Service Reference:

Examples:

Calling the addIpRoutes operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  IpRoutes: [ /* required */
    {
      CidrIp: 'STRING_VALUE',
      Description: 'STRING_VALUE'
    },
    /* more items */
  ],
  UpdateSecurityGroupForDirectoryControllers: true || false
};
directoryservice.addIpRoutes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      Identifier (ID) of the directory to which to add the address block.

    • IpRoutes — (Array<map>)

      IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

      • CidrIp — (String)

        IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

      • Description — (String)

        Description of the address block.

    • UpdateSecurityGroupForDirectoryControllers — (Boolean)

      If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules:

      Inbound:

      • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

      • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

      • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

      • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

      • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

      • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0

      • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0

      • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

      • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

      • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

      • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

      Outbound:

      • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

      These security rules impact an internal network interface that is not exposed publicly.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

addTagsToResource(params = {}, callback) ⇒ AWS.Request

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

Service Reference:

Examples:

Calling the addTagsToResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
directoryservice.addTagsToResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      Identifier (ID) for the directory to which to add the tag.

    • Tags — (Array<map>)

      The tags to be assigned to the directory.

      • Keyrequired — (String)

        Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Valuerequired — (String)

        The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelSchemaExtension(params = {}, callback) ⇒ AWS.Request

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

Service Reference:

Examples:

Calling the cancelSchemaExtension operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  SchemaExtensionId: 'STRING_VALUE' /* required */
};
directoryservice.cancelSchemaExtension(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory whose schema extension will be canceled.

    • SchemaExtensionId — (String)

      The identifier of the schema extension that will be canceled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

connectDirectory(params = {}, callback) ⇒ AWS.Request

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Service Reference:

Examples:

Calling the connectDirectory operation

var params = {
  ConnectSettings: { /* required */
    CustomerDnsIps: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    CustomerUserName: 'STRING_VALUE', /* required */
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE' /* required */
  },
  Name: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Size: Small | Large, /* required */
  Description: 'STRING_VALUE',
  ShortName: 'STRING_VALUE'
};
directoryservice.connectDirectory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The fully-qualified name of the on-premises directory, such as corp.example.com.

    • ShortName — (String)

      The NetBIOS name of the on-premises directory, such as CORP.

    • Password — (String)

      The password for the on-premises user account.

    • Description — (String)

      A textual description for the directory.

    • Size — (String)

      The size of the directory.

      Possible values include:
      • "Small"
      • "Large"
    • ConnectSettings — (map)

      A DirectoryConnectSettings object that contains additional information for the operation.

      • VpcIdrequired — (String)

        The identifier of the VPC in which the AD Connector is created.

      • SubnetIdsrequired — (Array<String>)

        A list of subnet identifiers in the VPC in which the AD Connector is created.

      • CustomerDnsIpsrequired — (Array<String>)

        A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.

      • CustomerUserNamerequired — (String)

        The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:

        • Read users and groups

        • Create computer objects

        • Join computers to the domain

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryId — (String)

        The identifier of the new directory.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAlias(params = {}, callback) ⇒ AWS.Request

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

Service Reference:

Examples:

Calling the createAlias operation

var params = {
  Alias: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.createAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to create the alias.

    • Alias — (String)

      The requested alias.

      The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryId — (String)

        The identifier of the directory.

      • Alias — (String)

        The alias for the directory.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createComputer(params = {}, callback) ⇒ AWS.Request

Creates a computer account in the specified directory, and joins the computer to the directory.

Service Reference:

Examples:

Calling the createComputer operation

var params = {
  ComputerName: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  ComputerAttributes: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  OrganizationalUnitDistinguishedName: 'STRING_VALUE'
};
directoryservice.createComputer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory in which to create the computer account.

    • ComputerName — (String)

      The name of the computer account.

    • Password — (String)

      A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

    • OrganizationalUnitDistinguishedName — (String)

      The fully-qualified distinguished name of the organizational unit to place the computer account in.

    • ComputerAttributes — (Array<map>)

      An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

      • Name — (String)

        The name of the attribute.

      • Value — (String)

        The value of the attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Computer — (map)

        A Computer object that represents the computer account.

        • ComputerId — (String)

          The identifier of the computer.

        • ComputerName — (String)

          The computer name.

        • ComputerAttributes — (Array<map>)

          An array of Attribute objects containing the LDAP attributes that belong to the computer account.

          • Name — (String)

            The name of the attribute.

          • Value — (String)

            The value of the attribute.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Service Reference:

Examples:

Calling the createConditionalForwarder operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  DnsIpAddrs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RemoteDomainName: 'STRING_VALUE' /* required */
};
directoryservice.createConditionalForwarder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The directory ID of the AWS directory for which you are creating the conditional forwarder.

    • RemoteDomainName — (String)

      The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

    • DnsIpAddrs — (Array<String>)

      The IP addresses of the remote DNS server associated with RemoteDomainName.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDirectory(params = {}, callback) ⇒ AWS.Request

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Service Reference:

Examples:

Calling the createDirectory operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Size: Small | Large, /* required */
  Description: 'STRING_VALUE',
  ShortName: 'STRING_VALUE',
  VpcSettings: {
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE' /* required */
  }
};
directoryservice.createDirectory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The fully qualified name for the directory, such as corp.example.com.

    • ShortName — (String)

      The short name of the directory, such as CORP.

    • Password — (String)

      The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.

    • Description — (String)

      A textual description for the directory.

    • Size — (String)

      The size of the directory.

      Possible values include:
      • "Small"
      • "Large"
    • VpcSettings — (map)

      A DirectoryVpcSettings object that contains additional information for the operation.

      • VpcIdrequired — (String)

        The identifier of the VPC in which to create the directory.

      • SubnetIdsrequired — (Array<String>)

        The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryId — (String)

        The identifier of the directory that was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMicrosoftAD(params = {}, callback) ⇒ AWS.Request

Creates a Microsoft AD in the AWS cloud.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Service Reference:

Examples:

Calling the createMicrosoftAD operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  VpcSettings: { /* required */
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  ShortName: 'STRING_VALUE'
};
directoryservice.createMicrosoftAD(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

    • ShortName — (String)

      The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

    • Password — (String)

      The password for the default administrative user named Admin.

    • Description — (String)

      A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

    • VpcSettings — (map)

      Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

      • VpcIdrequired — (String)

        The identifier of the VPC in which to create the directory.

      • SubnetIdsrequired — (Array<String>)

        The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryId — (String)

        The identifier of the directory that was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

Note: You cannot take snapshots of AD Connector directories.

Service Reference:

Examples:

Calling the createSnapshot operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
directoryservice.createSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory of which to take a snapshot.

    • Name — (String)

      The descriptive name to apply to the snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotId — (String)

        The identifier of the snapshot that was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTrust(params = {}, callback) ⇒ AWS.Request

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Service Reference:

Examples:

Calling the createTrust operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RemoteDomainName: 'STRING_VALUE', /* required */
  TrustDirection: One-Way: Outgoing | One-Way: Incoming | Two-Way, /* required */
  TrustPassword: 'STRING_VALUE', /* required */
  ConditionalForwarderIpAddrs: [
    'STRING_VALUE',
    /* more items */
  ],
  TrustType: Forest
};
directoryservice.createTrust(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship.

    • RemoteDomainName — (String)

      The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

    • TrustPassword — (String)

      The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

    • TrustDirection — (String)

      The direction of the trust relationship.

      Possible values include:
      • "One-Way: Outgoing"
      • "One-Way: Incoming"
      • "Two-Way"
    • TrustType — (String)

      The trust relationship type.

      Possible values include:
      • "Forest"
    • ConditionalForwarderIpAddrs — (Array<String>)

      The IP addresses of the remote DNS server associated with RemoteDomainName.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrustId — (String)

        A unique identifier for the trust relationship that was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Deletes a conditional forwarder that has been set up for your AWS directory.

Service Reference:

Examples:

Calling the deleteConditionalForwarder operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RemoteDomainName: 'STRING_VALUE' /* required */
};
directoryservice.deleteConditionalForwarder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The directory ID for which you are deleting the conditional forwarder.

    • RemoteDomainName — (String)

      The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDirectory(params = {}, callback) ⇒ AWS.Request

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Service Reference:

Examples:

Calling the deleteDirectory operation

var params = {
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.deleteDirectory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryId — (String)

        The directory identifier.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes a directory snapshot.

Service Reference:

Examples:

Calling the deleteSnapshot operation

var params = {
  SnapshotId: 'STRING_VALUE' /* required */
};
directoryservice.deleteSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SnapshotId — (String)

      The identifier of the directory snapshot to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotId — (String)

        The identifier of the directory snapshot that was deleted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTrust(params = {}, callback) ⇒ AWS.Request

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Service Reference:

Examples:

Calling the deleteTrust operation

var params = {
  TrustId: 'STRING_VALUE', /* required */
  DeleteAssociatedConditionalForwarder: true || false
};
directoryservice.deleteTrust(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TrustId — (String)

      The Trust ID of the trust relationship to be deleted.

    • DeleteAssociatedConditionalForwarder — (Boolean)

      Delete a conditional forwarder as part of a DeleteTrustRequest.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrustId — (String)

        The Trust ID of the trust relationship that was deleted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterEventTopic(params = {}, callback) ⇒ AWS.Request

Removes the specified directory as a publisher to the specified SNS topic.

Service Reference:

Examples:

Calling the deregisterEventTopic operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  TopicName: 'STRING_VALUE' /* required */
};
directoryservice.deregisterEventTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

    • TopicName — (String)

      The name of the SNS topic from which to remove the directory as a publisher.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeConditionalForwarders(params = {}, callback) ⇒ AWS.Request

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

Service Reference:

Examples:

Calling the describeConditionalForwarders operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RemoteDomainNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.describeConditionalForwarders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The directory ID for which to get the list of associated conditional forwarders.

    • RemoteDomainNames — (Array<String>)

      The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConditionalForwarders — (Array<map>)

        The list of conditional forwarders that have been created.

        • RemoteDomainName — (String)

          The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

        • DnsIpAddrs — (Array<String>)

          The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.

        • ReplicationScope — (String)

          The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.

          Possible values include:
          • "Domain"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDirectories(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeDirectories operation

var params = {
  DirectoryIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 0,
  NextToken: 'STRING_VALUE'
};
directoryservice.describeDirectories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryIds — (Array<String>)

      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.

    • NextToken — (String)

      The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

    • Limit — (Integer)

      The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryDescriptions — (Array<map>)

        The list of DirectoryDescription 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.

        • DirectoryId — (String)

          The directory identifier.

        • Name — (String)

          The fully-qualified name of the directory.

        • ShortName — (String)

          The short name of the directory.

        • Size — (String)

          The directory size.

          Possible values include:
          • "Small"
          • "Large"
        • Alias — (String)

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

        • AccessUrl — (String)

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

        • Description — (String)

          The textual description for the directory.

        • DnsIpAddrs — (Array<String>)

          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 the on-premises directory to which the AD Connector is connected.

        • Stage — (String)

          The current stage of the directory.

          Possible values include:
          • "Requested"
          • "Creating"
          • "Created"
          • "Active"
          • "Inoperable"
          • "Impaired"
          • "Restoring"
          • "RestoreFailed"
          • "Deleting"
          • "Deleted"
          • "Failed"
        • LaunchTime — (Date)

          Specifies when the directory was created.

        • StageLastUpdatedDateTime — (Date)

          The date and time that the stage was last updated.

        • Type — (String)

          The directory size.

          Possible values include:
          • "SimpleAD"
          • "ADConnector"
          • "MicrosoftAD"
        • VpcSettings — (map)

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

          • VpcId — (String)

            The identifier of the VPC that the directory is in.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets for the directory servers.

          • SecurityGroupId — (String)

            The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones that the directory is in.

        • ConnectSettings — (map)

          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.

          • VpcId — (String)

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

          • SubnetIds — (Array<String>)

            A list of subnet identifiers in the VPC that the AD connector is in.

          • CustomerUserName — (String)

            The username of the service account in the on-premises directory.

          • SecurityGroupId — (String)

            The security group identifier for the AD Connector directory.

          • AvailabilityZones — (Array<String>)

            A list of the Availability Zones that the directory is in.

          • ConnectIps — (Array<String>)

            The IP addresses of the AD Connector servers.

        • RadiusSettings — (map)

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

          • RadiusServers — (Array<String>)

            An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

          • RadiusPort — (Integer)

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

          • RadiusTimeout — (Integer)

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

          • RadiusRetries — (Integer)

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

          • SharedSecret — (String)

            Not currently used.

          • AuthenticationProtocol — (String)

            The protocol specified for your RADIUS endpoints.

            Possible values include:
            • "PAP"
            • "CHAP"
            • "MS-CHAPv1"
            • "MS-CHAPv2"
          • DisplayLabel — (String)

            Not currently used.

          • UseSameUsername — (Boolean)

            Not currently used.

        • RadiusStatus — (String)

          The status of the RADIUS MFA server connection.

          Possible values include:
          • "Creating"
          • "Completed"
          • "Failed"
        • StageReason — (String)

          Additional information about the directory stage.

        • SsoEnabled — (Boolean)

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

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEventTopics(params = {}, callback) ⇒ AWS.Request

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

Service Reference:

Examples:

Calling the describeEventTopics operation

var params = {
  DirectoryId: 'STRING_VALUE',
  TopicNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.describeEventTopics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

    • TopicNames — (Array<String>)

      A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

      An empty list results in an InvalidParameterException being thrown.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventTopics — (Array<map>)

        A list of SNS topic names that receive status messages from the specified Directory ID.

        • DirectoryId — (String)

          The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

        • TopicName — (String)

          The name of an AWS SNS topic the receives status messages from the directory.

        • TopicArn — (String)

          The SNS topic ARN (Amazon Resource Name).

        • CreatedDateTime — (Date)

          The date and time of when you associated your directory with the SNS topic.

        • Status — (String)

          The topic registration status.

          Possible values include:
          • "Registered"
          • "Topic not found"
          • "Failed"
          • "Deleted"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSnapshots(params = {}, callback) ⇒ AWS.Request

Obtains information about the directory snapshots that belong to this account.

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

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

Service Reference:

Examples:

Calling the describeSnapshots operation

var params = {
  DirectoryId: 'STRING_VALUE',
  Limit: 0,
  NextToken: 'STRING_VALUE',
  SnapshotIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.describeSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to retrieve snapshot information.

    • SnapshotIds — (Array<String>)

      A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

    • NextToken — (String)

      The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

    • Limit — (Integer)

      The maximum number of objects to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshots — (Array<map>)

        The list of Snapshot 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.

        • DirectoryId — (String)

          The directory identifier.

        • SnapshotId — (String)

          The snapshot identifier.

        • Type — (String)

          The snapshot type.

          Possible values include:
          • "Auto"
          • "Manual"
        • Name — (String)

          The descriptive name of the snapshot.

        • Status — (String)

          The snapshot status.

          Possible values include:
          • "Creating"
          • "Completed"
          • "Failed"
        • StartTime — (Date)

          The date and time that the snapshot was taken.

      • NextToken — (String)

        If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTrusts(params = {}, callback) ⇒ AWS.Request

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

Service Reference:

Examples:

Calling the describeTrusts operation

var params = {
  DirectoryId: 'STRING_VALUE',
  Limit: 0,
  NextToken: 'STRING_VALUE',
  TrustIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.describeTrusts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The Directory ID of the AWS directory that is a part of the requested trust relationship.

    • TrustIds — (Array<String>)

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

      An empty list results in an InvalidParameterException being thrown.

    • NextToken — (String)

      The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.

    • Limit — (Integer)

      The maximum number of objects to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Trusts — (Array<map>)

        The list of Trust 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.

        • DirectoryId — (String)

          The Directory ID of the AWS directory involved in the trust relationship.

        • TrustId — (String)

          The unique ID of the trust relationship.

        • RemoteDomainName — (String)

          The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

        • TrustType — (String)

          The trust relationship type.

          Possible values include:
          • "Forest"
        • TrustDirection — (String)

          The trust relationship direction.

          Possible values include:
          • "One-Way: Outgoing"
          • "One-Way: Incoming"
          • "Two-Way"
        • TrustState — (String)

          The trust relationship state.

          Possible values include:
          • "Creating"
          • "Created"
          • "Verifying"
          • "VerifyFailed"
          • "Verified"
          • "Deleting"
          • "Deleted"
          • "Failed"
        • CreatedDateTime — (Date)

          The date and time that the trust relationship was created.

        • LastUpdatedDateTime — (Date)

          The date and time that the trust relationship was last updated.

        • StateLastUpdatedDateTime — (Date)

          The date and time that the TrustState was last updated.

        • TrustStateReason — (String)

          The reason for the TrustState.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableRadius(params = {}, callback) ⇒ AWS.Request

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Service Reference:

Examples:

Calling the disableRadius operation

var params = {
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.disableRadius(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to disable MFA.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableSso(params = {}, callback) ⇒ AWS.Request

Disables single-sign on for a directory.

Service Reference:

Examples:

Calling the disableSso operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
directoryservice.disableSso(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to disable single-sign on.

    • UserName — (String)

      The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

      If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

    • Password — (String)

      The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableRadius(params = {}, callback) ⇒ AWS.Request

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Service Reference:

Examples:

Calling the enableRadius operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RadiusSettings: { /* required */
    AuthenticationProtocol: PAP | CHAP | MS-CHAPv1 | MS-CHAPv2,
    DisplayLabel: 'STRING_VALUE',
    RadiusPort: 0,
    RadiusRetries: 0,
    RadiusServers: [
      'STRING_VALUE',
      /* more items */
    ],
    RadiusTimeout: 0,
    SharedSecret: 'STRING_VALUE',
    UseSameUsername: true || false
  }
};
directoryservice.enableRadius(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to enable MFA.

    • RadiusSettings — (map)

      A RadiusSettings object that contains information about the RADIUS server.

      • RadiusServers — (Array<String>)

        An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

      • RadiusPort — (Integer)

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

      • RadiusTimeout — (Integer)

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

      • RadiusRetries — (Integer)

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

      • SharedSecret — (String)

        Not currently used.

      • AuthenticationProtocol — (String)

        The protocol specified for your RADIUS endpoints.

        Possible values include:
        • "PAP"
        • "CHAP"
        • "MS-CHAPv1"
        • "MS-CHAPv2"
      • DisplayLabel — (String)

        Not currently used.

      • UseSameUsername — (Boolean)

        Not currently used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableSso(params = {}, callback) ⇒ AWS.Request

Enables single sign-on for a directory.

Service Reference:

Examples:

Calling the enableSso operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
directoryservice.enableSso(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to enable single-sign on.

    • UserName — (String)

      The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

      If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

    • Password — (String)

      The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDirectoryLimits(params = {}, callback) ⇒ AWS.Request

Obtains directory limit information for the current region.

Service Reference:

Examples:

Calling the getDirectoryLimits operation

var params = {
};
directoryservice.getDirectoryLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryLimits — (map)

        A DirectoryLimits object that contains the directory limits for the current region.

        • CloudOnlyDirectoriesLimit — (Integer)

          The maximum number of cloud directories allowed in the region.

        • CloudOnlyDirectoriesCurrentCount — (Integer)

          The current number of cloud directories in the region.

        • CloudOnlyDirectoriesLimitReached — (Boolean)

          Indicates if the cloud directory limit has been reached.

        • CloudOnlyMicrosoftADLimit — (Integer)

          The maximum number of Microsoft AD directories allowed in the region.

        • CloudOnlyMicrosoftADCurrentCount — (Integer)

          The current number of Microsoft AD directories in the region.

        • CloudOnlyMicrosoftADLimitReached — (Boolean)

          Indicates if the Microsoft AD directory limit has been reached.

        • ConnectedDirectoriesLimit — (Integer)

          The maximum number of connected directories allowed in the region.

        • ConnectedDirectoriesCurrentCount — (Integer)

          The current number of connected directories in the region.

        • ConnectedDirectoriesLimitReached — (Boolean)

          Indicates if the connected directory limit has been reached.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSnapshotLimits(params = {}, callback) ⇒ AWS.Request

Obtains the manual snapshot limits for a directory.

Service Reference:

Examples:

Calling the getSnapshotLimits operation

var params = {
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.getSnapshotLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      Contains the identifier of the directory to obtain the limits for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotLimits — (map)

        A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

        • ManualSnapshotsLimit — (Integer)

          The maximum number of manual snapshots allowed.

        • ManualSnapshotsCurrentCount — (Integer)

          The current number of manual snapshots of the directory.

        • ManualSnapshotsLimitReached — (Boolean)

          Indicates if the manual snapshot limit has been reached.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listIpRoutes(params = {}, callback) ⇒ AWS.Request

Lists the address blocks that you have added to a directory.

Service Reference:

Examples:

Calling the listIpRoutes operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 0,
  NextToken: 'STRING_VALUE'
};
directoryservice.listIpRoutes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      Identifier (ID) of the directory for which you want to retrieve the IP addresses.

    • NextToken — (String)

      The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

    • Limit — (Integer)

      Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpRoutesInfo — (Array<map>)

        A list of IpRoutes.

        • DirectoryId — (String)

          Identifier (ID) of the directory associated with the IP addresses.

        • CidrIp — (String)

          IP address block in the IpRoute.

        • IpRouteStatusMsg — (String)

          The status of the IP address block.

          Possible values include:
          • "Adding"
          • "Added"
          • "Removing"
          • "Removed"
          • "AddFailed"
          • "RemoveFailed"
        • AddedDateTime — (Date)

          The date and time the address block was added to the directory.

        • IpRouteStatusReason — (String)

          The reason for the IpRouteStatusMsg.

        • Description — (String)

          Description of the IpRouteInfo.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSchemaExtensions(params = {}, callback) ⇒ AWS.Request

Lists all schema extensions applied to a Microsoft AD Directory.

Service Reference:

Examples:

Calling the listSchemaExtensions operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 0,
  NextToken: 'STRING_VALUE'
};
directoryservice.listSchemaExtensions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory from which to retrieve the schema extension information.

    • NextToken — (String)

      The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

    • Limit — (Integer)

      The maximum number of items to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SchemaExtensionsInfo — (Array<map>)

        Information about the schema extensions applied to the directory.

        • DirectoryId — (String)

          The identifier of the directory to which the schema extension is applied.

        • SchemaExtensionId — (String)

          The identifier of the schema extension.

        • Description — (String)

          A description of the schema extension.

        • SchemaExtensionStatus — (String)

          The current status of the schema extension.

          Possible values include:
          • "Initializing"
          • "CreatingSnapshot"
          • "UpdatingSchema"
          • "Replicating"
          • "CancelInProgress"
          • "RollbackInProgress"
          • "Cancelled"
          • "Failed"
          • "Completed"
        • SchemaExtensionStatusReason — (String)

          The reason for the SchemaExtensionStatus.

        • StartDateTime — (Date)

          The date and time that the schema extension started being applied to the directory.

        • EndDateTime — (Date)

          The date and time that the schema extension was completed.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on a directory.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Limit: 0,
  NextToken: 'STRING_VALUE'
};
directoryservice.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      Identifier (ID) of the directory for which you want to retrieve tags.

    • NextToken — (String)

      Reserved for future use.

    • Limit — (Integer)

      Reserved for future use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        List of tags returned by the ListTagsForResource operation.

        • Keyrequired — (String)

          Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

        • Valuerequired — (String)

          The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • NextToken — (String)

        Reserved for future use.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerEventTopic(params = {}, callback) ⇒ AWS.Request

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

Service Reference:

Examples:

Calling the registerEventTopic operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  TopicName: 'STRING_VALUE' /* required */
};
directoryservice.registerEventTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The Directory ID that will publish status messages to the SNS topic.

    • TopicName — (String)

      The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeIpRoutes(params = {}, callback) ⇒ AWS.Request

Removes IP address blocks from a directory.

Service Reference:

Examples:

Calling the removeIpRoutes operation

var params = {
  CidrIps: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.removeIpRoutes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      Identifier (ID) of the directory from which you want to remove the IP addresses.

    • CidrIps — (Array<String>)

      IP address blocks that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeTagsFromResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a directory.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.removeTagsFromResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      Identifier (ID) of the directory from which to remove the tag.

    • TagKeys — (Array<String>)

      The tag key (name) of the tag to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

restoreFromSnapshot(params = {}, callback) ⇒ AWS.Request

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.

Service Reference:

Examples:

Calling the restoreFromSnapshot operation

var params = {
  SnapshotId: 'STRING_VALUE' /* required */
};
directoryservice.restoreFromSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SnapshotId — (String)

      The identifier of the snapshot to restore from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startSchemaExtension(params = {}, callback) ⇒ AWS.Request

Applies a schema extension to a Microsoft AD directory.

Service Reference:

Examples:

Calling the startSchemaExtension operation

var params = {
  CreateSnapshotBeforeSchemaExtension: true || false, /* required */
  Description: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE', /* required */
  LdifContent: 'STRING_VALUE' /* required */
};
directoryservice.startSchemaExtension(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which the schema extension will be applied to.

    • CreateSnapshotBeforeSchemaExtension — (Boolean)

      If true, creates a snapshot of the directory before applying the schema extension.

    • LdifContent — (String)

      The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.

    • Description — (String)

      A description of the schema extension.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SchemaExtensionId — (String)

        The identifier of the schema extension that will be applied.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Updates a conditional forwarder that has been set up for your AWS directory.

Service Reference:

Examples:

Calling the updateConditionalForwarder operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  DnsIpAddrs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RemoteDomainName: 'STRING_VALUE' /* required */
};
directoryservice.updateConditionalForwarder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The directory ID of the AWS directory for which to update the conditional forwarder.

    • RemoteDomainName — (String)

      The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

    • DnsIpAddrs — (Array<String>)

      The updated IP addresses of the remote DNS server associated with the conditional forwarder.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRadius(params = {}, callback) ⇒ AWS.Request

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Service Reference:

Examples:

Calling the updateRadius operation

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RadiusSettings: { /* required */
    AuthenticationProtocol: PAP | CHAP | MS-CHAPv1 | MS-CHAPv2,
    DisplayLabel: 'STRING_VALUE',
    RadiusPort: 0,
    RadiusRetries: 0,
    RadiusServers: [
      'STRING_VALUE',
      /* more items */
    ],
    RadiusTimeout: 0,
    SharedSecret: 'STRING_VALUE',
    UseSameUsername: true || false
  }
};
directoryservice.updateRadius(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryId — (String)

      The identifier of the directory for which to update the RADIUS server information.

    • RadiusSettings — (map)

      A RadiusSettings object that contains information about the RADIUS server.

      • RadiusServers — (Array<String>)

        An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

      • RadiusPort — (Integer)

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

      • RadiusTimeout — (Integer)

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

      • RadiusRetries — (Integer)

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

      • SharedSecret — (String)

        Not currently used.

      • AuthenticationProtocol — (String)

        The protocol specified for your RADIUS endpoints.

        Possible values include:
        • "PAP"
        • "CHAP"
        • "MS-CHAPv1"
        • "MS-CHAPv2"
      • DisplayLabel — (String)

        Not currently used.

      • UseSameUsername — (Boolean)

        Not currently used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

verifyTrust(params = {}, callback) ⇒ AWS.Request

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Service Reference:

Examples:

Calling the verifyTrust operation

var params = {
  TrustId: 'STRING_VALUE' /* required */
};
directoryservice.verifyTrust(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TrustId — (String)

      The unique Trust ID of the trust relationship to verify.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrustId — (String)

        The unique Trust ID of the trust relationship that was verified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.