Class: AWS.CloudDirectory

Inherits:
AWS.Service show all
Identifier:
clouddirectory
API Version:
2016-05-10
Defined in:
(unknown)

Overview

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

Sending a Request Using CloudDirectory

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

Locking the API Version

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

var clouddirectory = new AWS.CloudDirectory({apiVersion: '2016-05-10'});

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

AWS.config.apiVersions = {
  clouddirectory: '2016-05-10',
  // other service API versions
};

var clouddirectory = new AWS.CloudDirectory();

Version:

  • 2016-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a CloudDirectory object

var clouddirectory = new AWS.CloudDirectory({apiVersion: '2016-05-10'});

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Adds a new Facet to an object.

Service Reference:

Examples:

Calling the addFacetToObject operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  SchemaFacet: { /* required */
    FacetName: 'STRING_VALUE',
    SchemaArn: 'STRING_VALUE'
  },
  ObjectAttributeList: [
    {
      Key: { /* required */
        FacetName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        SchemaArn: 'STRING_VALUE' /* required */
      },
      Value: { /* required */
        BinaryValue: new Buffer('...') || 'STRING_VALUE',
        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 */
  ]
};
clouddirectory.addFacetToObject(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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • SchemaFacet — (map)

      Identifiers for the facet that you are adding to the object.

      • SchemaArn — (String)

        The ARN of the schema that contains the facet.

      • FacetName — (String)

        The name of the facet.

    • ObjectAttributeList — (Array<map>)

      Attributes on the facet you are adding to the object.

      • Keyrequired — (map)

        The key of the attribute.

        • SchemaArnrequired — (String)

          The ARN of the schema that contains the facet and attribute.

        • FacetNamerequired — (String)

          The name of the facet the attribute exists within.

        • Namerequired — (String)

          The name of the attribute.

      • Valuerequired — (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 — (map)

      A reference to the object you are adding the specified facet to.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Copies input published schema into Directory with same name and version as that of published schema .

Service Reference:

Examples:

Calling the applySchema operation

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 ARN that needs to be copied. For more information, see arns.

    • DirectoryArn — (String)

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

        Applied schema ARN 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)

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

Returns:

  • (AWS.Request)

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

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

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

Service Reference:

Examples:

Calling the attachObject operation

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)

      ARN associated with the Directory where both objects reside. For more information, see arns.

    • ParentReference — (map)

      Parent object reference.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • ChildReference — (map)

      Child object reference to be attached to the object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • LinkName — (String)

      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)

        Attached ObjectIdentifier, which is the child ObjectIdentifier.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the attachPolicy operation

var params = {
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  PolicyReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  DirectoryArn: '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)

      ARN associated with the Directory where both objects reside. For more information, see arns.

    • PolicyReference — (map)

      Reference associated with the policy object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • ObjectReference — (map)

      Reference that identifies the object to which the policy will be attached.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Attaches the specified object to the specified index.

Service Reference:

Examples:

Calling the attachToIndex operation

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

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Performs all the read operations in a batch.

Service Reference:

Examples:

Calling the batchRead operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    {
      ListObjectAttributes: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        FacetFilter: {
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        },
        MaxResults: 0,
        NextToken: 'STRING_VALUE'
      },
      ListObjectChildren: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        MaxResults: 0,
        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)

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

    • Operations — (Array<map>)

      List of operations that are part of the batch.

      • ListObjectAttributes — (map)

        Lists all attributes associated with an object.

        • ObjectReferencerequired — (map)

          Reference of the object whose attributes need to be listed.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • FacetFilter — (map)

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

          • SchemaArn — (String)

            The ARN of the schema that contains the facet.

          • FacetName — (String)

            The name of the facet.

      • ListObjectChildren — (map)

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

        • ObjectReferencerequired — (map)

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

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

        List of all the responses for each batch read.

        • SuccessfulResponse — (map)

          Identifies which operation in a batch has succeeded.

          • ListObjectAttributes — (map)

            Lists all attributes associated with an object.

            • Attributes — (Array<map>)

              Attributes map associated with the object. AttributeArn is the key; attribute value is the value.

              • Keyrequired — (map)

                The key of the attribute.

                • SchemaArnrequired — (String)

                  The ARN of the schema that contains the facet and attribute.

                • FacetNamerequired — (String)

                  The name of the facet the attribute exists within.

                • Namerequired — (String)

                  The name of the attribute.

              • Valuerequired — (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 associated with a given object.

            • Children — (map<String>)

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

            • NextToken — (String)

              The pagination token.

        • ExceptionResponse — (map)

          Identifies which operation in a batch has failed.

          • Type — (String)

            Type of exception, such as InvalidArnException.

            Possible values include:
            • "ValidationException"
            • "InvalidArnException"
            • "ResourceNotFoundException"
            • "InvalidNextTokenException"
            • "AccessDeniedException"
            • "NotNodeException"
          • Message — (String)

            Exception message associated with the failure.

Returns:

  • (AWS.Request)

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

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

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

Service Reference:

Examples:

Calling the batchWrite operation

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: new Buffer('...') || 'STRING_VALUE',
              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'
        }
      },
      CreateObject: {
        BatchReferenceName: 'STRING_VALUE', /* required */
        LinkName: 'STRING_VALUE', /* required */
        ObjectAttributeList: [ /* required */
          {
            Key: { /* required */
              FacetName: 'STRING_VALUE', /* required */
              Name: 'STRING_VALUE', /* required */
              SchemaArn: 'STRING_VALUE' /* required */
            },
            Value: { /* required */
              BinaryValue: new Buffer('...') || 'STRING_VALUE',
              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: { /* required */
          Selector: 'STRING_VALUE'
        },
        SchemaFacet: [ /* required */
          {
            FacetName: 'STRING_VALUE',
            SchemaArn: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      DeleteObject: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      DetachObject: {
        BatchReferenceName: 'STRING_VALUE', /* required */
        LinkName: 'STRING_VALUE', /* required */
        ParentReference: { /* required */
          Selector: 'STRING_VALUE'
        }
      },
      RemoveFacetFromObject: {
        ObjectReference: { /* required */
          Selector: 'STRING_VALUE'
        },
        SchemaFacet: { /* required */
          FacetName: 'STRING_VALUE',
          SchemaArn: 'STRING_VALUE'
        }
      },
      UpdateObjectAttributes: {
        AttributeUpdates: [ /* required */
          {
            ObjectAttributeAction: {
              ObjectAttributeActionType: CREATE_OR_UPDATE | DELETE,
              ObjectAttributeUpdateValue: {
                BinaryValue: new Buffer('...') || 'STRING_VALUE',
                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)

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

    • Operations — (Array<map>)

      List of operations that are part of the batch.

      • CreateObject — (map)

        Creates an object.

        • SchemaFacetrequired — (Array<map>)

          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.

          • FacetName — (String)

            The name of the facet.

        • ObjectAttributeListrequired — (Array<map>)

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

          • Keyrequired — (map)

            The key of the attribute.

            • SchemaArnrequired — (String)

              The ARN of the schema that contains the facet and attribute.

            • FacetNamerequired — (String)

              The name of the facet the attribute exists within.

            • Namerequired — (String)

              The name of the attribute.

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

        • ParentReferencerequired — (map)

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

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

        • LinkNamerequired — (String)

          The name of the link.

        • BatchReferenceNamerequired — (String)

          The batch reference name. See Batches for more information.

      • AttachObject — (map)

        Attaches an object to a Directory.

        • ParentReferencerequired — (map)

          Parent object reference.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

        • ChildReferencerequired — (map)

          Child object reference to be attached to the object.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

        • LinkNamerequired — (String)

          The name of the link.

      • DetachObject — (map)

        Detaches an object from a Directory.

        • ParentReferencerequired — (map)

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

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

        • LinkNamerequired — (String)

          The name of the link.

        • BatchReferenceNamerequired — (String)

          The batch reference name. See Batches for more information.

      • UpdateObjectAttributes — (map)

        Update a given object's attributes.

        • ObjectReferencerequired — (map)

          Reference that identifies the object.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

        • AttributeUpdatesrequired — (Array<map>)

          Attributes update structure.

          • ObjectAttributeKey — (map)

            The key of the attribute being updated.

            • SchemaArnrequired — (String)

              The ARN of the schema that contains the facet and attribute.

            • FacetNamerequired — (String)

              The name of the facet the attribute exists within.

            • Namerequired — (String)

              The name of the attribute.

          • ObjectAttributeAction — (map)

            The action to perform as part of the attribute update.

            • ObjectAttributeActionType — (String)

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

        • ObjectReferencerequired — (map)

          Reference that identifies the object.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

      • AddFacetToObject — (map)

        Batch operation adding a facet to an object.

        • SchemaFacetrequired — (map)

          Represents the facet being added to the object.

          • SchemaArn — (String)

            The ARN of the schema that contains the facet.

          • FacetName — (String)

            The name of the facet.

        • ObjectAttributeListrequired — (Array<map>)

          The attributes to set on the object.

          • Keyrequired — (map)

            The key of the attribute.

            • SchemaArnrequired — (String)

              The ARN of the schema that contains the facet and attribute.

            • FacetNamerequired — (String)

              The name of the facet the attribute exists within.

            • Namerequired — (String)

              The name of the attribute.

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

        • ObjectReferencerequired — (map)

          A reference to the object being mutated.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

            • #SomeBatchReference - Identifies the object in a batch call

      • RemoveFacetFromObject — (map)

        Batch operation removing a facet from an object.

        • SchemaFacetrequired — (map)

          The facet to remove from the object.

          • SchemaArn — (String)

            The ARN of the schema that contains the facet.

          • FacetName — (String)

            The name of the facet.

        • ObjectReferencerequired — (map)

          A reference to the object whose facet will be removed.

          • Selector — (String)

            Allows you to specify an object. You can identify an object in one of the following ways:

            • $ObjectIdentifier - Identifies the object by ObjectIdentifier

            • /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:

      • Responses — (Array<map>)

        List of all the responses for each batch write.

        • CreateObject — (map)

          Creates an object in a Directory.

          • ObjectIdentifier — (String)

            ID 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 associated with the object.

        • DeleteObject — (map)

          Deletes an object in a Directory.

        • AddFacetToObject — (map)

          Result of an add facet to object batch operation.

        • RemoveFacetFromObject — (map)

          Result of a batch remove facet from object operation.

Returns:

  • (AWS.Request)

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

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

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

Service Reference:

Examples:

Calling the createDirectory operation

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)

      Name of the Directory. Should be unique per account, per region.

    • SchemaArn — (String)

      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)

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

      • Name — (String)

        Name of the Directory.

      • ObjectIdentifier — (String)

        The root object node of the created directory.

      • AppliedSchemaArn — (String)

        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.

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

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Service Reference:

Examples:

Calling the createFacet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ObjectType: NODE | LEAF_NODE | POLICY | INDEX, /* required */
  SchemaArn: 'STRING_VALUE', /* required */
  Attributes: [
    {
      Name: 'STRING_VALUE', /* required */
      AttributeDefinition: {
        Type: STRING | BINARY | BOOLEAN | NUMBER | DATETIME, /* required */
        DefaultValue: {
          BinaryValue: new Buffer('...') || 'STRING_VALUE',
          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 */
  ]
};
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)

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

    • Name — (String)

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

    • Attributes — (Array<map>)

      Attributes associated with the Facet.e

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

        • Typerequired — (String)

          The type of the attribute.

          Possible values include:
          • "STRING"
          • "BINARY"
          • "BOOLEAN"
          • "NUMBER"
          • "DATETIME"
        • 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>)

            Min and max parameters associated with the rule.

      • AttributeReference — (map)

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

        • TargetFacetNamerequired — (String)

          Target facet name associated with the facet reference. See Attribute References for more information.

        • TargetAttributeNamerequired — (String)

          Target attribute name 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"

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.

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

Creates an index object. See Indexing for more information.

Service Reference:

Examples:

Calling the createIndex operation

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.

      • SchemaArnrequired — (String)

        The ARN of the schema that contains the facet and attribute.

      • FacetNamerequired — (String)

        The name of the facet the attribute exists within.

      • Namerequired — (String)

        The name of the attribute.

    • IsUnique — (Boolean)

      Indicates whether objects with the same indexed attribute value can be added to the index.

    • ParentReference — (map)

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

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

Service Reference:

Examples:

Calling the createObject operation

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: new Buffer('...') || 'STRING_VALUE',
        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)

      ARN associated with the Directory in which the object will be created. For more information, see arns.

    • SchemaFacets — (Array<map>)

      List of facet ARNs to be associated with the object. For more information, see arns.

      • SchemaArn — (String)

        The ARN of the schema that contains the facet.

      • FacetName — (String)

        The name of the facet.

    • ObjectAttributeList — (Array<map>)

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

      • Keyrequired — (map)

        The key of the attribute.

        • SchemaArnrequired — (String)

          The ARN of the schema that contains the facet and attribute.

        • FacetNamerequired — (String)

          The name of the facet the attribute exists within.

        • Namerequired — (String)

          The name of the attribute.

      • Valuerequired — (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)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        Identifier associated with the object.

Returns:

  • (AWS.Request)

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

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

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

Service Reference:

Examples:

Calling the createSchema operation

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)

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

        ARN associated with the schema. For more information, see arns.

Returns:

  • (AWS.Request)

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

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

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

Service Reference:

Examples:

Calling the deleteDirectory operation

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.

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

Deletes a given Facet. All attributes and Rules associated with the facet will be deleted. Only development schema facets are allowed deletion.

Service Reference:

Examples:

Calling the deleteFacet operation

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)

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

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

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

Service Reference:

Examples:

Calling the deleteObject operation

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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Deletes a given schema. Schemas in a development and published state can only be deleted.

Service Reference:

Examples:

Calling the deleteSchema operation

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)

      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)

        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.

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

Detaches the specified object from the specified index.

Service Reference:

Examples:

Calling the detachFromIndex operation

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 ARN of the directory the index and object exist in.

    • IndexReference — (map)

      A reference to the index object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

Service Reference:

Examples:

Calling the detachObject operation

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)

      ARN associated with the Directory where objects reside. For more information, see arns.

    • ParentReference — (map)

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

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • LinkName — (String)

      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.

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

Detaches a policy from an object.

Service Reference:

Examples:

Calling the detachPolicy operation

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)

      ARN associated with the Directory where both objects reside. For more information, see arns.

    • PolicyReference — (map)

      Reference that identifies the policy object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

Service Reference:

Examples:

Calling the disableDirectory operation

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.

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

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Service Reference:

Examples:

Calling the enableDirectory operation

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.

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

Retrieves metadata about a directory.

Service Reference:

Examples:

Calling the getDirectory operation

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)

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

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

Gets details of the Facet, such as Facet Name, Attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

Service Reference:

Examples:

Calling the getFacet operation

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)

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

        Facet structure associated with the facet.

        • Name — (String)

          The name of the Facet.

        • ObjectType — (String)

          Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.

          Possible values include:
          • "NODE"
          • "LEAF_NODE"
          • "POLICY"
          • "INDEX"

Returns:

  • (AWS.Request)

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

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

Retrieves metadata about an object.

Service Reference:

Examples:

Calling the getObjectInformation operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL
};
clouddirectory.getObjectInformation(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 being retrieved.

    • ObjectReference — (map)

      A reference to the object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • ConsistencyLevel — (String)

      The consistency level at which to retrieve the object information.

      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:

      • SchemaFacets — (Array<map>)

        The facets attached to the specified object.

        • SchemaArn — (String)

          The ARN of the schema that contains the facet.

        • FacetName — (String)

          The name of the facet.

      • ObjectIdentifier — (String)

        The ObjectIdentifier of the specified object.

Returns:

  • (AWS.Request)

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

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

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

Service Reference:

Examples:

Calling the getSchemaAsJson operation

var params = {
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.getSchemaAsJson(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 schema 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:

      • Name — (String)

        The name of the retrieved schema.

      • Document — (String)

        The JSON representation of the schema document.

Returns:

  • (AWS.Request)

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

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

Lists schemas applied to a directory.

Service Reference:

Examples:

Calling the listAppliedSchemaArns operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listAppliedSchemaArns(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 you are listing.

    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

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

      • SchemaArns — (Array<String>)

        The ARNs of schemas that are applied to the directory.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Lists indices attached to an object.

Service Reference:

Examples:

Calling the listAttachedIndices operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  TargetReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listAttachedIndices(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.

    • TargetReference — (map)

      A reference to the object to that has indices attached.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

    • ConsistencyLevel — (String)

      The consistency level to use for this operation.

      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:

      • IndexAttachments — (Array<map>)

        The indices attached to the specified object.

        • IndexedAttributes — (Array<map>)

          The indexed attribute values.

          • Keyrequired — (map)

            The key of the attribute.

            • SchemaArnrequired — (String)

              The ARN of the schema that contains the facet and attribute.

            • FacetNamerequired — (String)

              The name of the facet the attribute exists within.

            • Namerequired — (String)

              The name of the attribute.

          • Valuerequired — (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)

          The ObjectIdentifier of the object attached to the index.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Retrieves the ARNs of schemas in the development state.

Service Reference:

Examples:

Calling the listDevelopmentSchemaArns operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listDevelopmentSchemaArns(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: {})
    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

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

      • SchemaArns — (Array<String>)

        The ARNs of retrieved development schemas.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Lists directories created within an account.

Service Reference:

Examples:

Calling the listDirectories operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  state: ENABLED | DISABLED | DELETED
};
clouddirectory.listDirectories(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: {})
    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

      The maximum number of results to retrieve.

    • state — (String)

      The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DELETED"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Directories — (Array<map>)

        Lists all directories associated with your account in pagination fashion.

        • Name — (String)

          The name of the directory.

        • DirectoryArn — (String)

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

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Retrieves attributes attached to the facet.

Service Reference:

Examples:

Calling the listFacetAttributes operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listFacetAttributes(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 schema where the facet resides.

    • Name — (String)

      The name of the facet whose attributes will be retrieved.

    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

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

      • Attributes — (Array<map>)

        The attributes attached to the facet.

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

          • Typerequired — (String)

            The type of the attribute.

            Possible values include:
            • "STRING"
            • "BINARY"
            • "BOOLEAN"
            • "NUMBER"
            • "DATETIME"
          • 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>)

              Min and max parameters associated with the rule.

        • AttributeReference — (map)

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

          • TargetFacetNamerequired — (String)

            Target facet name associated with the facet reference. See Attribute References for more information.

          • TargetAttributeNamerequired — (String)

            Target attribute name 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"
      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Retrieves the names of facets that exist in a schema.

Service Reference:

Examples:

Calling the listFacetNames operation

var params = {
  SchemaArn: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listFacetNames(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 to retrieve facet names from.

    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

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

      • FacetNames — (Array<String>)

        The names of facets that exist within the schema.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Lists objects attached to the specified index.

Service Reference:

Examples:

Calling the listIndex operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  IndexReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  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: new Buffer('...') || 'STRING_VALUE',
          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: new Buffer('...') || 'STRING_VALUE',
          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 */
  ]
};
clouddirectory.listIndex(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 that the index exists in.

    • RangesOnIndexedValues — (Array<map>)

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

      • AttributeKey — (map)

        The key of the attribute the attribute range covers.

        • SchemaArnrequired — (String)

          The ARN of the schema that contains the facet and attribute.

        • FacetNamerequired — (String)

          The name of the facet the attribute exists within.

        • Namerequired — (String)

          The name of the attribute.

      • Range — (map)

        The range of attribute values being selected.

        • StartModerequired — (String)

          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.

        • EndModerequired — (String)

          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 — (map)

      The reference to the index to list.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

        • /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 from the index.

    • NextToken — (String)

      The pagination token.

    • ConsistencyLevel — (String)

      The consistency level to execute the request at.

      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:

      • IndexAttachments — (Array<map>)

        The objects and indexed values attached to the index.

        • IndexedAttributes — (Array<map>)

          The indexed attribute values.

          • Keyrequired — (map)

            The key of the attribute.

            • SchemaArnrequired — (String)

              The ARN of the schema that contains the facet and attribute.

            • FacetNamerequired — (String)

              The name of the facet the attribute exists within.

            • Namerequired — (String)

              The name of the attribute.

          • Valuerequired — (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)

          The ObjectIdentifier of the object attached to the index.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Lists all attributes associated with an object.

Service Reference:

Examples:

Calling the listObjectAttributes operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  FacetFilter: {
    FacetName: 'STRING_VALUE',
    SchemaArn: 'STRING_VALUE'
  },
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listObjectAttributes(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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object whose attributes will be listed.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

    • 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"
    • FacetFilter — (map)

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

      • SchemaArn — (String)

        The ARN of the schema that contains the facet.

      • FacetName — (String)

        The name of the 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. The data object has the following properties:

      • Attributes — (Array<map>)

        Attributes map associated with the object. AttributeArn is the key, and attribute value is the value.

        • Keyrequired — (map)

          The key of the attribute.

          • SchemaArnrequired — (String)

            The ARN of the schema that contains the facet and attribute.

          • FacetNamerequired — (String)

            The name of the facet the attribute exists within.

          • Namerequired — (String)

            The name of the attribute.

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

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listObjectChildren operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listObjectChildren(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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object for which child objects are being listed.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

      • Children — (map<String>)

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

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

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.

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to directory root are ignored from the target object.

Service Reference:

Examples:

Calling the listObjectParentPaths operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listObjectParentPaths(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 which the parent path applies.

    • ObjectReference — (map)

      Reference that identifies the object whose parent paths are listed.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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:

      • PathToObjectIdentifiersList — (Array<map>)

        Returns the path to the ObjectIdentifiers associated with the directory.

        • Path — (String)

          The path 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.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listObjectParents operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listObjectParents(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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object for which parent objects are being listed.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

      • Parents — (map<String>)

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

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Returns policies attached to an object in pagination fashion.

Service Reference:

Examples:

Calling the listObjectPolicies operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listObjectPolicies(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)

      ARN associated with the Directory where objects reside. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object for which policies will be listed.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

      • AttachedPolicyIds — (Array<String>)

        List of policy ObjectIdentifiers, that are attached to the object.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listPolicyAttachments operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  PolicyReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  ConsistencyLevel: SERIALIZABLE | EVENTUAL,
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listPolicyAttachments(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)

      ARN associated with the Directory where objects reside. For more information, see arns.

    • PolicyReference — (map)

      Reference that identifies the policy object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

      • ObjectIdentifiers — (Array<String>)

        List of ObjectIdentifiers to which the policy is attached.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Retrieves published schema ARNs.

Service Reference:

Examples:

Calling the listPublishedSchemaArns operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.listPublishedSchemaArns(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: {})
    • NextToken — (String)

      The pagination token.

    • MaxResults — (Integer)

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

      • SchemaArns — (Array<String>)

        The ARNs of published schemas.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      ARN of the resource. Tagging is only supported for directories.

    • NextToken — (String)

      The pagination token. This is for future use. Currently pagination is not supported for tagging.

    • MaxResults — (Integer)

      The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Tags — (Array<map>)

        List of tag key value pairs associated with the response.

        • Key — (String)

          Key associated with the tag.

        • Value — (String)

          Value associated with the tag.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

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.

Service Reference:

Examples:

Calling the lookupPolicy operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
clouddirectory.lookupPolicy(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)

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

    • ObjectReference — (map)

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

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • NextToken — (String)

      The token to request the next page of results.

    • MaxResults — (Integer)

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

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:

      • PolicyToPathList — (Array<map>)

        Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType.

        • 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 associated with PolicyAttachment.

          • PolicyType — (String)

            The type of policy that can be associated with PolicyAttachment.

      • NextToken — (String)

        The pagination token.

Returns:

  • (AWS.Request)

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

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

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

Service Reference:

Examples:

Calling the publishSchema operation

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

      ARN associated with the development schema. For more information, see arns.

    • Version — (String)

      Version under which the schema will be published.

    • Name — (String)

      New name under which the schema will be published. If this is not provided, the development schema is considered.

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:

      • PublishedSchemaArn — (String)

        ARN associated with the published schema. For more information, see arns.

Returns:

  • (AWS.Request)

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

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

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

Service Reference:

Examples:

Calling the putSchemaFromJson operation

var params = {
  Document: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE' /* required */
};
clouddirectory.putSchemaFromJson(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 schema to update.

    • Document — (String)

      The replacement JSON 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:

      • Arn — (String)

        The ARN of the schema to update.

Returns:

  • (AWS.Request)

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

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

Removes the specified facet from the specified object.

Service Reference:

Examples:

Calling the removeFacetFromObject operation

var params = {
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  },
  SchemaFacet: { /* required */
    FacetName: 'STRING_VALUE',
    SchemaArn: 'STRING_VALUE'
  }
};
clouddirectory.removeFacetFromObject(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 in which the object resides.

    • SchemaFacet — (map)

      The facet to remove.

      • SchemaArn — (String)

        The ARN of the schema that contains the facet.

      • FacetName — (String)

        The name of the facet.

    • ObjectReference — (map)

      A reference to the object to remove the facet from.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

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

API for adding tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
clouddirectory.tagResource(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: {})
    • ResourceArn — (String)

      ARN of the resource. Tagging is only supported for directories.

    • Tags — (Array<map>)

      List of tag key value pairs.

      • Key — (String)

        Key associated with the tag.

      • Value — (String)

        Value associated with the tag.

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.

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

API for removing tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
clouddirectory.untagResource(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: {})
    • ResourceArn — (String)

      ARN of the resource. Tagging is only supported for directories.

    • TagKeys — (Array<String>)

      Keys of the tag that needs to be removed from the resource.

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.

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

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

Service Reference:

Examples:

Calling the updateFacet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SchemaArn: 'STRING_VALUE', /* required */
  AttributeUpdates: [
    {
      Action: CREATE_OR_UPDATE | DELETE,
      Attribute: {
        Name: 'STRING_VALUE', /* required */
        AttributeDefinition: {
          Type: STRING | BINARY | BOOLEAN | NUMBER | DATETIME, /* required */
          DefaultValue: {
            BinaryValue: new Buffer('...') || 'STRING_VALUE',
            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 */
  ],
  ObjectType: NODE | LEAF_NODE | POLICY | INDEX
};
clouddirectory.updateFacet(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)

      ARN associated with the Facet. For more information, see arns.

    • Name — (String)

    • AttributeUpdates — (Array<map>)

      List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

      • Attribute — (map)

        The attribute to update.

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

          • Typerequired — (String)

            The type of the attribute.

            Possible values include:
            • "STRING"
            • "BINARY"
            • "BOOLEAN"
            • "NUMBER"
            • "DATETIME"
          • 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>)

              Min and max parameters associated with the rule.

        • AttributeReference — (map)

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

          • TargetFacetNamerequired — (String)

            Target facet name associated with the facet reference. See Attribute References for more information.

          • TargetAttributeNamerequired — (String)

            Target attribute name 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"
      • Action — (String)

        The action to perform when updating the attribute.

        Possible values include:
        • "CREATE_OR_UPDATE"
        • "DELETE"
    • ObjectType — (String)

      Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.

      Possible values include:
      • "NODE"
      • "LEAF_NODE"
      • "POLICY"
      • "INDEX"

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.

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

Updates a given object's attributes.

Service Reference:

Examples:

Calling the updateObjectAttributes operation

var params = {
  AttributeUpdates: [ /* required */
    {
      ObjectAttributeAction: {
        ObjectAttributeActionType: CREATE_OR_UPDATE | DELETE,
        ObjectAttributeUpdateValue: {
          BinaryValue: new Buffer('...') || 'STRING_VALUE',
          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 */
  ],
  DirectoryArn: 'STRING_VALUE', /* required */
  ObjectReference: { /* required */
    Selector: 'STRING_VALUE'
  }
};
clouddirectory.updateObjectAttributes(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)

      ARN associated with the Directory where the object resides. For more information, see arns.

    • ObjectReference — (map)

      Reference that identifies the object.

      • Selector — (String)

        Allows you to specify an object. You can identify an object in one of the following ways:

        • $ObjectIdentifier - Identifies the object by ObjectIdentifier

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

        • #SomeBatchReference - Identifies the object in a batch call

    • AttributeUpdates — (Array<map>)

      Attributes update structure.

      • ObjectAttributeKey — (map)

        The key of the attribute being updated.

        • SchemaArnrequired — (String)

          The ARN of the schema that contains the facet and attribute.

        • FacetNamerequired — (String)

          The name of the facet the attribute exists within.

        • Namerequired — (String)

          The name of the attribute.

      • ObjectAttributeAction — (map)

        The action to perform as part of the attribute update.

        • ObjectAttributeActionType — (String)

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

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)

        ObjectIdentifier of the updated object.

Returns:

  • (AWS.Request)

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

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

Updates the schema name with a new name. Only development schema names can be updated.

Service Reference:

Examples:

Calling the updateSchema operation

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

      ARN of the development schema. For more information, see arns.

    • Name — (String)

      Name of the 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:

      • SchemaArn — (String)

        ARN associated with the updated schema. For more information, see arns.

Returns:

  • (AWS.Request)

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