Class: AWS.CloudDirectory

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  PublishedSchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.applySchema(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: {}) —
  • PublishedSchemaArn — (String)

    Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

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:

    • AppliedSchemaArn — (String)

      The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

    • DirectoryArn — (String)

      The ARN that is associated with the Directory. For more information, see arns.

Returns:

• (AWS.Request) —

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

var params = {
  ChildReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  DirectoryArn: 'STRING_VALUE', /* required */
  LinkName: 'STRING_VALUE', /* required */
  ParentReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.attachObject(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: {}) —
  • DirectoryArn — (String)

    Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

  • ParentReference — (map)

    The parent object reference.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • ChildReference — (map)

    The child object reference to be attached to the object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • LinkName — (String)

    The link name with which the child object is attached to the parent.

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:

    • AttachedObjectIdentifier — (String)

      The attached ObjectIdentifier, which is the child ObjectIdentifier.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  PolicyReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.attachPolicy(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

  • PolicyReference — (map)

    The reference that is associated with the policy object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • ObjectReference — (map)

    The reference that identifies the object to which the policy will be attached.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch 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.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  IndexReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  TargetReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.attachToIndex(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) of the directory where the object and index exist.

  • IndexReference — (map)

    A reference to the index that you are attaching the object to.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • TargetReference — (map)

    A reference to the object that you are attaching to the index.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch 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:

    • AttachedObjectIdentifier — (String)

      The ObjectIdentifier of the object that was attached to the index.

Returns:

• (AWS.Request) —

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

var params = {
  Attributes: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      Value: { /* required */
        BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BooleanValue: true || false,
        DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        NumberValue: 'STRING_VALUE',
        StringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  DirectoryArn: 'STRING_VALUE', /* required */
  SourceObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  TargetObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  TypedLinkFacet: { /* required */
    SchemaArn: 'STRING_VALUE', /* required */
    TypedLinkName: 'STRING_VALUE' /* required */
  }
};
clouddirectory.attachTypedLink(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

  • SourceObjectReference — (map)

    Identifies the source object that the typed link will attach to.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • TargetObjectReference — (map)

    Identifies the target object that the typed link will attach to.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • TypedLinkFacet — (map)

    Identifies the typed link facet that is associated with the typed link.

    • SchemaArn — required — (String)

      The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

    • TypedLinkName — required — (String)

      The unique name of the typed link facet.

  • Attributes — (Array<map>)

    A set of attributes that are associated with the typed link.

    • AttributeName — required — (String)

      The attribute name of the typed link.

    • Value — required — (map)

      The value for the typed link.

      • StringValue — (String)

        A string data value.

      • BinaryValue — (Buffer, Typed Array, Blob, String)

        A binary data value.

      • BooleanValue — (Boolean)

        A Boolean data value.

      • NumberValue — (String)

        A number data value.

      • DatetimeValue — (Date)

        A date and time value.

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:

    • TypedLinkSpecifier — (map)

      Returns a typed link specifier as output.

      • TypedLinkFacet — required — (map)

        Identifies the typed link facet that is associated with the typed link.

        • SchemaArn — required — (String)

          The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

        • TypedLinkName — required — (String)

          The unique name of the typed link facet.

      • SourceObjectReference — required — (map)

        Identifies the source object that the typed link will attach to.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • TargetObjectReference — required — (map)

        Identifies the target object that the typed link will attach to.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • IdentityAttributeValues — required — (Array<map>)

        Identifies the attribute value to update.

        • AttributeName — required — (String)

          The attribute name of the typed link.

        • Value — required — (map)

          The value for the typed link.

          • StringValue — (String)

            A string data value.

          • BinaryValue — (Buffer, Typed Array, Blob, String)

            A binary data value.

          • BooleanValue — (Boolean)

            A Boolean data value.

          • NumberValue — (String)

            A number data value.

          • DatetimeValue — (Date)

            A date and time value.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    {
      GetLinkAttributes: {
        AttributeNames: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        TypedLinkSpecifier: { /* required */
          IdentityAttributeValues: [ /* required */
            {
              AttributeName: 'STRING_VALUE', /* required */
              Value: { /* required */
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            /* more items */
          ],
          SourceObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TargetObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TypedLinkFacet: { /* required */
            SchemaArn: 'STRING_VALUE', /* required */
            TypedLinkName: 'STRING_VALUE' /* required */
          }
        }
      },
      GetObjectAttributes: {
        AttributeNames: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        SchemaFacet: { /* required */
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        }
      },
      GetObjectInformation: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      ListAttachedIndices: {
        TargetReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListIncomingTypedLinks: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        FilterAttributeRanges: [
          {
            Range: { /* required */
              EndMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              StartMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              EndValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              },
              StartValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            AttributeName: 'STRING_VALUE'
          },
          /* more items */
        ],
        FilterTypedLink: {
          SchemaArn: 'STRING_VALUE', /* required */
          TypedLinkName: 'STRING_VALUE' /* required */
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListIndex: {
        IndexReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE',
        RangesOnIndexedValues: [
          {
            AttributeKey: {
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            },
            Range: {
              EndMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              StartMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              EndValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              },
              StartValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            }
          },
          /* more items */
        ]
      },
      ListObjectAttributes: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        FacetFilter: {
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListObjectChildren: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListObjectParentPaths: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListObjectParents: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListObjectPolicies: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListOutgoingTypedLinks: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        FilterAttributeRanges: [
          {
            Range: { /* required */
              EndMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              StartMode: FIRST | LAST | LAST_BEFORE_MISSING_VALUES | INCLUSIVE | EXCLUSIVE, /* required */
              EndValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              },
              StartValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            AttributeName: 'STRING_VALUE'
          },
          /* more items */
        ],
        FilterTypedLink: {
          SchemaArn: 'STRING_VALUE', /* required */
          TypedLinkName: 'STRING_VALUE' /* required */
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      ListPolicyAttachments: {
        PolicyReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      },
      LookupPolicy: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 'NUMBER_VALUE',
        NextToken: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  ConsistencyLevel: SERIALIZABLE | EVENTUAL
};
clouddirectory.batchRead(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

  • Operations — (Array<map>)

    A list of operations that are part of the batch.

    • ListObjectAttributes — (map)

      Lists all attributes that are associated with an object.

      • ObjectReference — required — (map)

        Reference of the object whose attributes need to be listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of items to be retrieved in a single call. This is an approximate number.

      • FacetFilter — (map)

        Used to filter the list of object attributes that are associated with a certain facet.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

        • FacetName — (String)

          The name of the facet. If this value is set, SchemaArn must also be set.

    • ListObjectChildren — (map)

      Returns a paginated list of child objects that are associated with a given object.

      • ObjectReference — required — (map)

        Reference of the object for which child objects are being listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        Maximum number of items to be retrieved in a single call. This is an approximate number.

    • ListAttachedIndices — (map)

      Lists indices attached to an object.

      • TargetReference — required — (map)

        A reference to the object that has indices attached.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • ListObjectParentPaths — (map)

      Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

      • ObjectReference — required — (map)

        The reference that identifies the object whose attributes will be listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • GetObjectInformation — (map)

      Retrieves metadata about an object.

      • ObjectReference — required — (map)

        A reference to the object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • GetObjectAttributes — (map)

      Retrieves attributes within a facet that are associated with an object.

      • ObjectReference — required — (map)

        Reference that identifies the object whose attributes will be retrieved.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • SchemaFacet — required — (map)

        Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

        • FacetName — (String)

          The name of the facet. If this value is set, SchemaArn must also be set.

      • AttributeNames — required — (Array<String>)

        List of attribute names whose values will be retrieved.

    • ListObjectParents — (map)

      Lists parent objects that are associated with a given object in pagination fashion.

      • ObjectReference — required — (map)

        The reference that identifies an object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of items to be retrieved in a single call. This is an approximate number.

    • ListObjectPolicies — (map)

      Returns policies attached to an object in pagination fashion.

      • ObjectReference — required — (map)

        The reference that identifies the object whose attributes will be listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • ListPolicyAttachments — (map)

      Returns all of the ObjectIdentifiers to which a given policy is attached.

      • PolicyReference — required — (map)

        The reference that identifies the policy object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • LookupPolicy — (map)

      Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

      • ObjectReference — required — (map)

        Reference that identifies the object whose policies will be looked up.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • ListIndex — (map)

      Lists objects attached to the specified index.

      • RangesOnIndexedValues — (Array<map>)

        Specifies the ranges of indexed values that you want to query.

        • AttributeKey — (map)

          The key of the attribute that the attribute range covers.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

          • FacetName — required — (String)

            The name of the facet that the attribute exists within.

          • Name — required — (String)

            The name of the attribute.

        • Range — (map)

          The range of attribute values being selected.

          • StartMode — required — (String)

            The inclusive or exclusive range start.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • StartValue — (map)

            The value to start the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

          • EndMode — required — (String)

            The inclusive or exclusive range end.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • EndValue — (map)

            The attribute value to terminate the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

      • IndexReference — required — (map)

        The reference to the index to list.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

      • NextToken — (String)

        The pagination token.

    • ListOutgoingTypedLinks — (map)

      Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

      • ObjectReference — required — (map)

        The reference that identifies the object whose attributes will be listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • FilterAttributeRanges — (Array<map>)

        Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

        • AttributeName — (String)

          The unique name of the typed link attribute.

        • Range — required — (map)

          The range of attribute values that are being selected.

          • StartMode — required — (String)

            The inclusive or exclusive range start.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • StartValue — (map)

            The value to start the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

          • EndMode — required — (String)

            The inclusive or exclusive range end.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • EndValue — (map)

            The attribute value to terminate the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

      • FilterTypedLink — (map)

        Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

        • SchemaArn — required — (String)

          The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

        • TypedLinkName — required — (String)

          The unique name of the typed link facet.

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • ListIncomingTypedLinks — (map)

      Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

      • ObjectReference — required — (map)

        The reference that identifies the object whose attributes will be listed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • FilterAttributeRanges — (Array<map>)

        Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

        • AttributeName — (String)

          The unique name of the typed link attribute.

        • Range — required — (map)

          The range of attribute values that are being selected.

          • StartMode — required — (String)

            The inclusive or exclusive range start.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • StartValue — (map)

            The value to start the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

          • EndMode — required — (String)

            The inclusive or exclusive range end.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "LAST_BEFORE_MISSING_VALUES"
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • EndValue — (map)

            The attribute value to terminate the range at.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

      • FilterTypedLink — (map)

        Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

        • SchemaArn — required — (String)

          The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

        • TypedLinkName — required — (String)

          The unique name of the typed link facet.

      • NextToken — (String)

        The pagination token.

      • MaxResults — (Integer)

        The maximum number of results to retrieve.

    • GetLinkAttributes — (map)

      Retrieves attributes that are associated with a typed link.

      • TypedLinkSpecifier — required — (map)

        Allows a typed link specifier to be accepted as input.

        • TypedLinkFacet — required — (map)

          Identifies the typed link facet that is associated with the typed link.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

          • TypedLinkName — required — (String)

            The unique name of the typed link facet.

        • SourceObjectReference — required — (map)

          Identifies the source object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • TargetObjectReference — required — (map)

          Identifies the target object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • IdentityAttributeValues — required — (Array<map>)

          Identifies the attribute value to update.

          • AttributeName — required — (String)

            The attribute name of the typed link.

          • Value — required — (map)

            The value for the typed link.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

      • AttributeNames — required — (Array<String>)

        A list of attribute names whose values will be retrieved.

  • ConsistencyLevel — (String)

    Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

    Possible values include:
    • "SERIALIZABLE"
    • "EVENTUAL"

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:

    • Responses — (Array<map>)

      A list of all the responses for each batch read.

      • SuccessfulResponse — (map)

        Identifies which operation in a batch has succeeded.

        • ListObjectAttributes — (map)

          Lists all attributes that are associated with an object.

          • Attributes — (Array<map>)

            The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.

            • Key — required — (map)

              The key of the attribute.

              • SchemaArn — required — (String)

                The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

              • FacetName — required — (String)

                The name of the facet that the attribute exists within.

              • Name — required — (String)

                The name of the attribute.

            • Value — required — (map)

              The value of the attribute.

              • StringValue — (String)

                A string data value.

              • BinaryValue — (Buffer, Typed Array, Blob, String)

                A binary data value.

              • BooleanValue — (Boolean)

                A Boolean data value.

              • NumberValue — (String)

                A number data value.

              • DatetimeValue — (Date)

                A date and time value.

          • NextToken — (String)

            The pagination token.

        • ListObjectChildren — (map)

          Returns a paginated list of child objects that are associated with a given object.

          • Children — (map<String>)

            The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.

          • NextToken — (String)

            The pagination token.

        • GetObjectInformation — (map)

          Retrieves metadata about an object.

          • SchemaFacets — (Array<map>)

            The facets attached to the specified object.

            • SchemaArn — (String)

              The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

            • FacetName — (String)

              The name of the facet. If this value is set, SchemaArn must also be set.

          • ObjectIdentifier — (String)

            The ObjectIdentifier of the specified object.

        • GetObjectAttributes — (map)

          Retrieves attributes within a facet that are associated with an object.

          • Attributes — (Array<map>)

            The attribute values that are associated with an object.

            • Key — required — (map)

              The key of the attribute.

              • SchemaArn — required — (String)

                The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

              • FacetName — required — (String)

                The name of the facet that the attribute exists within.

              • Name — required — (String)

                The name of the attribute.

            • Value — required — (map)

              The value of the attribute.

              • StringValue — (String)

                A string data value.

              • BinaryValue — (Buffer, Typed Array, Blob, String)

                A binary data value.

              • BooleanValue — (Boolean)

                A Boolean data value.

              • NumberValue — (String)

                A number data value.

              • DatetimeValue — (Date)

                A date and time value.

        • ListAttachedIndices — (map)

          Lists indices attached to an object.

          • IndexAttachments — (Array<map>)

            The indices attached to the specified object.

            • IndexedAttributes — (Array<map>)

              The indexed attribute values.

              • Key — required — (map)

                The key of the attribute.

                • SchemaArn — required — (String)

                  The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

                • FacetName — required — (String)

                  The name of the facet that the attribute exists within.

                • Name — required — (String)

                  The name of the attribute.

              • Value — required — (map)

                The value of the attribute.

                • StringValue — (String)

                  A string data value.

                • BinaryValue — (Buffer, Typed Array, Blob, String)

                  A binary data value.

                • BooleanValue — (Boolean)

                  A Boolean data value.

                • NumberValue — (String)

                  A number data value.

                • DatetimeValue — (Date)

                  A date and time value.

            • ObjectIdentifier — (String)

              In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

          • NextToken — (String)

            The pagination token.

        • ListObjectParentPaths — (map)

          Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

          • PathToObjectIdentifiersList — (Array<map>)

            Returns the path to the ObjectIdentifiers that are associated with the directory.

            • Path — (String)

              The path that is used to identify the object starting from directory root.

            • ObjectIdentifiers — (Array<String>)

              Lists ObjectIdentifiers starting from directory root to the object in the request.

          • NextToken — (String)

            The pagination token.

        • ListObjectPolicies — (map)

          Returns policies attached to an object in pagination fashion.

          • AttachedPolicyIds — (Array<String>)

            A list of policy ObjectIdentifiers, that are attached to the object.

          • NextToken — (String)

            The pagination token.

        • ListPolicyAttachments — (map)

          Returns all of the ObjectIdentifiers to which a given policy is attached.

          • ObjectIdentifiers — (Array<String>)

            A list of ObjectIdentifiers to which the policy is attached.

          • NextToken — (String)

            The pagination token.

        • LookupPolicy — (map)

          Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

          • PolicyToPathList — (Array<map>)

            Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

            • Path — (String)

              The path that is referenced from the root.

            • Policies — (Array<map>)

              List of policy objects.

              • PolicyId — (String)

                The ID of PolicyAttachment.

              • ObjectIdentifier — (String)

                The ObjectIdentifier that is associated with PolicyAttachment.

              • PolicyType — (String)

                The type of policy that can be associated with PolicyAttachment.

          • NextToken — (String)

            The pagination token.

        • ListIndex — (map)

          Lists objects attached to the specified index.

          • IndexAttachments — (Array<map>)

            The objects and indexed values attached to the index.

            • IndexedAttributes — (Array<map>)

              The indexed attribute values.

              • Key — required — (map)

                The key of the attribute.

                • SchemaArn — required — (String)

                  The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

                • FacetName — required — (String)

                  The name of the facet that the attribute exists within.

                • Name — required — (String)

                  The name of the attribute.

              • Value — required — (map)

                The value of the attribute.

                • StringValue — (String)

                  A string data value.

                • BinaryValue — (Buffer, Typed Array, Blob, String)

                  A binary data value.

                • BooleanValue — (Boolean)

                  A Boolean data value.

                • NumberValue — (String)

                  A number data value.

                • DatetimeValue — (Date)

                  A date and time value.

            • ObjectIdentifier — (String)

              In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

          • NextToken — (String)

            The pagination token.

        • ListOutgoingTypedLinks — (map)

          Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

          • TypedLinkSpecifiers — (Array<map>)

            Returns a typed link specifier as output.

            • TypedLinkFacet — required — (map)

              Identifies the typed link facet that is associated with the typed link.

              • SchemaArn — required — (String)

                The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

              • TypedLinkName — required — (String)

                The unique name of the typed link facet.

            • SourceObjectReference — required — (map)

              Identifies the source object that the typed link will attach to.

              • Selector — (String)

                A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

                • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

                • /some/path - Identifies the object based on path

                • #SomeBatchReference - Identifies the object in a batch call

            • TargetObjectReference — required — (map)

              Identifies the target object that the typed link will attach to.

              • Selector — (String)

                A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

                • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

                • /some/path - Identifies the object based on path

                • #SomeBatchReference - Identifies the object in a batch call

            • IdentityAttributeValues — required — (Array<map>)

              Identifies the attribute value to update.

              • AttributeName — required — (String)

                The attribute name of the typed link.

              • Value — required — (map)

                The value for the typed link.

                • StringValue — (String)

                  A string data value.

                • BinaryValue — (Buffer, Typed Array, Blob, String)

                  A binary data value.

                • BooleanValue — (Boolean)

                  A Boolean data value.

                • NumberValue — (String)

                  A number data value.

                • DatetimeValue — (Date)

                  A date and time value.

          • NextToken — (String)

            The pagination token.

        • ListIncomingTypedLinks — (map)

          Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

          • LinkSpecifiers — (Array<map>)

            Returns one or more typed link specifiers as output.

            • TypedLinkFacet — required — (map)

              Identifies the typed link facet that is associated with the typed link.

              • SchemaArn — required — (String)

                The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

              • TypedLinkName — required — (String)

                The unique name of the typed link facet.

            • SourceObjectReference — required — (map)

              Identifies the source object that the typed link will attach to.

              • Selector — (String)

                A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

                • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

                • /some/path - Identifies the object based on path

                • #SomeBatchReference - Identifies the object in a batch call

            • TargetObjectReference — required — (map)

              Identifies the target object that the typed link will attach to.

              • Selector — (String)

                A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

                • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

                • /some/path - Identifies the object based on path

                • #SomeBatchReference - Identifies the object in a batch call

            • IdentityAttributeValues — required — (Array<map>)

              Identifies the attribute value to update.

              • AttributeName — required — (String)

                The attribute name of the typed link.

              • Value — required — (map)

                The value for the typed link.

                • StringValue — (String)

                  A string data value.

                • BinaryValue — (Buffer, Typed Array, Blob, String)

                  A binary data value.

                • BooleanValue — (Boolean)

                  A Boolean data value.

                • NumberValue — (String)

                  A number data value.

                • DatetimeValue — (Date)

                  A date and time value.

          • NextToken — (String)

            The pagination token.

        • GetLinkAttributes — (map)

          The list of attributes to retrieve from the typed link.

          • Attributes — (Array<map>)

            The attributes that are associated with the typed link.

            • Key — required — (map)

              The key of the attribute.

              • SchemaArn — required — (String)

                The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

              • FacetName — required — (String)

                The name of the facet that the attribute exists within.

              • Name — required — (String)

                The name of the attribute.

            • Value — required — (map)

              The value of the attribute.

              • StringValue — (String)

                A string data value.

              • BinaryValue — (Buffer, Typed Array, Blob, String)

                A binary data value.

              • BooleanValue — (Boolean)

                A Boolean data value.

              • NumberValue — (String)

                A number data value.

              • DatetimeValue — (Date)

                A date and time value.

        • ListObjectParents — (map)

          The list of parent objects to retrieve.

          • ParentLinks — (Array<map>)

            Returns a list of parent reference and LinkName Tuples.

            • ObjectIdentifier — (String)

              The ID that is associated with the object.

            • LinkName — (String)

              The name of the link between the parent and the child object.

          • NextToken — (String)

            The pagination token.

      • ExceptionResponse — (map)

        Identifies which operation in a batch has failed.

        • Type — (String)

          A type of exception, such as InvalidArnException.

          Possible values include:
          • "ValidationException"
          • "InvalidArnException"
          • "ResourceNotFoundException"
          • "InvalidNextTokenException"
          • "AccessDeniedException"
          • "NotNodeException"
          • "FacetValidationException"
          • "CannotListParentOfRootException"
          • "NotIndexException"
          • "NotPolicyException"
          • "DirectoryNotEnabledException"
          • "LimitExceededException"
          • "InternalServiceException"
        • Message — (String)

          An exception message that is associated with the failure.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    {
      AddFacetToObject: {
        ObjectAttributeList: [ /* required */
          {
            Key: { /* required */
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            },
            Value: { /* required */
              BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BooleanValue: true || false,
              DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
              NumberValue: 'STRING_VALUE',
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        SchemaFacet: { /* required */
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        }
      },
      AttachObject: {
        ChildReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        LinkName: 'STRING_VALUE', /* required */
        ParentReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      AttachPolicy: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        PolicyReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      AttachToIndex: {
        IndexReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        TargetReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      AttachTypedLink: {
        Attributes: [ /* required */
          {
            AttributeName: 'STRING_VALUE', /* required */
            Value: { /* required */
              BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BooleanValue: true || false,
              DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
              NumberValue: 'STRING_VALUE',
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        SourceObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        TargetObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        TypedLinkFacet: { /* required */
          SchemaArn: 'STRING_VALUE', /* required */
          TypedLinkName: 'STRING_VALUE' /* required */
        }
      },
      CreateIndex: {
        IsUnique: true || false, /* required */
        OrderedIndexedAttributeList: [ /* required */
          {
            FacetName: 'STRING_VALUE', /* required */
            Name: 'STRING_VALUE', /* required */
            SchemaArn: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        BatchReferenceName: 'STRING_VALUE',
        LinkName: 'STRING_VALUE',
        ParentReference: {
          Selector: 'STRING_VALUE'
        }
      },
      CreateObject: {
        ObjectAttributeList: [ /* required */
          {
            Key: { /* required */
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            },
            Value: { /* required */
              BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BooleanValue: true || false,
              DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
              NumberValue: 'STRING_VALUE',
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        SchemaFacet: [ /* required */
          {
            FacetName: 'STRING_VALUE',
            SchemaArn: 'STRING_VALUE'
          },
          /* more items */
        ],
        BatchReferenceName: 'STRING_VALUE',
        LinkName: 'STRING_VALUE',
        ParentReference: {
          Selector: 'STRING_VALUE'
        }
      },
      DeleteObject: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      DetachFromIndex: {
        IndexReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        TargetReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      DetachObject: {
        LinkName: 'STRING_VALUE', /* required */
        ParentReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        BatchReferenceName: 'STRING_VALUE'
      },
      DetachPolicy: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        PolicyReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      DetachTypedLink: {
        TypedLinkSpecifier: { /* required */
          IdentityAttributeValues: [ /* required */
            {
              AttributeName: 'STRING_VALUE', /* required */
              Value: { /* required */
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            /* more items */
          ],
          SourceObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TargetObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TypedLinkFacet: { /* required */
            SchemaArn: 'STRING_VALUE', /* required */
            TypedLinkName: 'STRING_VALUE' /* required */
          }
        }
      },
      RemoveFacetFromObject: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        SchemaFacet: { /* required */
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        }
      },
      UpdateLinkAttributes: {
        AttributeUpdates: [ /* required */
          {
            AttributeAction: {
              AttributeActionType: CREATE_OR_UPDATE | DELETE,
              AttributeUpdateValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            AttributeKey: {
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            }
          },
          /* more items */
        ],
        TypedLinkSpecifier: { /* required */
          IdentityAttributeValues: [ /* required */
            {
              AttributeName: 'STRING_VALUE', /* required */
              Value: { /* required */
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            /* more items */
          ],
          SourceObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TargetObjectReference: { /* required */
            Selector: 'STRING_VALUE'
          },
          TypedLinkFacet: { /* required */
            SchemaArn: 'STRING_VALUE', /* required */
            TypedLinkName: 'STRING_VALUE' /* required */
          }
        }
      },
      UpdateObjectAttributes: {
        AttributeUpdates: [ /* required */
          {
            ObjectAttributeAction: {
              ObjectAttributeActionType: CREATE_OR_UPDATE | DELETE,
              ObjectAttributeUpdateValue: {
                BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                BooleanValue: true || false,
                DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                NumberValue: 'STRING_VALUE',
                StringValue: 'STRING_VALUE'
              }
            },
            ObjectAttributeKey: {
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            }
          },
          /* more items */
        ],
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ]
};
clouddirectory.batchWrite(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

  • Operations — (Array<map>)

    A list of operations that are part of the batch.

    • CreateObject — (map)

      Creates an object.

      • SchemaFacet — required — (Array<map>)

        A list of FacetArns that will be associated with the object. For more information, see arns.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

        • FacetName — (String)

          The name of the facet. If this value is set, SchemaArn must also be set.

      • ObjectAttributeList — required — (Array<map>)

        An attribute map, which contains an attribute ARN as the key and attribute value as the map value.

        • Key — required — (map)

          The key of the attribute.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

          • FacetName — required — (String)

            The name of the facet that the attribute exists within.

          • Name — required — (String)

            The name of the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string data value.

          • BinaryValue — (Buffer, Typed Array, Blob, String)

            A binary data value.

          • BooleanValue — (Boolean)

            A Boolean data value.

          • NumberValue — (String)

            A number data value.

          • DatetimeValue — (Date)

            A date and time value.

      • ParentReference — (map)

        If specified, the parent reference to which this object will be attached.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • LinkName — (String)

        The name of the link.

      • BatchReferenceName — (String)

        The batch reference name. See Transaction Support for more information.

    • AttachObject — (map)

      Attaches an object to a Directory.

      • ParentReference — required — (map)

        The parent object reference.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • ChildReference — required — (map)

        The child object reference that is to be attached to the object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • LinkName — required — (String)

        The name of the link.

    • DetachObject — (map)

      Detaches an object from a Directory.

      • ParentReference — required — (map)

        Parent reference from which the object with the specified link name is detached.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • LinkName — required — (String)

        The name of the link.

      • BatchReferenceName — (String)

        The batch reference name. See Transaction Support for more information.

    • UpdateObjectAttributes — (map)

      Updates a given object's attributes.

      • ObjectReference — required — (map)

        Reference that identifies the object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • AttributeUpdates — required — (Array<map>)

        Attributes update structure.

        • ObjectAttributeKey — (map)

          The key of the attribute being updated.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

          • FacetName — required — (String)

            The name of the facet that the attribute exists within.

          • Name — required — (String)

            The name of the attribute.

        • ObjectAttributeAction — (map)

          The action to perform as part of the attribute update.

          • ObjectAttributeActionType — (String)

            A type that can be either Update or Delete.

            Possible values include:
            • "CREATE_OR_UPDATE"
            • "DELETE"
          • ObjectAttributeUpdateValue — (map)

            The value that you want to update to.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

    • DeleteObject — (map)

      Deletes an object in a Directory.

      • ObjectReference — required — (map)

        The reference that identifies the object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • AddFacetToObject — (map)

      A batch operation that adds a facet to an object.

      • SchemaFacet — required — (map)

        Represents the facet being added to the object.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

        • FacetName — (String)

          The name of the facet. If this value is set, SchemaArn must also be set.

      • ObjectAttributeList — required — (Array<map>)

        The attributes to set on the object.

        • Key — required — (map)

          The key of the attribute.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

          • FacetName — required — (String)

            The name of the facet that the attribute exists within.

          • Name — required — (String)

            The name of the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string data value.

          • BinaryValue — (Buffer, Typed Array, Blob, String)

            A binary data value.

          • BooleanValue — (Boolean)

            A Boolean data value.

          • NumberValue — (String)

            A number data value.

          • DatetimeValue — (Date)

            A date and time value.

      • ObjectReference — required — (map)

        A reference to the object being mutated.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • RemoveFacetFromObject — (map)

      A batch operation that removes a facet from an object.

      • SchemaFacet — required — (map)

        The facet to remove from the object.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

        • FacetName — (String)

          The name of the facet. If this value is set, SchemaArn must also be set.

      • ObjectReference — required — (map)

        A reference to the object whose facet will be removed.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • AttachPolicy — (map)

      Attaches a policy object to a regular object. An object can have a limited number of attached policies.

      • PolicyReference — required — (map)

        The reference that is associated with the policy object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • ObjectReference — required — (map)

        The reference that identifies the object to which the policy will be attached.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • DetachPolicy — (map)

      Detaches a policy from a Directory.

      • PolicyReference — required — (map)

        Reference that identifies the policy object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • ObjectReference — required — (map)

        Reference that identifies the object whose policy object will be detached.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • CreateIndex — (map)

      Creates an index object. See Indexing and search for more information.

      • OrderedIndexedAttributeList — required — (Array<map>)

        Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

        • SchemaArn — required — (String)

          The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

        • FacetName — required — (String)

          The name of the facet that the attribute exists within.

        • Name — required — (String)

          The name of the attribute.

      • IsUnique — required — (Boolean)

        Indicates whether the attribute that is being indexed has unique values or not.

      • ParentReference — (map)

        A reference to the parent object that contains the index object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • LinkName — (String)

        The name of the link between the parent object and the index object.

      • BatchReferenceName — (String)

        The batch reference name. See Transaction Support for more information.

    • AttachToIndex — (map)

      Attaches the specified object to the specified index.

      • IndexReference — required — (map)

        A reference to the index that you are attaching the object to.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • TargetReference — required — (map)

        A reference to the object that you are attaching to the index.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • DetachFromIndex — (map)

      Detaches the specified object from the specified index.

      • IndexReference — required — (map)

        A reference to the index object.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • TargetReference — required — (map)

        A reference to the object being detached from the index.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

    • AttachTypedLink — (map)

      Attaches a typed link to a specified source and target object. For more information, see Typed Links.

      • SourceObjectReference — required — (map)

        Identifies the source object that the typed link will attach to.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • TargetObjectReference — required — (map)

        Identifies the target object that the typed link will attach to.

        • Selector — (String)

          A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

          • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

          • /some/path - Identifies the object based on path

          • #SomeBatchReference - Identifies the object in a batch call

      • TypedLinkFacet — required — (map)

        Identifies the typed link facet that is associated with the typed link.

        • SchemaArn — required — (String)

          The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

        • TypedLinkName — required — (String)

          The unique name of the typed link facet.

      • Attributes — required — (Array<map>)

        A set of attributes that are associated with the typed link.

        • AttributeName — required — (String)

          The attribute name of the typed link.

        • Value — required — (map)

          The value for the typed link.

          • StringValue — (String)

            A string data value.

          • BinaryValue — (Buffer, Typed Array, Blob, String)

            A binary data value.

          • BooleanValue — (Boolean)

            A Boolean data value.

          • NumberValue — (String)

            A number data value.

          • DatetimeValue — (Date)

            A date and time value.

    • DetachTypedLink — (map)

      Detaches a typed link from a specified source and target object. For more information, see Typed Links.

      • TypedLinkSpecifier — required — (map)

        Used to accept a typed link specifier as input.

        • TypedLinkFacet — required — (map)

          Identifies the typed link facet that is associated with the typed link.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

          • TypedLinkName — required — (String)

            The unique name of the typed link facet.

        • SourceObjectReference — required — (map)

          Identifies the source object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • TargetObjectReference — required — (map)

          Identifies the target object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • IdentityAttributeValues — required — (Array<map>)

          Identifies the attribute value to update.

          • AttributeName — required — (String)

            The attribute name of the typed link.

          • Value — required — (map)

            The value for the typed link.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

    • UpdateLinkAttributes — (map)

      Updates a given object's attributes.

      • TypedLinkSpecifier — required — (map)

        Allows a typed link specifier to be accepted as input.

        • TypedLinkFacet — required — (map)

          Identifies the typed link facet that is associated with the typed link.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

          • TypedLinkName — required — (String)

            The unique name of the typed link facet.

        • SourceObjectReference — required — (map)

          Identifies the source object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • TargetObjectReference — required — (map)

          Identifies the target object that the typed link will attach to.

          • Selector — (String)

            A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

            • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

            • /some/path - Identifies the object based on path

            • #SomeBatchReference - Identifies the object in a batch call

        • IdentityAttributeValues — required — (Array<map>)

          Identifies the attribute value to update.

          • AttributeName — required — (String)

            The attribute name of the typed link.

          • Value — required — (map)

            The value for the typed link.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

      • AttributeUpdates — required — (Array<map>)

        The attributes update structure.

        • AttributeKey — (map)

          The key of the attribute being updated.

          • SchemaArn — required — (String)

            The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

          • FacetName — required — (String)

            The name of the facet that the attribute exists within.

          • Name — required — (String)

            The name of the attribute.

        • AttributeAction — (map)

          The action to perform as part of the attribute update.

          • AttributeActionType — (String)

            A type that can be either UPDATE_OR_CREATE or DELETE.

            Possible values include:
            • "CREATE_OR_UPDATE"
            • "DELETE"
          • AttributeUpdateValue — (map)

            The value that you want to update to.

            • StringValue — (String)

              A string data value.

            • BinaryValue — (Buffer, Typed Array, Blob, String)

              A binary data value.

            • BooleanValue — (Boolean)

              A Boolean data value.

            • NumberValue — (String)

              A number data value.

            • DatetimeValue — (Date)

              A date and time value.

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:

    • Responses — (Array<map>)

      A list of all the responses for each batch write.

      • CreateObject — (map)

        Creates an object in a Directory.

        • ObjectIdentifier — (String)

          The ID that is associated with the object.

      • AttachObject — (map)

        Attaches an object to a Directory.

        • attachedObjectIdentifier — (String)

          The ObjectIdentifier of the object that has been attached.

      • DetachObject — (map)

        Detaches an object from a Directory.

        • detachedObjectIdentifier — (String)

          The ObjectIdentifier of the detached object.

      • UpdateObjectAttributes — (map)

        Updates a given object’s attributes.

        • ObjectIdentifier — (String)

          ID that is associated with the object.

      • DeleteObject — (map)

        Deletes an object in a Directory.

      • AddFacetToObject — (map)

        The result of an add facet to object batch operation.

      • RemoveFacetFromObject — (map)

        The result of a batch remove facet from object operation.

      • AttachPolicy — (map)

        Attaches a policy object to a regular object. An object can have a limited number of attached policies.

      • DetachPolicy — (map)

        Detaches a policy from a Directory.

      • CreateIndex — (map)

        Creates an index object. See Indexing and search for more information.

        • ObjectIdentifier — (String)

          The ObjectIdentifier of the index created by this operation.

      • AttachToIndex — (map)

        Attaches the specified object to the specified index.

        • AttachedObjectIdentifier — (String)

          The ObjectIdentifier of the object that was attached to the index.

      • DetachFromIndex — (map)

        Detaches the specified object from the specified index.

        • DetachedObjectIdentifier — (String)

          The ObjectIdentifier of the object that was detached from the index.

      • AttachTypedLink — (map)

        Attaches a typed link to a specified source and target object. For more information, see Typed Links.

        • TypedLinkSpecifier — (map)

          Returns a typed link specifier as output.

          • TypedLinkFacet — required — (map)

            Identifies the typed link facet that is associated with the typed link.

            • SchemaArn — required — (String)

              The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

            • TypedLinkName — required — (String)

              The unique name of the typed link facet.

          • SourceObjectReference — required — (map)

            Identifies the source object that the typed link will attach to.

            • Selector — (String)

              A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

              • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

              • /some/path - Identifies the object based on path

              • #SomeBatchReference - Identifies the object in a batch call

          • TargetObjectReference — required — (map)

            Identifies the target object that the typed link will attach to.

            • Selector — (String)

              A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

              • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

              • /some/path - Identifies the object based on path

              • #SomeBatchReference - Identifies the object in a batch call

          • IdentityAttributeValues — required — (Array<map>)

            Identifies the attribute value to update.

            • AttributeName — required — (String)

              The attribute name of the typed link.

            • Value — required — (map)

              The value for the typed link.

              • StringValue — (String)

                A string data value.

              • BinaryValue — (Buffer, Typed Array, Blob, String)

                A binary data value.

              • BooleanValue — (Boolean)

                A Boolean data value.

              • NumberValue — (String)

                A number data value.

              • DatetimeValue — (Date)

                A date and time value.

      • DetachTypedLink — (map)

        Detaches a typed link from a specified source and target object. For more information, see Typed Links.

      • UpdateLinkAttributes — (map)

        Represents the output of a BatchWrite response operation.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.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 name of the Directory. Should be unique per account, per region.

  • SchemaArn — (String)

    The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

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:

    • DirectoryArn — (String)

      The ARN that is associated with the Directory. For more information, see arns.

    • Name — (String)

      The name of the Directory.

    • ObjectIdentifier — (String)

      The root object node of the created directory.

    • AppliedSchemaArn — (String)

      The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE', /* required */
  Attributes: [
    {
      Name: 'STRING_VALUE', /* required */
      AttributeDefinition: {
        Type: STRING | BINARY | BOOLEAN | NUMBER | DATETIME | VARIANT, /* required */
        DefaultValue: {
          BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BooleanValue: true || false,
          DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          NumberValue: 'STRING_VALUE',
          StringValue: 'STRING_VALUE'
        },
        IsImmutable: true || false,
        Rules: {
          '<RuleKey>': {
            Parameters: {
              '<RuleParameterKey>': 'STRING_VALUE',
              /* '<RuleParameterKey>': ... */
            },
            Type: BINARY_LENGTH | NUMBER_COMPARISON | STRING_FROM_SET | STRING_LENGTH
          },
          /* '<RuleKey>': ... */
        }
      },
      AttributeReference: {
        TargetAttributeName: 'STRING_VALUE', /* required */
        TargetFacetName: 'STRING_VALUE' /* required */
      },
      RequiredBehavior: REQUIRED_ALWAYS | NOT_REQUIRED
    },
    /* more items */
  ],
  FacetStyle: STATIC | DYNAMIC,
  ObjectType: NODE | LEAF_NODE | POLICY | INDEX
};
clouddirectory.createFacet(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: {}) —
  • SchemaArn — (String)

    The schema ARN in which the new Facet will be created. For more information, see arns.

  • Name — (String)

    The name of the Facet, which is unique for a given schema.

  • Attributes — (Array<map>)

    The attributes that are associated with the Facet.

    • Name — required — (String)

      The name of the facet attribute.

    • AttributeDefinition — (map)

      A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

      • Type — required — (String)

        The type of the attribute.

        Possible values include:
        • "STRING"
        • "BINARY"
        • "BOOLEAN"
        • "NUMBER"
        • "DATETIME"
        • "VARIANT"
      • DefaultValue — (map)

        The default value of the attribute (if configured).

        • StringValue — (String)

          A string data value.

        • BinaryValue — (Buffer, Typed Array, Blob, String)

          A binary data value.

        • BooleanValue — (Boolean)

          A Boolean data value.

        • NumberValue — (String)

          A number data value.

        • DatetimeValue — (Date)

          A date and time value.

      • IsImmutable — (Boolean)

        Whether the attribute is mutable or not.

      • Rules — (map<map>)

        Validation rules attached to the attribute definition.

        • Type — (String)

          The type of attribute validation rule.

          Possible values include:
          • "BINARY_LENGTH"
          • "NUMBER_COMPARISON"
          • "STRING_FROM_SET"
          • "STRING_LENGTH"
        • Parameters — (map<String>)

          The minimum and maximum parameters that are associated with the rule.

    • AttributeReference — (map)

      An attribute reference that is associated with the attribute. See Attribute References for more information.

      • TargetFacetName — required — (String)

        The target facet name that is associated with the facet reference. See Attribute References for more information.

      • TargetAttributeName — required — (String)

        The target attribute name that is associated with the facet reference. See Attribute References for more information.

    • RequiredBehavior — (String)

      The required behavior of the FacetAttribute.

      Possible values include:
      • "REQUIRED_ALWAYS"
      • "NOT_REQUIRED"
  • ObjectType — (String)

    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

    • Node: Can have multiple children but one parent.

    • Leaf node: Cannot have children but can have multiple parents.

    • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

    • Index: Can be created with the Index API.

    Possible values include:
    • "NODE"
    • "LEAF_NODE"
    • "POLICY"
    • "INDEX"
  • FacetStyle — (String)

    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

    Possible values include:
    • "STATIC"
    • "DYNAMIC"

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 = {
  DirectoryArn: 'STRING_VALUE', /* required */
  IsUnique: true || false, /* required */
  OrderedIndexedAttributeList: [ /* required */
    {
      FacetName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      SchemaArn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  LinkName: 'STRING_VALUE',
  ParentReference: {
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.createIndex(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: {}) —
  • DirectoryArn — (String)

    The ARN of the directory where the index should be created.

  • OrderedIndexedAttributeList — (Array<map>)

    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

    • SchemaArn — required — (String)

      The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

    • FacetName — required — (String)

      The name of the facet that the attribute exists within.

    • Name — required — (String)

      The name of the attribute.

  • IsUnique — (Boolean)

    Indicates whether the attribute that is being indexed has unique values or not.

  • ParentReference — (map)

    A reference to the parent object that contains the index object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • LinkName — (String)

    The name of the link between the parent object and the index 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:

    • ObjectIdentifier — (String)

      The ObjectIdentifier of the index created by this operation.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  SchemaFacets: [ /* required */
    {
      FacetName: 'STRING_VALUE',
      SchemaArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  LinkName: 'STRING_VALUE',
  ObjectAttributeList: [
    {
      Key: { /* required */
        FacetName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        SchemaArn: 'STRING_VALUE' /* required */
      },
      Value: { /* required */
        BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BooleanValue: true || false,
        DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        NumberValue: 'STRING_VALUE',
        StringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  ParentReference: {
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.createObject(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

  • SchemaFacets — (Array<map>)

    A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

    • SchemaArn — (String)

      The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.

    • FacetName — (String)

      The name of the facet. If this value is set, SchemaArn must also be set.

  • ObjectAttributeList — (Array<map>)

    The attribute map whose attribute ARN contains the key and attribute value as the map value.

    • Key — required — (map)

      The key of the attribute.

      • SchemaArn — required — (String)

        The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

      • FacetName — required — (String)

        The name of the facet that the attribute exists within.

      • Name — required — (String)

        The name of the attribute.

    • Value — required — (map)

      The value of the attribute.

      • StringValue — (String)

        A string data value.

      • BinaryValue — (Buffer, Typed Array, Blob, String)

        A binary data value.

      • BooleanValue — (Boolean)

        A Boolean data value.

      • NumberValue — (String)

        A number data value.

      • DatetimeValue — (Date)

        A date and time value.

  • ParentReference — (map)

    If specified, the parent reference to which this object will be attached.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • LinkName — (String)

    The name of link that is used to attach this object to a parent.

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:

    • ObjectIdentifier — (String)

      The identifier that is associated with the object.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
clouddirectory.createSchema(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 name that is associated with the schema. This is unique to each account and in each region.

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:

    • SchemaArn — (String)

      The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Returns:

• (AWS.Request) —

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

var params = {
  Facet: { /* required */
    Attributes: [ /* required */
      {
        Name: 'STRING_VALUE', /* required */
        RequiredBehavior: REQUIRED_ALWAYS | NOT_REQUIRED, /* required */
        Type: STRING | BINARY | BOOLEAN | NUMBER | DATETIME | VARIANT, /* required */
        DefaultValue: {
          BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BooleanValue: true || false,
          DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          NumberValue: 'STRING_VALUE',
          StringValue: 'STRING_VALUE'
        },
        IsImmutable: true || false,
        Rules: {
          '<RuleKey>': {
            Parameters: {
              '<RuleParameterKey>': 'STRING_VALUE',
              /* '<RuleParameterKey>': ... */
            },
            Type: BINARY_LENGTH | NUMBER_COMPARISON | STRING_FROM_SET | STRING_LENGTH
          },
          /* '<RuleKey>': ... */
        }
      },
      /* more items */
    ],
    IdentityAttributeOrder: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Name: 'STRING_VALUE' /* required */
  },
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.createTypedLinkFacet(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: {}) —
  • SchemaArn — (String)

    The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

  • Facet — (map)

    Facet structure that is associated with the typed link facet.

    • Name — required — (String)

      The unique name of the typed link facet.

    • Attributes — required — (Array<map>)

      A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

      • Name — required — (String)

        The unique name of the typed link attribute.

      • Type — required — (String)

        The type of the attribute.

        Possible values include:
        • "STRING"
        • "BINARY"
        • "BOOLEAN"
        • "NUMBER"
        • "DATETIME"
        • "VARIANT"
      • DefaultValue — (map)

        The default value of the attribute (if configured).

        • StringValue — (String)

          A string data value.

        • BinaryValue — (Buffer, Typed Array, Blob, String)

          A binary data value.

        • BooleanValue — (Boolean)

          A Boolean data value.

        • NumberValue — (String)

          A number data value.

        • DatetimeValue — (Date)

          A date and time value.

      • IsImmutable — (Boolean)

        Whether the attribute is mutable or not.

      • Rules — (map<map>)

        Validation rules that are attached to the attribute definition.

        • Type — (String)

          The type of attribute validation rule.

          Possible values include:
          • "BINARY_LENGTH"
          • "NUMBER_COMPARISON"
          • "STRING_FROM_SET"
          • "STRING_LENGTH"
        • Parameters — (map<String>)

          The minimum and maximum parameters that are associated with the rule.

      • RequiredBehavior — required — (String)

        The required behavior of the TypedLinkAttributeDefinition.

        Possible values include:
        • "REQUIRED_ALWAYS"
        • "NOT_REQUIRED"
    • IdentityAttributeOrder — required — (Array<String>)

      The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

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 = {
  DirectoryArn: 'STRING_VALUE' /* required */
};
clouddirectory.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: {}) —
  • DirectoryArn — (String)

    The ARN 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:

    • DirectoryArn — (String)

      The ARN of the deleted directory.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.deleteFacet(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: {}) —
  • SchemaArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

  • Name — (String)

    The name of the facet 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 = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.deleteObject(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

  • ObjectReference — (map)

    A reference that identifies the object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch 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.

Returns:

• (AWS.Request) —

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

var params = {
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.deleteSchema(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: {}) —
  • SchemaArn — (String)

    The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

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:

    • SchemaArn — (String)

      The input ARN that is returned as part of the response. For more information, see arns.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.deleteTypedLinkFacet(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: {}) —
  • SchemaArn — (String)

    The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

  • Name — (String)

    The unique name of the typed link facet.

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 = {
  DirectoryArn: 'STRING_VALUE', /* required */
  IndexReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  TargetReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.detachFromIndex(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) of the directory the index and object exist in.

  • IndexReference — (map)

    A reference to the index object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • TargetReference — (map)

    A reference to the object being detached from the index.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch 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:

    • DetachedObjectIdentifier — (String)

      The ObjectIdentifier of the object that was detached from the index.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  LinkName: 'STRING_VALUE', /* required */
  ParentReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.detachObject(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

  • ParentReference — (map)

    The parent reference from which the object with the specified link name is detached.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • LinkName — (String)

    The link name associated with the object that needs to be detached.

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:

    • DetachedObjectIdentifier — (String)

      The ObjectIdentifier that was detached from the object.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  PolicyReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.detachPolicy(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

  • PolicyReference — (map)

    Reference that identifies the policy object.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • ObjectReference — (map)

    Reference that identifies the object whose policy object will be detached.

    • Selector — (String)

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch 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.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  TypedLinkSpecifier: { /* required */
    IdentityAttributeValues: [ /* required */
      {
        AttributeName: 'STRING_VALUE', /* required */
        Value: { /* required */
          BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BooleanValue: true || false,
          DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          NumberValue: 'STRING_VALUE',
          StringValue: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    SourceObjectReference: { /* required */
      Selector: 'STRING_VALUE'
    },
    TargetObjectReference: { /* required */
      Selector: 'STRING_VALUE'
    },
    TypedLinkFacet: { /* required */
      SchemaArn: 'STRING_VALUE', /* required */
      TypedLinkName: 'STRING_VALUE' /* required */
    }
  }
};
clouddirectory.detachTypedLink(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

  • TypedLinkSpecifier — (map)

    Used to accept a typed link specifier as input.

    • TypedLinkFacet — required — (map)

      Identifies the typed link facet that is associated with the typed link.

      • SchemaArn — required — (String)

        The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

      • TypedLinkName — required — (String)

        The unique name of the typed link facet.

    • SourceObjectReference — required — (map)

      Identifies the source object that the typed link will attach to.

      • Selector — (String)

        A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

        • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

        • /some/path - Identifies the object based on path

        • #SomeBatchReference - Identifies the object in a batch call

    • TargetObjectReference — required — (map)

      Identifies the target object that the typed link will attach to.

      • Selector — (String)

        A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

        • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

        • /some/path - Identifies the object based on path

        • #SomeBatchReference - Identifies the object in a batch call

    • IdentityAttributeValues — required — (Array<map>)

      Identifies the attribute value to update.

      • AttributeName — required — (String)

        The attribute name of the typed link.

      • Value — required — (map)

        The value for the typed link.

        • StringValue — (String)

          A string data value.

        • BinaryValue — (Buffer, Typed Array, Blob, String)

          A binary data value.

        • BooleanValue — (Boolean)

          A Boolean data value.

        • NumberValue — (String)

          A number data value.

        • DatetimeValue — (Date)

          A date and time value.

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 = {
  DirectoryArn: 'STRING_VALUE' /* required */
};
clouddirectory.disableDirectory(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: {}) —
  • DirectoryArn — (String)

    The ARN of the directory to disable.

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:

    • DirectoryArn — (String)

      The ARN of the directory that has been disabled.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE' /* required */
};
clouddirectory.enableDirectory(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: {}) —
  • DirectoryArn — (String)

    The ARN of the directory to enable.

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:

    • DirectoryArn — (String)

      The ARN of the enabled directory.

Returns:

• (AWS.Request) —

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

var params = {
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.getAppliedSchemaVersion(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: {}) —
  • SchemaArn — (String)

    The ARN of the applied schema.

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:

    • AppliedSchemaArn — (String)

      Current applied schema ARN, including the minor version in use if one was provided.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryArn: 'STRING_VALUE' /* required */
};
clouddirectory.getDirectory(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: {}) —
  • DirectoryArn — (String)

    The ARN of the directory.

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:

    • Directory — (map)

      Metadata about the directory.

      • Name — (String)

        The name of the directory.

      • DirectoryArn — (String)

        The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

      • State — (String)

        The state of the directory. Can be either Enabled, Disabled, or Deleted.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
        • "DELETED"
      • CreationDateTime — (Date)

        The date and time when the directory was created.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.getFacet(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: {}) —
  • SchemaArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

  • Name — (String)

    The name of the facet to retrieve.

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:

    • Facet — (map)

      The Facet structure that is associated with the facet.

      • Name — (String)

        The name of the Facet.

      • ObjectType — (String)

        The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

        Possible values include:
        • "NODE"
        • "LEAF_NODE"
        • "POLICY"
        • "INDEX"
      • FacetStyle — (String)

        There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

        Possible values include:
        • "STATIC"
        • "DYNAMIC"

Returns:

• (AWS.Request) —

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

var params = {
  AttributeNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DirectoryArn: 'STRING_VALUE', /* required */
  TypedLinkSpecifier: { /* required */
    IdentityAttributeValues: [ /* required */
      {
        AttributeName: 'STRING_VALUE', /* required */
        Value: { /* required */
          BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BooleanValue: true || false,
          DatetimeValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          NumberValue: 'STRING_VALUE',
          StringValue: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    SourceObjectReference: { /* required */
      Selector: 'STRING_VALUE'
    },
    TargetObjectReference: { /* required */
      Selector: 'STRING_VALUE'
    },
    TypedLinkFacet: { /* required */
      SchemaArn: 'STRING_VALUE', /* required */
      TypedLinkName: 'STRING_VALUE' /* required */
    }
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL
};
clouddirectory.getLinkAttributes(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: {}) —
  • DirectoryArn — (String)

    The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

  • TypedLinkSpecifier — (map)

    Allows a typed link specifier to be accepted as input.

    • TypedLinkFacet — required — (map)

      Identifies the typed link facet that is associated with the typed link.

      • SchemaArn — required — (String)

        The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

      • TypedLinkName — required — (String)

        The unique name of the typed link facet.

    • SourceObjectReference — required — (map)

      Identifies the source object that the typed link will attach to.

      • Selector — (String)

        A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

        • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

        • /some/path - Identifies the object based on path

        • #SomeBatchReference - Identifies the object in a batch call

    • TargetObjectReference — required — (map)

      Identifies the target object that the typed link will attach to.

      • Selector — (String)

        A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

        • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

        • /some/path - Identifies the object based on path

        • #SomeBatchReference - Identifies the object in a batch call

    • IdentityAttributeValues — required — (Array<map>)

      Identifies the attribute value to update.

      • AttributeName — required — (String)

        The attribute name of the typed link.

      • Value — required — (map)

        The value for the typed link.

        • StringValue — (String)

          A string data value.

        • BinaryValue — (Buffer, Typed Array, Blob, String)

          A binary data value.

        • BooleanValue — (Boolean)

          A Boolean data value.

        • NumberValue — (String)

          A number data value.

        • DatetimeValue — (Date)

          A date and time value.

  • AttributeNames — (Array<String>)

    A list of attribute names whose values will be retrieved.

  • ConsistencyLevel — (String)

    The consistency level at which to retrieve the attributes on a typed link.

    Possible values include:
    • "SERIALIZABLE"
    • "EVENTUAL"