Class: AWS.DirectoryService

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 self-managed 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 self-managed 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: "Amazon Web Services 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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RegionName: 'STRING_VALUE', /* required */
  VPCSettings: { /* required */
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE' /* required */
  }
};
directoryservice.addRegion(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 which you want to add Region replication.

  • RegionName — (String)

    The name of the Region where you want to add domain controllers for replication. For example, us-east-1.

  • VPCSettings — (map)

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    • VpcId — required — (String)

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

    • SubnetIds — required — (Array<String>)

      The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. 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.

Returns:

• (AWS.Request) —

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

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.

    • Key — required — (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}.:/=+\-]*)$").

    • Value — required — (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.

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.

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',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 your self-managed directory, such as corp.example.com.

  • ShortName — (String)

    The NetBIOS name of your self-managed directory, such as CORP.

  • Password — (String)

    The password for your self-managed user account.

  • Description — (String)

    A 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.

    • VpcId — required — (String)

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

    • SubnetIds — required — (Array<String>)

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

    • CustomerDnsIps — required — (Array<String>)

      A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.

    • CustomerUserName — required — (String)

      The user name of an account in your self-managed directory that is used to connect to the directory. This account must have the following permissions:

      • Read users and groups

      • Create computer objects

      • Join computers to the domain

  • Tags — (Array<map>)

    The tags to be assigned to AD Connector.

    • Key — required — (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}.:/=+\-]*)$").

    • Value — required — (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. 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.

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 Amazon Web Services. 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.

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.

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 Amazon Web Services 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.

var params = {
  Name: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Size: Small | Large, /* required */
  Description: 'STRING_VALUE',
  ShortName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  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 NetBIOS 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 user name Administrator and this password.

    If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

    The regex pattern for this string is made up of the following conditions:

    • Length (?=^.{8,64}$) – Must be between 8 and 64 characters

    AND any 3 of the following password complexity rules required by Active Directory:

    • Numbers and upper case and lowercase (?=.\d)(?=.[A-Z])(?=.[a-z])

    • Numbers and special characters and lower case (?=.\d)(?=.[^A-Za-z0-9\s])(?=.[a-z])

    • Special characters and upper case and lower case (?=.[^A-Za-z0-9\s])(?=.[A-Z])(?=.[a-z])

    • Numbers and upper case and special characters (?=.\d)(?=.[A-Z])(?=.[^A-Za-z0-9\s])

    For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

  • Description — (String)

    A 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.

    • VpcId — required — (String)

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

    • SubnetIds — required — (Array<String>)

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

  • Tags — (Array<map>)

    The tags to be assigned to the Simple AD directory.

    • Key — required — (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}.:/=+\-]*)$").

    • Value — required — (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. 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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  LogGroupName: 'STRING_VALUE' /* required */
};
directoryservice.createLogSubscription(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 of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.

  • LogGroupName — (String)

    The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

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.

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',
  Edition: Enterprise | Standard,
  ShortName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 Managed Microsoft AD 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, 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.

    If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

  • Description — (String)

    A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

  • VpcSettings — (map)

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    • VpcId — required — (String)

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

    • SubnetIds — required — (Array<String>)

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

  • Edition — (String)

    Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

    Possible values include:
    • "Enterprise"
    • "Standard"
  • Tags — (Array<map>)

    The tags to be assigned to the Managed Microsoft AD directory.

    • Key — required — (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}.:/=+\-]*)$").

    • Value — required — (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. 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.

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.

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 */
  ],
  SelectiveAuth: Enabled | Disabled,
  TrustType: Forest | External
};
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 Managed Microsoft AD directory 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. Forest is the default.

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

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

  • SelectiveAuth — (String)

    Optional parameter to enable selective authentication for the trust.

    Possible values include:
    • "Enabled"
    • "Disabled"

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.

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.

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.

var params = {
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.deleteLogSubscription(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 of the directory whose log subscription you want 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.

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  CertificateId: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.deregisterCertificate(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.

  • CertificateId — (String)

    The identifier of the certificate.

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.

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 Amazon SNS topic.

  • TopicName — (String)

    The name of the Amazon 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.

var params = {
  CertificateId: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE' /* required */
};
directoryservice.describeCertificate(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.

  • CertificateId — (String)

    The identifier of the certificate.

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:

    • Certificate — (map)

      Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.

      • CertificateId — (String)

        The identifier of the certificate.

      • State — (String)

        The state of the certificate.

        Possible values include:
        • "Registering"
        • "Registered"
        • "RegisterFailed"
        • "Deregistering"
        • "Deregistered"
        • "DeregisterFailed"
      • StateReason — (String)

        Describes a state change for the certificate.

      • CommonName — (String)

        The common name for the certificate.

      • RegisteredDateTime — (Date)

        The date and time that the certificate was registered.

      • ExpiryDateTime — (Date)

        The date and time when the certificate will expire.

      • Type — (String)

        The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

        Possible values include:
        • "ClientCertAuth"
        • "ClientLDAPS"
      • ClientCertAuthSettings — (map)

        A ClientCertAuthSettings object that contains client certificate authentication settings.

        • OCSPUrl — (String)

          Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: SmartCard | SmartCardOrPassword
};
directoryservice.describeClientAuthenticationSettings(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 information.

  • Type — (String)

    The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

    Possible values include:
    • "SmartCard"
    • "SmartCardOrPassword"
  • NextToken — (String)

    The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. 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:

    • ClientAuthenticationSettingsInfo — (Array<map>)

      Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

      • Type — (String)

        The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved.

        Possible values include:
        • "SmartCard"
        • "SmartCardOrPassword"
      • Status — (String)

        Whether the client authentication type is enabled or disabled for the specified directory.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • LastUpdatedDateTime — (Date)

        The date and time when the status of the client authentication type was last updated.

    • NextToken — (String)

      The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services directory.

        Possible values include:
        • "Domain"

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  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"
      • Edition — (String)

        The edition associated with this directory.

        Possible values include:
        • "Enterprise"
        • "Standard"
      • 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://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

      • Description — (String)

        The 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 your self-managed 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"
      • ShareStatus — (String)

        Current directory status of the shared Managed Microsoft AD directory.

        Possible values include:
        • "Shared"
        • "PendingAcceptance"
        • "Rejected"
        • "Rejecting"
        • "RejectFailed"
        • "Sharing"
        • "ShareFailed"
        • "Deleted"
        • "Deleting"
      • ShareMethod — (String)

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

        Possible values include:
        • "ORGANIZATIONS"
        • "HANDSHAKE"
      • ShareNotes — (String)

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

      • 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"
        • "SharedMicrosoftAD"
      • 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 Microsoft 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 domain controller security group identifier for the directory.

        • 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 user name of the service account in your self-managed 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 fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

        • RadiusPort — (Integer)

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

        • 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)

          Required for enabling RADIUS on the directory.

        • 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.

      • DesiredNumberOfDomainControllers — (Integer)

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

      • OwnerDirectoryDescription — (map)

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

        • DirectoryId — (String)

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

        • AccountId — (String)

          Identifier of the directory owner account.

        • DnsIpAddrs — (Array<String>)

          IP address of the directory’s domain controllers.

        • VpcSettings — (map)

          Information about the VPC settings for the 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 domain controller security group identifier for the directory.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones that the directory is in.

        • RadiusSettings — (map)

          A RadiusSettings object that contains information about the RADIUS server.

          • RadiusServers — (Array<String>)

            An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

          • RadiusPort — (Integer)

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

          • 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)

            Required for enabling RADIUS on the directory.

          • 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)

          Information about the status of the RADIUS server.

          Possible values include:
          • "Creating"
          • "Completed"
          • "Failed"
      • RegionsInfo — (map)

        Lists the Regions where the directory has replicated.

        • PrimaryRegion — (String)

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

        • AdditionalRegions — (Array<String>)

          Lists the Regions where the directory has been replicated, excluding the primary Region.

      • OsVersion — (String)

        The operating system (OS) version of the directory.

        Possible values include:
        • "SERVER_2012"
        • "SERVER_2019"
    • 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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  DomainControllerIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
directoryservice.describeDomainControllers(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 of the directory for which to retrieve the domain controller information.

  • DomainControllerIds — (Array<String>)

    A list of identifiers for the domain controllers whose information will be provided.

  • NextToken — (String)

    The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. 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:

    • DomainControllers — (Array<map>)

      List of the DomainController objects that were retrieved.

      • DirectoryId — (String)

        Identifier of the directory where the domain controller resides.

      • DomainControllerId — (String)

        Identifies a specific domain controller in the directory.

      • DnsIpAddr — (String)

        The IP address of the domain controller.

      • VpcId — (String)

        The identifier of the VPC that contains the domain controller.

      • SubnetId — (String)

        Identifier of the subnet in the VPC that contains the domain controller.

      • AvailabilityZone — (String)

        The Availability Zone where the domain controller is located.

      • Status — (String)

        The status of the domain controller.

        Possible values include:
        • "Creating"
        • "Active"
        • "Impaired"
        • "Restoring"
        • "Deleting"
        • "Deleted"
        • "Failed"
      • StatusReason — (String)

        A description of the domain controller state.

      • LaunchTime — (Date)

        Specifies when the domain controller was created.

      • StatusLastUpdatedDateTime — (Date)

        The date and time that the status was last updated.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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 Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.

  • TopicNames — (Array<String>)

    A list of Amazon 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 Amazon SNS topic names that receive status messages from the specified Directory ID.

      • DirectoryId — (String)

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

      • TopicName — (String)

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

      • TopicArn — (String)

        The Amazon SNS topic ARN (Amazon Resource Name).

      • CreatedDateTime — (Date)

        The date and time of when you associated your directory with the Amazon 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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: Client
};
directoryservice.describeLDAPSSettings(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.

  • Type — (String)

    The type of LDAP security to enable. Currently only the value Client is supported.

    Possible values include:
    • "Client"
  • NextToken — (String)

    The type of next token used for pagination.

  • Limit — (Integer)

    Specifies the number of items that should be displayed on one page.

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:

    • LDAPSSettingsInfo — (Array<map>)

      Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.

      • LDAPSStatus — (String)

        The state of the LDAPS settings.

        Possible values include:
        • "Enabling"
        • "Enabled"
        • "EnableFailed"
        • "Disabled"
      • LDAPSStatusReason — (String)

        Describes a state change for LDAPS.

      • LastUpdatedDateTime — (Date)

        The date and time when the LDAPS settings were last updated.

    • NextToken — (String)

      The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  RegionName: 'STRING_VALUE'
};
directoryservice.describeRegions(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.

  • RegionName — (String)

    The name of the Region. For example, us-east-1.

  • NextToken — (String)

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

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:

    • RegionsDescription — (Array<map>)

      List of Region information related to the directory for each replicated Region.

      • DirectoryId — (String)

        The identifier of the directory.

      • RegionName — (String)

        The name of the Region. For example, us-east-1.

      • RegionType — (String)

        Specifies whether the Region is the primary Region or an additional Region.

        Possible values include:
        • "Primary"
        • "Additional"
      • Status — (String)

        The status of the replication process for the specified Region.

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

        Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

        • VpcId — required — (String)

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

        • SubnetIds — required — (Array<String>)

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

      • DesiredNumberOfDomainControllers — (Integer)

        The desired number of domain controllers in the specified Region for the specified directory.

      • LaunchTime — (Date)

        Specifies when the Region replication began.

      • StatusLastUpdatedDateTime — (Date)

        The date and time that the Region status was last updated.

      • LastUpdatedDateTime — (Date)

        The date and time that the Region description was last updated.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  Status: Requested | Updating | Updated | Failed | Default
};
directoryservice.describeSettings(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 information.

  • Status — (String)

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

    Possible values include:
    • "Requested"
    • "Updating"
    • "Updated"
    • "Failed"
    • "Default"
  • NextToken — (String)

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

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.

    • SettingEntries — (Array<map>)

      The list of SettingEntry objects that were retrieved.

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

      • Type — (String)

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

      • Name — (String)

        The name of the directory setting. For example:

        TLS_1_0

      • AllowedValues — (String)

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

      • AppliedValue — (String)

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

      • RequestedValue — (String)

        The value that was last requested for the directory setting.

      • RequestStatus — (String)

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

        Possible values include:
        • "Requested"
        • "Updating"
        • "Updated"
        • "Failed"
        • "Default"
      • RequestDetailedStatus — (map<String>)

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

      • RequestStatusMessage — (String)

        The last status message for the directory status request.

      • LastUpdatedDateTime — (Date)

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

      • LastRequestedDateTime — (Date)

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

      • DataType — (String)

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

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  OwnerDirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedDirectoryIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
directoryservice.describeSharedDirectories(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: {}) —
  • OwnerDirectoryId — (String)

    Returns the identifier of the directory in the directory owner account.

  • SharedDirectoryIds — (Array<String>)

    A list of identifiers of all shared directories in your account.

  • NextToken — (String)

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

  • Limit — (Integer)

    The number of shared directories to return in the response object.

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:

    • SharedDirectories — (Array<map>)

      A list of all shared directories in your account.

      • OwnerAccountId — (String)

        Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

      • OwnerDirectoryId — (String)

        Identifier of the directory in the directory owner account.

      • ShareMethod — (String)

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

        Possible values include:
        • "ORGANIZATIONS"
        • "HANDSHAKE"
      • SharedAccountId — (String)

        Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.

      • SharedDirectoryId — (String)

        Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

      • ShareStatus — (String)

        Current directory status of the shared Managed Microsoft AD directory.

        Possible values include:
        • "Shared"
        • "PendingAcceptance"
        • "Rejected"
        • "Rejecting"
        • "RejectFailed"
        • "Sharing"
        • "ShareFailed"
        • "Deleted"
        • "Deleting"
      • ShareNotes — (String)

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

      • CreatedDateTime — (Date)

        The date and time that the shared directory was created.

      • LastUpdatedDateTime — (Date)

        The date and time that the shared directory was last updated.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  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.

var params = {
  DirectoryId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  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 Amazon Web Services 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 Amazon Web Services 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. Forest is the default.

        Possible values include:
        • "Forest"
        • "External"
      • 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"
        • "Updating"
        • "UpdateFailed"
        • "Updated"
        • "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.

      • SelectiveAuth — (String)

        Current state of selective authentication for the trust.

        Possible values include:
        • "Enabled"
        • "Disabled"
    • 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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  UpdateType: OS, /* required */
  NextToken: 'STRING_VALUE',
  RegionName: 'STRING_VALUE'
};
directoryservice.describeUpdateDirectory(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 unique identifier of the directory.

  • UpdateType — (String)

    The type of updates you want to describe for the directory.

    Possible values include:
    • "OS"
  • RegionName — (String)

    The name of the Region.

  • NextToken — (String)

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

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:

    • UpdateActivities — (Array<map>)

      The list of update activities on a directory for the requested update type.

      • Region — (String)

        The name of the Region.

      • Status — (String)

        The status of the update performed on the directory.

        Possible values include:
        • "Updated"
        • "Updating"
        • "UpdateFailed"
      • StatusReason — (String)

        The reason for the current status of the update type activity.

      • InitiatedBy — (String)

        This specifies if the update was initiated by the customer or by the service team.

      • NewValue — (map)

        The new value of the target setting.

        • OSUpdateSettings — (map)

          The OS update related settings.

          • OSVersion — (String)

            OS version that the directory needs to be updated to.

            Possible values include:
            • "SERVER_2012"
            • "SERVER_2019"
      • PreviousValue — (map)

        The old value of the target setting.

        • OSUpdateSettings — (map)

          The OS update related settings.

          • OSVersion — (String)

            OS version that the directory needs to be updated to.

            Possible values include:
            • "SERVER_2012"
            • "SERVER_2019"
      • StartTime — (Date)

        The start time of the UpdateDirectorySetup for the particular type.

      • LastUpdatedDateTime — (Date)

        The last updated date and time of a particular directory setting.

    • NextToken — (String)

      If not null, more results are available. Pass this value for the NextToken parameter.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Type: SmartCard | SmartCardOrPassword /* required */
};
directoryservice.disableClientAuthentication(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

  • Type — (String)

    The type of client authentication to disable. Currently, only the parameter, SmartCard is supported.

    Possible values include:
    • "SmartCard"
    • "SmartCardOrPassword"

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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Type: Client /* required */
};
directoryservice.disableLDAPS(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.

  • Type — (String)

    The type of LDAP security to enable. Currently only the value Client is supported.

    Possible values include:
    • "Client"

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.

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.

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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Type: SmartCard | SmartCardOrPassword /* required */
};
directoryservice.enableClientAuthentication(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 specified directory.

  • Type — (String)

    The type of client authentication to enable. Currently only the value SmartCard is supported. Smart card authentication in AD Connector requires that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in your self-managed AD.

    Possible values include:
    • "SmartCard"
    • "SmartCardOrPassword"

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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Type: Client /* required */
};
directoryservice.enableLDAPS(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.

  • Type — (String)

    The type of LDAP security to enable. Currently only the value Client is supported.

    Possible values include:
    • "Client"

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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  RadiusSettings: { /* required */
    AuthenticationProtocol: PAP | CHAP | MS-CHAPv1 | MS-CHAPv2,
    DisplayLabel: 'STRING_VALUE',
    RadiusPort: 'NUMBER_VALUE',
    RadiusRetries: 'NUMBER_VALUE',
    RadiusServers: [
      'STRING_VALUE',
      /* more items */
    ],
    RadiusTimeout: 'NUMBER_VALUE',
    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 fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

    • RadiusPort — (Integer)

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

    • 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)

      Required for enabling RADIUS on the directory.

    • 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.

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.

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 Managed Microsoft AD directories allowed in the region.

      • CloudOnlyMicrosoftADCurrentCount — (Integer)

        The current number of Managed Microsoft AD directories in the region.

      • CloudOnlyMicrosoftADLimitReached — (Boolean)

        Indicates if the Managed 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.

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.

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
directoryservice.listCertificates(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.

  • NextToken — (String)

    A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

  • Limit — (Integer)

    The number of items that should show up on one page

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:

    • NextToken — (String)

      Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

    • CertificatesInfo — (Array<map>)

      A list of certificates with basic details including certificate ID, certificate common name, certificate state.

      • CertificateId — (String)

        The identifier of the certificate.

      • CommonName — (String)

        The common name for the certificate.

      • State — (String)

        The state of the certificate.

        Possible values include:
        • "Registering"
        • "Registered"
        • "RegisterFailed"
        • "Deregistering"
        • "Deregistered"
        • "DeregisterFailed"
      • ExpiryDateTime — (Date)

        The date and time when the certificate will expire.

      • Type — (String)

        The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

        Possible values include:
        • "ClientCertAuth"
        • "ClientLDAPS"

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  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.

var params = {
  DirectoryId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
directoryservice.listLogSubscriptions(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)

    If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.

  • NextToken — (String)

    The token for the next set of items to return.

  • Limit — (Integer)

    The maximum number of items 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:

    • LogSubscriptions — (Array<map>)

      A list of active LogSubscription objects for calling the Amazon Web Services account.

      • DirectoryId — (String)

        Identifier (ID) of the directory that you want to associate with the log subscription.

      • LogGroupName — (String)

        The name of the log group.

      • SubscriptionCreatedDateTime — (Date)

        The date and time that the log subscription was created.

    • NextToken — (String)

      The token for the next set of items to return.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  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.

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  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.

      • Key — required — (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}.:/=+\-]*)$").

      • Value — required — (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.

var params = {
  CertificateData: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE', /* required */
  ClientCertAuthSettings: {
    OCSPUrl: 'STRING_VALUE'
  },
  Type: ClientCertAuth | ClientLDAPS
};
directoryservice.registerCertificate(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.

  • CertificateData — (String)

    The certificate PEM string that needs to be registered.

  • Type — (String)

    The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

    Possible values include:
    • "ClientCertAuth"
    • "ClientLDAPS"
  • ClientCertAuthSettings — (map)

    A ClientCertAuthSettings object that contains client certificate authentication settings.

    • OCSPUrl — (String)

      Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.

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:

    • CertificateId — (String)

      The identifier of the certificate.