Class: AWS.WorkDocs

var params = {
  UserId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.activateUser(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: {}) —
  • UserId — (String)

    The ID of the user.

  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

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:

    • User — (map)

      The user information.

      • Id — (String)

        The ID of the user.

      • Username — (String)

        The login name of the user.

      • EmailAddress — (String)

        The email address of the user.

      • GivenName — (String)

        The given name of the user.

      • Surname — (String)

        The surname of the user.

      • OrganizationId — (String)

        The ID of the organization.

      • RootFolderId — (String)

        The ID of the root folder.

      • RecycleBinFolderId — (String)

        The ID of the recycle bin folder.

      • Status — (String)

        The status of the user.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING"
      • Type — (String)

        The type of user.

        Possible values include:
        • "USER"
        • "ADMIN"
        • "POWERUSER"
        • "MINIMALUSER"
        • "WORKSPACESUSER"
      • CreatedTimestamp — (Date)

        The time when the user was created.

      • ModifiedTimestamp — (Date)

        The time when the user was modified.

      • TimeZoneId — (String)

        The time zone ID of the user.

      • Locale — (String)

        The locale of the user.

        Possible values include:
        • "en"
        • "fr"
        • "ko"
        • "de"
        • "es"
        • "ja"
        • "ru"
        • "zh_CN"
        • "zh_TW"
        • "pt_BR"
        • "default"
      • Storage — (map)

        The storage for the user.

        • StorageUtilizedInBytes — (Integer)

          The amount of storage used, in bytes.

        • StorageRule — (map)

          The storage for a user.

          • StorageAllocatedInBytes — (Integer)

            The amount of storage allocated, in bytes.

          • StorageType — (String)

            The type of storage.

            Possible values include:
            • "UNLIMITED"
            • "QUOTA"

Returns:

• (AWS.Request) —

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

var params = {
  Principals: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Role: VIEWER | CONTRIBUTOR | OWNER | COOWNER, /* required */
      Type: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION /* required */
    },
    /* more items */
  ],
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  NotificationOptions: {
    EmailMessage: 'STRING_VALUE',
    SendEmail: true || false
  }
};
workdocs.addResourcePermissions(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of the resource.

  • Principals — (Array<map>)

    The users, groups, or organization being granted permission.

    • Id — required — (String)

      The ID of the recipient.

    • Type — required — (String)

      The type of the recipient.

      Possible values include:
      • "USER"
      • "GROUP"
      • "INVITE"
      • "ANONYMOUS"
      • "ORGANIZATION"
    • Role — required — (String)

      The role of the recipient.

      Possible values include:
      • "VIEWER"
      • "CONTRIBUTOR"
      • "OWNER"
      • "COOWNER"
  • NotificationOptions — (map)

    The notification options.

    • SendEmail — (Boolean)

      Boolean value to indicate an email notification should be sent to the recipients.

    • EmailMessage — (String)

      Text value to be included in the email body.

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:

    • ShareResults — (Array<map>)

      The share results.

      • PrincipalId — (String)

        The ID of the principal.

      • InviteePrincipalId — (String)

        The ID of the invited user.

      • Role — (String)

        The role.

        Possible values include:
        • "VIEWER"
        • "CONTRIBUTOR"
        • "OWNER"
        • "COOWNER"
      • Status — (String)

        The status.

        Possible values include:
        • "SUCCESS"
        • "FAILURE"
      • ShareId — (String)

        The ID of the resource that was shared.

      • StatusMessage — (String)

        The status message.

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  Text: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  NotifyCollaborators: true || false,
  ParentId: 'STRING_VALUE',
  ThreadId: 'STRING_VALUE',
  Visibility: PUBLIC | PRIVATE
};
workdocs.createComment(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • VersionId — (String)

    The ID of the document version.

  • ParentId — (String)

    The ID of the parent comment.

  • ThreadId — (String)

    The ID of the root comment in the thread.

  • Text — (String)

    The text of the comment.

  • Visibility — (String)

    The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

    Possible values include:
    • "PUBLIC"
    • "PRIVATE"
  • NotifyCollaborators — (Boolean)

    Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

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:

    • Comment — (map)

      The comment that has been created.

      • CommentId — required — (String)

        The ID of the comment.

      • ParentId — (String)

        The ID of the parent comment.

      • ThreadId — (String)

        The ID of the root comment in the thread.

      • Text — (String)

        The text of the comment.

      • Contributor — (map)

        The details of the user who made the comment.

        • Id — (String)

          The ID of the user.

        • Username — (String)

          The login name of the user.

        • EmailAddress — (String)

          The email address of the user.

        • GivenName — (String)

          The given name of the user.

        • Surname — (String)

          The surname of the user.

        • OrganizationId — (String)

          The ID of the organization.

        • RootFolderId — (String)

          The ID of the root folder.

        • RecycleBinFolderId — (String)

          The ID of the recycle bin folder.

        • Status — (String)

          The status of the user.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
          • "PENDING"
        • Type — (String)

          The type of user.

          Possible values include:
          • "USER"
          • "ADMIN"
          • "POWERUSER"
          • "MINIMALUSER"
          • "WORKSPACESUSER"
        • CreatedTimestamp — (Date)

          The time when the user was created.

        • ModifiedTimestamp — (Date)

          The time when the user was modified.

        • TimeZoneId — (String)

          The time zone ID of the user.

        • Locale — (String)

          The locale of the user.

          Possible values include:
          • "en"
          • "fr"
          • "ko"
          • "de"
          • "es"
          • "ja"
          • "ru"
          • "zh_CN"
          • "zh_TW"
          • "pt_BR"
          • "default"
        • Storage — (map)

          The storage for the user.

          • StorageUtilizedInBytes — (Integer)

            The amount of storage used, in bytes.

          • StorageRule — (map)

            The storage for a user.

            • StorageAllocatedInBytes — (Integer)

              The amount of storage allocated, in bytes.

            • StorageType — (String)

              The type of storage.

              Possible values include:
              • "UNLIMITED"
              • "QUOTA"
      • CreatedTimestamp — (Date)

        The time that the comment was created.

      • Status — (String)

        The status of the comment.

        Possible values include:
        • "DRAFT"
        • "PUBLISHED"
        • "DELETED"
      • Visibility — (String)

        The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • RecipientId — (String)

        If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

Returns:

• (AWS.Request) —

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

var params = {
  CustomMetadata: { /* required */
    '<CustomMetadataKeyType>': 'STRING_VALUE',
    /* '<CustomMetadataKeyType>': ... */
  },
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
workdocs.createCustomMetadata(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of the resource.

  • VersionId — (String)

    The ID of the version, if the custom metadata is being added to a document version.

  • CustomMetadata — (map<String>)

    Custom metadata in the form of name-value pairs.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • Name — (String)

    The name of the new folder.

  • ParentFolderId — (String)

    The ID of the parent folder.

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:

    • Metadata — (map)

      The metadata of the folder.

      • Id — (String)

        The ID of the folder.

      • Name — (String)

        The name of the folder.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the folder was created.

      • ModifiedTimestamp — (Date)

        The time when the folder was updated.

      • ResourceState — (String)

        The resource state of the folder.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Signature — (String)

        The unique identifier created from the subfolders and documents of the folder.

      • Labels — (Array<String>)

        List of labels on the folder.

      • Size — (Integer)

        The size of the folder metadata.

      • LatestVersionSize — (Integer)

        The size of the latest version of the folder metadata.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ID of the resource.

  • Labels — (Array<String>)

    List of labels to add to the resource.

  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  Endpoint: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  Protocol: HTTPS | SQS, /* required */
  SubscriptionType: ALL /* required */
};
workdocs.createNotificationSubscription(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: {}) —
  • OrganizationId — (String)

    The ID of the organization.

  • Endpoint — (String)

    The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

  • Protocol — (String)

    The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

    Possible values include:
    • "HTTPS"
    • "SQS"
  • SubscriptionType — (String)

    The notification type.

    Possible values include:
    • "ALL"

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:

    • Subscription — (map)

      The subscription.

      • SubscriptionId — (String)

        The ID of the subscription.

      • EndPoint — (String)

        The endpoint of the subscription.

      • Protocol — (String)

        The protocol of the subscription.

        Possible values include:
        • "HTTPS"
        • "SQS"

Returns:

• (AWS.Request) —

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

var params = {
  GivenName: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Surname: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  EmailAddress: 'STRING_VALUE',
  OrganizationId: 'STRING_VALUE',
  StorageRule: {
    StorageAllocatedInBytes: 'NUMBER_VALUE',
    StorageType: UNLIMITED | QUOTA
  },
  TimeZoneId: 'STRING_VALUE'
};
workdocs.createUser(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: {}) —
  • OrganizationId — (String)

    The ID of the organization.

  • Username — (String)

    The login name of the user.

  • EmailAddress — (String)

    The email address of the user.

  • GivenName — (String)

    The given name of the user.

  • Surname — (String)

    The surname of the user.

  • Password — (String)

    The password of the user.

  • TimeZoneId — (String)

    The time zone ID of the user.

  • StorageRule — (map)

    The amount of storage for the user.

    • StorageAllocatedInBytes — (Integer)

      The amount of storage allocated, in bytes.

    • StorageType — (String)

      The type of storage.

      Possible values include:
      • "UNLIMITED"
      • "QUOTA"
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

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:

    • User — (map)

      The user information.

      • Id — (String)

        The ID of the user.

      • Username — (String)

        The login name of the user.

      • EmailAddress — (String)

        The email address of the user.

      • GivenName — (String)

        The given name of the user.

      • Surname — (String)

        The surname of the user.

      • OrganizationId — (String)

        The ID of the organization.

      • RootFolderId — (String)

        The ID of the root folder.

      • RecycleBinFolderId — (String)

        The ID of the recycle bin folder.

      • Status — (String)

        The status of the user.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING"
      • Type — (String)

        The type of user.

        Possible values include:
        • "USER"
        • "ADMIN"
        • "POWERUSER"
        • "MINIMALUSER"
        • "WORKSPACESUSER"
      • CreatedTimestamp — (Date)

        The time when the user was created.

      • ModifiedTimestamp — (Date)

        The time when the user was modified.

      • TimeZoneId — (String)

        The time zone ID of the user.

      • Locale — (String)

        The locale of the user.

        Possible values include:
        • "en"
        • "fr"
        • "ko"
        • "de"
        • "es"
        • "ja"
        • "ru"
        • "zh_CN"
        • "zh_TW"
        • "pt_BR"
        • "default"
      • Storage — (map)

        The storage for the user.

        • StorageUtilizedInBytes — (Integer)

          The amount of storage used, in bytes.

        • StorageRule — (map)

          The storage for a user.

          • StorageAllocatedInBytes — (Integer)

            The amount of storage allocated, in bytes.

          • StorageType — (String)

            The type of storage.

            Possible values include:
            • "UNLIMITED"
            • "QUOTA"

Returns:

• (AWS.Request) —

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

var params = {
  UserId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deactivateUser(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: {}) —
  • UserId — (String)

    The ID of the user.

  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  CommentId: 'STRING_VALUE', /* required */
  DocumentId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteComment(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • VersionId — (String)

    The ID of the document version.

  • CommentId — (String)

    The ID of the comment.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  DeleteAll: true || false,
  Keys: [
    'STRING_VALUE',
    /* more items */
  ],
  VersionId: 'STRING_VALUE'
};
workdocs.deleteCustomMetadata(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of the resource, either a document or folder.

  • VersionId — (String)

    The ID of the version, if the custom metadata is being deleted from a document version.

  • Keys — (Array<String>)

    List of properties to remove.

  • DeleteAll — (Boolean)

    Flag to indicate removal of all custom metadata properties from the specified 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.

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteDocument(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  DeletePriorVersions: true || false, /* required */
  DocumentId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteDocumentVersion(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document associated with the version being deleted.

  • VersionId — (String)

    The ID of the version being deleted.

  • DeletePriorVersions — (Boolean)

    Deletes all versions of a document prior to the current version.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  FolderId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteFolder(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId — (String)

    The ID of the folder.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  FolderId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteFolderContents(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId — (String)

    The ID of the folder.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  DeleteAll: true || false,
  Labels: [
    'STRING_VALUE',
    /* more items */
  ]
};
workdocs.deleteLabels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The ID of the resource.

  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • Labels — (Array<String>)

    List of labels to delete from the resource.

  • DeleteAll — (Boolean)

    Flag to request removal of all labels from the specified 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.

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  SubscriptionId: 'STRING_VALUE' /* required */
};
workdocs.deleteNotificationSubscription(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: {}) —
  • SubscriptionId — (String)

    The ID of the subscription.

  • OrganizationId — (String)

    The ID of the organization.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  UserId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.deleteUser(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.

  • UserId — (String)

    The ID of the user.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  ActivityTypes: 'STRING_VALUE',
  AuthenticationToken: 'STRING_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  IncludeIndirectActivities: true || false,
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  OrganizationId: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  UserId: 'STRING_VALUE'
};
workdocs.describeActivities(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • StartTime — (Date)

    The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

  • EndTime — (Date)

    The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

  • OrganizationId — (String)

    The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

  • ActivityTypes — (String)

    Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

  • ResourceId — (String)

    The document or folder ID for which to describe activity types.

  • UserId — (String)

    The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

  • IncludeIndirectActivities — (Boolean)

    Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

  • Limit — (Integer)

    The maximum number of items to return.

  • Marker — (String)

    The marker for the next set of results.

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:

    • UserActivities — (Array<map>)

      The list of activities for the specified user and time period.

      • Type — (String)

        The activity type.

        Possible values include:
        • "DOCUMENT_CHECKED_IN"
        • "DOCUMENT_CHECKED_OUT"
        • "DOCUMENT_RENAMED"
        • "DOCUMENT_VERSION_UPLOADED"
        • "DOCUMENT_VERSION_DELETED"
        • "DOCUMENT_VERSION_VIEWED"
        • "DOCUMENT_VERSION_DOWNLOADED"
        • "DOCUMENT_RECYCLED"
        • "DOCUMENT_RESTORED"
        • "DOCUMENT_REVERTED"
        • "DOCUMENT_SHARED"
        • "DOCUMENT_UNSHARED"
        • "DOCUMENT_SHARE_PERMISSION_CHANGED"
        • "DOCUMENT_SHAREABLE_LINK_CREATED"
        • "DOCUMENT_SHAREABLE_LINK_REMOVED"
        • "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED"
        • "DOCUMENT_MOVED"
        • "DOCUMENT_COMMENT_ADDED"
        • "DOCUMENT_COMMENT_DELETED"
        • "DOCUMENT_ANNOTATION_ADDED"
        • "DOCUMENT_ANNOTATION_DELETED"
        • "FOLDER_CREATED"
        • "FOLDER_DELETED"
        • "FOLDER_RENAMED"
        • "FOLDER_RECYCLED"
        • "FOLDER_RESTORED"
        • "FOLDER_SHARED"
        • "FOLDER_UNSHARED"
        • "FOLDER_SHARE_PERMISSION_CHANGED"
        • "FOLDER_SHAREABLE_LINK_CREATED"
        • "FOLDER_SHAREABLE_LINK_REMOVED"
        • "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED"
        • "FOLDER_MOVED"
      • TimeStamp — (Date)

        The timestamp when the action was performed.

      • IsIndirectActivity — (Boolean)

        Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

      • OrganizationId — (String)

        The ID of the organization.

      • Initiator — (map)

        The user who performed the action.

        • Id — (String)

          The ID of the user.

        • Username — (String)

          The name of the user.

        • GivenName — (String)

          The given name of the user before a rename operation.

        • Surname — (String)

          The surname of the user.

        • EmailAddress — (String)

          The email address of the user.

      • Participants — (map)

        The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

        • Users — (Array<map>)

          The list of users.

          • Id — (String)

            The ID of the user.

          • Username — (String)

            The name of the user.

          • GivenName — (String)

            The given name of the user before a rename operation.

          • Surname — (String)

            The surname of the user.

          • EmailAddress — (String)

            The email address of the user.

        • Groups — (Array<map>)

          The list of user groups.

          • Id — (String)

            The ID of the user group.

          • Name — (String)

            The name of the group.

      • ResourceMetadata — (map)

        The metadata of the resource involved in the user action.

        • Type — (String)

          The type of resource.

          Possible values include:
          • "FOLDER"
          • "DOCUMENT"
        • Name — (String)

          The name of the resource.

        • OriginalName — (String)

          The original name of the resource before a rename operation.

        • Id — (String)

          The ID of the resource.

        • VersionId — (String)

          The version ID of the resource. This is an optional field and is filled for action on document version.

        • Owner — (map)

          The owner of the resource.

          • Id — (String)

            The ID of the user.

          • Username — (String)

            The name of the user.

          • GivenName — (String)

            The given name of the user before a rename operation.

          • Surname — (String)

            The surname of the user.

          • EmailAddress — (String)

            The email address of the user.

        • ParentId — (String)

          The parent ID of the resource before a rename operation.

      • OriginalParent — (map)

        The original parent of the resource. This is an optional field and is filled for move activities.

        • Type — (String)

          The type of resource.

          Possible values include:
          • "FOLDER"
          • "DOCUMENT"
        • Name — (String)

          The name of the resource.

        • OriginalName — (String)

          The original name of the resource before a rename operation.

        • Id — (String)

          The ID of the resource.

        • VersionId — (String)

          The version ID of the resource. This is an optional field and is filled for action on document version.

        • Owner — (map)

          The owner of the resource.

          • Id — (String)

            The ID of the user.

          • Username — (String)

            The name of the user.

          • GivenName — (String)

            The given name of the user before a rename operation.

          • Surname — (String)

            The surname of the user.

          • EmailAddress — (String)

            The email address of the user.

        • ParentId — (String)

          The parent ID of the resource before a rename operation.

      • CommentMetadata — (map)

        Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

        • CommentId — (String)

          The ID of the comment.

        • Contributor — (map)

          The user who made the comment.

          • Id — (String)

            The ID of the user.

          • Username — (String)

            The login name of the user.

          • EmailAddress — (String)

            The email address of the user.

          • GivenName — (String)

            The given name of the user.

          • Surname — (String)

            The surname of the user.

          • OrganizationId — (String)

            The ID of the organization.

          • RootFolderId — (String)

            The ID of the root folder.

          • RecycleBinFolderId — (String)

            The ID of the recycle bin folder.

          • Status — (String)

            The status of the user.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
            • "PENDING"
          • Type — (String)

            The type of user.

            Possible values include:
            • "USER"
            • "ADMIN"
            • "POWERUSER"
            • "MINIMALUSER"
            • "WORKSPACESUSER"
          • CreatedTimestamp — (Date)

            The time when the user was created.

          • ModifiedTimestamp — (Date)

            The time when the user was modified.

          • TimeZoneId — (String)

            The time zone ID of the user.

          • Locale — (String)

            The locale of the user.

            Possible values include:
            • "en"
            • "fr"
            • "ko"
            • "de"
            • "es"
            • "ja"
            • "ru"
            • "zh_CN"
            • "zh_TW"
            • "pt_BR"
            • "default"
          • Storage — (map)

            The storage for the user.

            • StorageUtilizedInBytes — (Integer)

              The amount of storage used, in bytes.

            • StorageRule — (map)

              The storage for a user.

              • StorageAllocatedInBytes — (Integer)

                The amount of storage allocated, in bytes.

              • StorageType — (String)

                The type of storage.

                Possible values include:
                • "UNLIMITED"
                • "QUOTA"
        • CreatedTimestamp — (Date)

          The timestamp that the comment was created.

        • CommentStatus — (String)

          The status of the comment.

          Possible values include:
          • "DRAFT"
          • "PUBLISHED"
          • "DELETED"
        • RecipientId — (String)

          The ID of the user being replied to.

        • ContributorId — (String)

          The ID of the user who made the comment.

    • Marker — (String)

      The marker for the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.describeComments(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • VersionId — (String)

    The ID of the document version.

  • Limit — (Integer)

    The maximum number of items to return.

  • Marker — (String)

    The marker for the next set of results. This marker was received from a previous 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:

    • Comments — (Array<map>)

      The list of comments for the specified document version.

      • CommentId — required — (String)

        The ID of the comment.

      • ParentId — (String)

        The ID of the parent comment.

      • ThreadId — (String)

        The ID of the root comment in the thread.

      • Text — (String)

        The text of the comment.

      • Contributor — (map)

        The details of the user who made the comment.

        • Id — (String)

          The ID of the user.

        • Username — (String)

          The login name of the user.

        • EmailAddress — (String)

          The email address of the user.

        • GivenName — (String)

          The given name of the user.

        • Surname — (String)

          The surname of the user.

        • OrganizationId — (String)

          The ID of the organization.

        • RootFolderId — (String)

          The ID of the root folder.

        • RecycleBinFolderId — (String)

          The ID of the recycle bin folder.

        • Status — (String)

          The status of the user.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
          • "PENDING"
        • Type — (String)

          The type of user.

          Possible values include:
          • "USER"
          • "ADMIN"
          • "POWERUSER"
          • "MINIMALUSER"
          • "WORKSPACESUSER"
        • CreatedTimestamp — (Date)

          The time when the user was created.

        • ModifiedTimestamp — (Date)

          The time when the user was modified.

        • TimeZoneId — (String)

          The time zone ID of the user.

        • Locale — (String)

          The locale of the user.

          Possible values include:
          • "en"
          • "fr"
          • "ko"
          • "de"
          • "es"
          • "ja"
          • "ru"
          • "zh_CN"
          • "zh_TW"
          • "pt_BR"
          • "default"
        • Storage — (map)

          The storage for the user.

          • StorageUtilizedInBytes — (Integer)

            The amount of storage used, in bytes.

          • StorageRule — (map)

            The storage for a user.

            • StorageAllocatedInBytes — (Integer)

              The amount of storage allocated, in bytes.

            • StorageType — (String)

              The type of storage.

              Possible values include:
              • "UNLIMITED"
              • "QUOTA"
      • CreatedTimestamp — (Date)

        The time that the comment was created.

      • Status — (String)

        The status of the comment.

        Possible values include:
        • "DRAFT"
        • "PUBLISHED"
        • "DELETED"
      • Visibility — (String)

        The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • RecipientId — (String)

        If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

    • Marker — (String)

      The marker for the next set of results. This marker was received from a previous call.

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Fields: 'STRING_VALUE',
  Include: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.describeDocumentVersions(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous call.)

  • Limit — (Integer)

    The maximum number of versions to return with this call.

  • Include — (String)

    A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

  • Fields — (String)

    Specify "SOURCE" to include initialized versions and a URL for the source document.

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:

    • DocumentVersions — (Array<map>)

      The document versions.

      • Id — (String)

        The ID of the version.

      • Name — (String)

        The name of the version.

      • ContentType — (String)

        The content type of the document.

      • Size — (Integer)

        The size of the document, in bytes.

      • Signature — (String)

        The signature of the document.

      • Status — (String)

        The status of the document.

        Possible values include:
        • "INITIALIZED"
        • "ACTIVE"
      • CreatedTimestamp — (Date)

        The timestamp when the document was first uploaded.

      • ModifiedTimestamp — (Date)

        The timestamp when the document was last uploaded.

      • ContentCreatedTimestamp — (Date)

        The timestamp when the content of the document was originally created.

      • ContentModifiedTimestamp — (Date)

        The timestamp when the content of the document was modified.

      • CreatorId — (String)

        The ID of the creator.

      • Thumbnail — (map<String>)

        The thumbnail of the document.

      • Source — (map<String>)

        The source of the document.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  FolderId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Include: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  Order: ASCENDING | DESCENDING,
  Sort: DATE | NAME,
  Type: ALL | DOCUMENT | FOLDER
};
workdocs.describeFolderContents(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId — (String)

    The ID of the folder.

  • Sort — (String)

    The sorting criteria.

    Possible values include:
    • "DATE"
    • "NAME"
  • Order — (String)

    The order for the contents of the folder.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"
  • Limit — (Integer)

    The maximum number of items to return with this call.

  • Marker — (String)

    The marker for the next set of results. This marker was received from a previous call.

  • Type — (String)

    The type of items.

    Possible values include:
    • "ALL"
    • "DOCUMENT"
    • "FOLDER"
  • Include — (String)

    The contents to include. Specify "INITIALIZED" to include initialized documents.

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:

    • Folders — (Array<map>)

      The subfolders in the specified folder.

      • Id — (String)

        The ID of the folder.

      • Name — (String)

        The name of the folder.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the folder was created.

      • ModifiedTimestamp — (Date)

        The time when the folder was updated.

      • ResourceState — (String)

        The resource state of the folder.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Signature — (String)

        The unique identifier created from the subfolders and documents of the folder.

      • Labels — (Array<String>)

        List of labels on the folder.

      • Size — (Integer)

        The size of the folder metadata.

      • LatestVersionSize — (Integer)

        The size of the latest version of the folder metadata.

    • Documents — (Array<map>)

      The documents in the specified folder.

      • Id — (String)

        The ID of the document.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the document was created.

      • ModifiedTimestamp — (Date)

        The time when the document was updated.

      • LatestVersionMetadata — (map)

        The latest version of the document.

        • Id — (String)

          The ID of the version.

        • Name — (String)

          The name of the version.

        • ContentType — (String)

          The content type of the document.

        • Size — (Integer)

          The size of the document, in bytes.

        • Signature — (String)

          The signature of the document.

        • Status — (String)

          The status of the document.

          Possible values include:
          • "INITIALIZED"
          • "ACTIVE"
        • CreatedTimestamp — (Date)

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp — (Date)

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp — (Date)

          The timestamp when the content of the document was originally created.

        • ContentModifiedTimestamp — (Date)

          The timestamp when the content of the document was modified.

        • CreatorId — (String)

          The ID of the creator.

        • Thumbnail — (map<String>)

          The thumbnail of the document.

        • Source — (map<String>)

          The source of the document.

      • ResourceState — (String)

        The resource state.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Labels — (Array<String>)

        List of labels on the document.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  SearchQuery: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  OrganizationId: 'STRING_VALUE'
};
workdocs.describeGroups(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • SearchQuery — (String)

    A query to describe groups by group name.

  • OrganizationId — (String)

    The ID of the organization.

  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous call.)

  • Limit — (Integer)

    The maximum number of items to return with this 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:

    • Groups — (Array<map>)

      The list of groups.

      • Id — (String)

        The ID of the user group.

      • Name — (String)

        The name of the group.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.describeNotificationSubscriptions(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: {}) —
  • OrganizationId — (String)

    The ID of the organization.

  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous call.)

  • Limit — (Integer)

    The maximum number of items to return with this 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:

    • Subscriptions — (Array<map>)

      The subscriptions.

      • SubscriptionId — (String)

        The ID of the subscription.

      • EndPoint — (String)

        The endpoint of the subscription.

      • Protocol — (String)

        The protocol of the subscription.

        Possible values include:
        • "HTTPS"
        • "SQS"
    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  PrincipalId: 'STRING_VALUE'
};
workdocs.describeResourcePermissions(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of the resource.

  • PrincipalId — (String)

    The ID of the principal to filter permissions by.

  • Limit — (Integer)

    The maximum number of items to return with this call.

  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous 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:

    • Principals — (Array<map>)

      The principals.

      • Id — (String)

        The ID of the resource.

      • Type — (String)

        The type of resource.

        Possible values include:
        • "USER"
        • "GROUP"
        • "INVITE"
        • "ANONYMOUS"
        • "ORGANIZATION"
      • Roles — (Array<map>)

        The permission information for the resource.

        • Role — (String)

          The role of the user.

          Possible values include:
          • "VIEWER"
          • "CONTRIBUTOR"
          • "OWNER"
          • "COOWNER"
        • Type — (String)

          The type of permissions.

          Possible values include:
          • "DIRECT"
          • "INHERITED"
    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  AuthenticationToken: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.describeRootFolders(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token.

  • Limit — (Integer)

    The maximum number of items to return.

  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous 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:

    • Folders — (Array<map>)

      The user's special folders.

      • Id — (String)

        The ID of the folder.

      • Name — (String)

        The name of the folder.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the folder was created.

      • ModifiedTimestamp — (Date)

        The time when the folder was updated.

      • ResourceState — (String)

        The resource state of the folder.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Signature — (String)

        The unique identifier created from the subfolders and documents of the folder.

      • Labels — (Array<String>)

        List of labels on the folder.

      • Size — (Integer)

        The size of the folder metadata.

      • LatestVersionSize — (Integer)

        The size of the latest version of the folder metadata.

    • Marker — (String)

      The marker for the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  AuthenticationToken: 'STRING_VALUE',
  Fields: 'STRING_VALUE',
  Include: ALL | ACTIVE_PENDING,
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  Order: ASCENDING | DESCENDING,
  OrganizationId: 'STRING_VALUE',
  Query: 'STRING_VALUE',
  Sort: USER_NAME | FULL_NAME | STORAGE_LIMIT | USER_STATUS | STORAGE_USED,
  UserIds: 'STRING_VALUE'
};
workdocs.describeUsers(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • OrganizationId — (String)

    The ID of the organization.

  • UserIds — (String)

    The IDs of the users.

  • Query — (String)

    A query to filter users by user name. Remember the following about the Userids and Query parameters:

    • If you don't use either parameter, the API returns a paginated list of all users on the site.

    • If you use both parameters, the API ignores the Query parameter.

    • The Userid parameter only returns user names that match a corresponding user ID.

    • The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

  • Include — (String)

    The state of the users. Specify "ALL" to include inactive users.

    Possible values include:
    • "ALL"
    • "ACTIVE_PENDING"
  • Order — (String)

    The order for the results.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"
  • Sort — (String)

    The sorting criteria.

    Possible values include:
    • "USER_NAME"
    • "FULL_NAME"
    • "STORAGE_LIMIT"
    • "USER_STATUS"
    • "STORAGE_USED"
  • Marker — (String)

    The marker for the next set of results. (You received this marker from a previous call.)

  • Limit — (Integer)

    The maximum number of items to return.

  • Fields — (String)

    A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

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:

    • Users — (Array<map>)

      The users.

      • Id — (String)

        The ID of the user.

      • Username — (String)

        The login name of the user.

      • EmailAddress — (String)

        The email address of the user.

      • GivenName — (String)

        The given name of the user.

      • Surname — (String)

        The surname of the user.

      • OrganizationId — (String)

        The ID of the organization.

      • RootFolderId — (String)

        The ID of the root folder.

      • RecycleBinFolderId — (String)

        The ID of the recycle bin folder.

      • Status — (String)

        The status of the user.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING"
      • Type — (String)

        The type of user.

        Possible values include:
        • "USER"
        • "ADMIN"
        • "POWERUSER"
        • "MINIMALUSER"
        • "WORKSPACESUSER"
      • CreatedTimestamp — (Date)

        The time when the user was created.

      • ModifiedTimestamp — (Date)

        The time when the user was modified.

      • TimeZoneId — (String)

        The time zone ID of the user.

      • Locale — (String)

        The locale of the user.

        Possible values include:
        • "en"
        • "fr"
        • "ko"
        • "de"
        • "es"
        • "ja"
        • "ru"
        • "zh_CN"
        • "zh_TW"
        • "pt_BR"
        • "default"
      • Storage — (map)

        The storage for the user.

        • StorageUtilizedInBytes — (Integer)

          The amount of storage used, in bytes.

        • StorageRule — (map)

          The storage for a user.

          • StorageAllocatedInBytes — (Integer)

            The amount of storage allocated, in bytes.

          • StorageType — (String)

            The type of storage.

            Possible values include:
            • "UNLIMITED"
            • "QUOTA"
    • TotalNumberOfUsers — (Integer)

      The total number of users included in the results.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

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

    Amazon WorkDocs authentication token.

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:

    • User — (map)

      Metadata of the user.

      • Id — (String)

        The ID of the user.

      • Username — (String)

        The login name of the user.

      • EmailAddress — (String)

        The email address of the user.

      • GivenName — (String)

        The given name of the user.

      • Surname — (String)

        The surname of the user.

      • OrganizationId — (String)

        The ID of the organization.

      • RootFolderId — (String)

        The ID of the root folder.

      • RecycleBinFolderId — (String)

        The ID of the recycle bin folder.

      • Status — (String)

        The status of the user.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING"
      • Type — (String)

        The type of user.

        Possible values include:
        • "USER"
        • "ADMIN"
        • "POWERUSER"
        • "MINIMALUSER"
        • "WORKSPACESUSER"
      • CreatedTimestamp — (Date)

        The time when the user was created.

      • ModifiedTimestamp — (Date)

        The time when the user was modified.

      • TimeZoneId — (String)

        The time zone ID of the user.

      • Locale — (String)

        The locale of the user.

        Possible values include:
        • "en"
        • "fr"
        • "ko"
        • "de"
        • "es"
        • "ja"
        • "ru"
        • "zh_CN"
        • "zh_TW"
        • "pt_BR"
        • "default"
      • Storage — (map)

        The storage for the user.

        • StorageUtilizedInBytes — (Integer)

          The amount of storage used, in bytes.

        • StorageRule — (map)

          The storage for a user.

          • StorageAllocatedInBytes — (Integer)

            The amount of storage allocated, in bytes.

          • StorageType — (String)

            The type of storage.

            Possible values include:
            • "UNLIMITED"
            • "QUOTA"

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  IncludeCustomMetadata: true || false
};
workdocs.getDocument(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • IncludeCustomMetadata — (Boolean)

    Set this to TRUE to include custom metadata in the response.

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:

    • Metadata — (map)

      The metadata details of the document.

      • Id — (String)

        The ID of the document.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the document was created.

      • ModifiedTimestamp — (Date)

        The time when the document was updated.

      • LatestVersionMetadata — (map)

        The latest version of the document.

        • Id — (String)

          The ID of the version.

        • Name — (String)

          The name of the version.

        • ContentType — (String)

          The content type of the document.

        • Size — (Integer)

          The size of the document, in bytes.

        • Signature — (String)

          The signature of the document.

        • Status — (String)

          The status of the document.

          Possible values include:
          • "INITIALIZED"
          • "ACTIVE"
        • CreatedTimestamp — (Date)

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp — (Date)

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp — (Date)

          The timestamp when the content of the document was originally created.

        • ContentModifiedTimestamp — (Date)

          The timestamp when the content of the document was modified.

        • CreatorId — (String)

          The ID of the creator.

        • Thumbnail — (map<String>)

          The thumbnail of the document.

        • Source — (map<String>)

          The source of the document.

      • ResourceState — (String)

        The resource state.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Labels — (Array<String>)

        List of labels on the document.

    • CustomMetadata — (map<String>)

      The custom metadata on the document.

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Fields: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.getDocumentPath(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • Limit — (Integer)

    The maximum number of levels in the hierarchy to return.

  • Fields — (String)

    A comma-separated list of values. Specify NAME to include the names of the parent folders.

  • Marker — (String)

    This value is not supported.

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:

    • Path — (map)

      The path information.

      • Components — (Array<map>)

        The components of the resource path.

        • Id — (String)

          The ID of the resource path.

        • Name — (String)

          The name of the resource path.

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Fields: 'STRING_VALUE',
  IncludeCustomMetadata: true || false
};
workdocs.getDocumentVersion(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

  • VersionId — (String)

    The version ID of the document.

  • Fields — (String)

    A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

  • IncludeCustomMetadata — (Boolean)

    Set this to TRUE to include custom metadata in the response.

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:

    • Metadata — (map)

      The version metadata.

      • Id — (String)

        The ID of the version.

      • Name — (String)

        The name of the version.

      • ContentType — (String)

        The content type of the document.

      • Size — (Integer)

        The size of the document, in bytes.

      • Signature — (String)

        The signature of the document.

      • Status — (String)

        The status of the document.

        Possible values include:
        • "INITIALIZED"
        • "ACTIVE"
      • CreatedTimestamp — (Date)

        The timestamp when the document was first uploaded.

      • ModifiedTimestamp — (Date)

        The timestamp when the document was last uploaded.

      • ContentCreatedTimestamp — (Date)

        The timestamp when the content of the document was originally created.

      • ContentModifiedTimestamp — (Date)

        The timestamp when the content of the document was modified.

      • CreatorId — (String)

        The ID of the creator.

      • Thumbnail — (map<String>)

        The thumbnail of the document.

      • Source — (map<String>)

        The source of the document.

    • CustomMetadata — (map<String>)

      The custom metadata on the document version.

Returns:

• (AWS.Request) —

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

var params = {
  FolderId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  IncludeCustomMetadata: true || false
};
workdocs.getFolder(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId — (String)

    The ID of the folder.

  • IncludeCustomMetadata — (Boolean)

    Set to TRUE to include custom metadata in the response.

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:

    • Metadata — (map)

      The metadata of the folder.

      • Id — (String)

        The ID of the folder.

      • Name — (String)

        The name of the folder.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the folder was created.

      • ModifiedTimestamp — (Date)

        The time when the folder was updated.

      • ResourceState — (String)

        The resource state of the folder.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Signature — (String)

        The unique identifier created from the subfolders and documents of the folder.

      • Labels — (Array<String>)

        List of labels on the folder.

      • Size — (Integer)

        The size of the folder metadata.

      • LatestVersionSize — (Integer)

        The size of the latest version of the folder metadata.

    • CustomMetadata — (map<String>)

      The custom metadata on the folder.

Returns:

• (AWS.Request) —

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

var params = {
  FolderId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  Fields: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
workdocs.getFolderPath(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId — (String)

    The ID of the folder.

  • Limit — (Integer)

    The maximum number of levels in the hierarchy to return.

  • Fields — (String)

    A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

  • Marker — (String)

    This value is not supported.

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:

    • Path — (map)

      The path information.

      • Components — (Array<map>)

        The components of the resource path.

        • Id — (String)

          The ID of the resource path.

        • Name — (String)

          The name of the resource path.

Returns:

• (AWS.Request) —

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

var params = {
  AuthenticationToken: 'STRING_VALUE',
  CollectionType: SHARED_WITH_ME,
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  UserId: 'STRING_VALUE'
};
workdocs.getResources(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: {}) —
  • AuthenticationToken — (String)

    The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • UserId — (String)

    The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

  • CollectionType — (String)

    The collection type.

    Possible values include:
    • "SHARED_WITH_ME"
  • Limit — (Integer)

    The maximum number of resources to return.

  • Marker — (String)

    The marker for the next set of results. This marker was received from a previous 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:

    • Folders — (Array<map>)

      The folders in the specified folder.

      • Id — (String)

        The ID of the folder.

      • Name — (String)

        The name of the folder.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the folder was created.

      • ModifiedTimestamp — (Date)

        The time when the folder was updated.

      • ResourceState — (String)

        The resource state of the folder.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Signature — (String)

        The unique identifier created from the subfolders and documents of the folder.

      • Labels — (Array<String>)

        List of labels on the folder.

      • Size — (Integer)

        The size of the folder metadata.

      • LatestVersionSize — (Integer)

        The size of the latest version of the folder metadata.

    • Documents — (Array<map>)

      The documents in the specified collection.

      • Id — (String)

        The ID of the document.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the document was created.

      • ModifiedTimestamp — (Date)

        The time when the document was updated.

      • LatestVersionMetadata — (map)

        The latest version of the document.

        • Id — (String)

          The ID of the version.

        • Name — (String)

          The name of the version.

        • ContentType — (String)

          The content type of the document.

        • Size — (Integer)

          The size of the document, in bytes.

        • Signature — (String)

          The signature of the document.

        • Status — (String)

          The status of the document.

          Possible values include:
          • "INITIALIZED"
          • "ACTIVE"
        • CreatedTimestamp — (Date)

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp — (Date)

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp — (Date)

          The timestamp when the content of the document was originally created.

        • ContentModifiedTimestamp — (Date)

          The timestamp when the content of the document was modified.

        • CreatorId — (String)

          The ID of the creator.

        • Thumbnail — (map<String>)

          The thumbnail of the document.

        • Source — (map<String>)

          The source of the document.

      • ResourceState — (String)

        The resource state.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Labels — (Array<String>)

        List of labels on the document.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

• (AWS.Request) —

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

var params = {
  AuthenticationToken: 'STRING_VALUE',
  ContentCreatedTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ContentModifiedTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ContentType: 'STRING_VALUE',
  DocumentSizeInBytes: 'NUMBER_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  ParentFolderId: 'STRING_VALUE'
};
workdocs.initiateDocumentVersionUpload(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • Id — (String)

    The ID of the document.

  • Name — (String)

    The name of the document.

  • ContentCreatedTimestamp — (Date)

    The timestamp when the content of the document was originally created.

  • ContentModifiedTimestamp — (Date)

    The timestamp when the content of the document was modified.

  • ContentType — (String)

    The content type of the document.

  • DocumentSizeInBytes — (Integer)

    The size of the document, in bytes.

  • ParentFolderId — (String)

    The ID of the parent folder.

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:

    • Metadata — (map)

      The document metadata.

      • Id — (String)

        The ID of the document.

      • CreatorId — (String)

        The ID of the creator.

      • ParentFolderId — (String)

        The ID of the parent folder.

      • CreatedTimestamp — (Date)

        The time when the document was created.

      • ModifiedTimestamp — (Date)

        The time when the document was updated.

      • LatestVersionMetadata — (map)

        The latest version of the document.

        • Id — (String)

          The ID of the version.

        • Name — (String)

          The name of the version.

        • ContentType — (String)

          The content type of the document.

        • Size — (Integer)

          The size of the document, in bytes.

        • Signature — (String)

          The signature of the document.

        • Status — (String)

          The status of the document.

          Possible values include:
          • "INITIALIZED"
          • "ACTIVE"
        • CreatedTimestamp — (Date)

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp — (Date)

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp — (Date)

          The timestamp when the content of the document was originally created.

        • ContentModifiedTimestamp — (Date)

          The timestamp when the content of the document was modified.

        • CreatorId — (String)

          The ID of the creator.

        • Thumbnail — (map<String>)

          The thumbnail of the document.

        • Source — (map<String>)

          The source of the document.

      • ResourceState — (String)

        The resource state.

        Possible values include:
        • "ACTIVE"
        • "RESTORING"
        • "RECYCLING"
        • "RECYCLED"
      • Labels — (Array<String>)

        List of labels on the document.

    • UploadMetadata — (map)

      The upload metadata.

      • UploadUrl — (String)

        The URL of the upload.

      • SignedHeaders — (map<String>)

        The signed headers.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.removeAllResourcePermissions(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of 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.

var params = {
  PrincipalId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE',
  PrincipalType: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION
};
workdocs.removeResourcePermission(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId — (String)

    The ID of the resource.

  • PrincipalId — (String)

    The principal ID of the resource.

  • PrincipalType — (String)

    The principal type of the resource.

    Possible values include:
    • "USER"
    • "GROUP"
    • "INVITE"
    • "ANONYMOUS"
    • "ORGANIZATION"

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  DocumentId: 'STRING_VALUE', /* required */
  AuthenticationToken: 'STRING_VALUE'
};
workdocs.restoreDocumentVersions(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId — (String)

    The ID of the document.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  AdditionalResponseFields: [
    WEBURL,
    /* more items */
  ],
  AuthenticationToken: 'STRING_VALUE',
  Filters: {
    AncestorIds: [
      'STRING_VALUE',
      /* more items */
    ],
    ContentCategories: [
      IMAGE | DOCUMENT | PDF | SPREADSHEET | PRESENTATION | AUDIO | VIDEO | SOURCE_CODE | OTHER,
      /* more items */
    ],
    CreatedRange: {
      EndValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      StartValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    Labels: [
      'STRING_VALUE',
      /* more items */
    ],
    ModifiedRange: {
      EndValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      StartValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    Principals: [
      {
        Id: 'STRING_VALUE', /* required */
        Roles: [
          VIEWER | CONTRIBUTOR | OWNER | COOWNER,
          /* more items */
        ]
      },
      /* more items */
    ],
    ResourceTypes: [
      FOLDER | DOCUMENT | COMMENT | DOCUMENT_VERSION,
      /* more items */
    ],
    SearchCollectionTypes: [
      OWNED | SHARED_WITH_ME,
      /* more items */
    ],
    SizeRange: {
      EndValue: 'NUMBER_VALUE',
      StartValue: 'NUMBER_VALUE'
    },
    TextLocales: [
      AR | BG | BN | DA | DE | CS | EL | EN | ES | FA | FI | FR | HI | HU | ID | IT | JA | KO | LT | LV | NL | NO | PT | RO | RU | SV | SW | TH | TR | ZH | DEFAULT,
      /* more items */
    ]
  },
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  OrderBy: [
    {
      Field: RELEVANCE | NAME | SIZE | CREATED_TIMESTAMP | MODIFIED_TIMESTAMP,
      Order: ASC | DESC
    },
    /* more items */
  ],
  OrganizationId: 'STRING_VALUE',
  QueryScopes: [
    NAME | CONTENT,
    /* more items */
  ],
  QueryText: 'STRING_VALUE'
};
workdocs.searchResources(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: {}) —
  • AuthenticationToken — (String)

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • QueryText — (String)

    The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

  • QueryScopes — (Array<String>)

    Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

  • OrganizationId — (String)

    Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

  • AdditionalResponseFields — (Array<String>)

    A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

  • Filters — (map)

    Filters results based on entity metadata.

    • TextLocales — (Array<String>)

      Filters by the locale of the content or comment.

    • ContentCategories — (Array<String>)

      Filters by content category.

    • ResourceTypes — (Array<String>)

      Filters based on entity type.

    • Labels — (Array<String>)

      Filter by labels using exact match.

    • Principals — (Array<map>)

      Filter based on UserIds or GroupIds.

      • Id — required — (String)

        UserIds or GroupIds.

      • Roles — (Array<String>)

        The Role of a User or Group.

    • AncestorIds — (Array<String>)

      Filter based on resource’s path.

    • SearchCollectionTypes — (Array<String>)

      Filter based on file groupings.

    • SizeRange — (map)

      Filter based on size (in bytes).

      • StartValue — (Integer)

        The size start range (in bytes).

      • EndValue — (Integer)

        The size end range (in bytes).

    • CreatedRange — (map)

      Filter based on resource’s creation timestamp.

      • StartValue — (Date)

        Timestamp range start value (in epochs)

      • EndValue — (Date)

        Timestamp range end value (in epochs).

    • ModifiedRange — (map)

      Filter based on resource’s modified timestamp.

      • StartValue — (Date)

        Timestamp range start value (in epochs)

      • EndValue — (Date)

        Timestamp range end value (in epochs).

  • OrderBy — (Array<map>)

    Order by results in one or more categories.

    • Field — (String)

      Sort search results based on this field name.

      Possible values include:
      • "RELEVANCE"
      • "NAME"
      • "SIZE"
      • "CREATED_TIMESTAMP"
      • "MODIFIED_TIMESTAMP"
    • Order — (String)

      Sort direction.

      Possible values include:
      • "ASC"
      • "DESC"
  • Limit — (Integer)

    Max results count per page.

  • Marker — (String)

    The marker for the next set of results.

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:

    • Items — (Array<map>)

      List of Documents, Folders, Comments, and Document Versions matching the query.

      • ResourceType — (String)

        The type of item being returned.

        Possible values include:
        • "DOCUMENT"
        • "FOLDER"
        • "COMMENT"
        • "DOCUMENT_VERSION"
      • WebUrl — (String)

        The webUrl of the item being returned.

      • DocumentMetadata — (map)

        The document that matches the query.

        • Id — (String)

          The ID of the document.

        • CreatorId — (String)

          The ID of the creator.

        • ParentFolderId — (String)

          The ID of the parent folder.

        • CreatedTimestamp — (Date)

          The time when the document was created.

        • ModifiedTimestamp — (Date)

          The time when the document was updated.

        • LatestVersionMetadata — (map)

          The latest version of the document.

          • Id — (String)

            The ID of the version.

          • Name — (String)

            The name of the version.

          • ContentType — (String)

            The content type of the document.

          • Size — (Integer)

            The size of the document, in bytes.

          • Signature — (String)

            The signature of the document.

          • Status — (String)

            The status of the document.

            Possible values include:
            • "INITIALIZED"
            • "ACTIVE"
          • CreatedTimestamp — (Date)

            The timestamp when the document was first uploaded.

          • ModifiedTimestamp — (Date)

            The timestamp when the document was last uploaded.

          • ContentCreatedTimestamp — (Date)

            The timestamp when the content of the document was originally created.

          • ContentModifiedTimestamp — (Date)

            The timestamp when the content of the document was modified.

          • CreatorId — (String)

            The ID of the creator.

          • Thumbnail — (map<String>)

            The thumbnail of the document.

          • Source — (map<String>)

            The source of the document.

        • ResourceState — (String)

          The resource state.

          Possible values include:
          • "ACTIVE"
          • "RESTORING"
          • "RECYCLING"
          • "RECYCLED"
        • Labels — (Array<String>)

          List of labels on the document.

      • FolderMetadata — (map)

        The folder that matches the query.

        • Id — (String)

          The ID of the folder.

        • Name — (String)

          The name of the folder.

        • CreatorId — (String)

          The ID of the creator.

        • ParentFolderId — (String)

          The ID of the parent folder.

        • CreatedTimestamp — (Date)

          The time when the folder was created.

        • ModifiedTimestamp — (Date)

          The time when the folder was updated.

        • ResourceState — (String)

          The resource state of the folder.

          Possible values include:
          • "ACTIVE"
          • "RESTORING"
          • "RECYCLING"
          • "RECYCLED"
        • Signature — (String)

          The unique identifier created from the subfolders and documents of the folder.

        • Labels — (Array<String>)

          List of labels on the folder.

        • Size — (Integer)

          The size of the folder metadata.

        • LatestVersionSize — (Integer)

          The size of the latest version of the folder metadata.

      • CommentMetadata — (map)

        The comment that matches the query.

        • CommentId — (String)

          The ID of the comment.

        • Contributor — (map)

          The user who made the comment.

          • Id — (String)

            The ID of the user.

          • Username — (String)

            The login name of the user.

          • EmailAddress — (String)

            The email address of the user.

          • GivenName — (String)

            The given name of the user.

          • Surname — (String)

            The surname of the user.

          • OrganizationId — (String)

            The ID of the organization.

          • RootFolderId — (String)

            The ID of the root folder.

          • RecycleBinFolderId — (String)

            The ID of the recycle bin folder.

          • Status — (String)

            The status of the user.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
            • "PENDING"
          • Type — (String)

            The type of user.

            Possible values include:
            • "USER"
            • "ADMIN"
            • "POWERUSER"
            • "MINIMALUSER"
            • "WORKSPACESUSER"
          • CreatedTimestamp — (Date)

            The time when the user was created.

          • ModifiedTimestamp — (Date)

            The time when the user was modified.

          • TimeZoneId — (String)

            The time zone ID of the user.

          • Locale — (String)

            The locale of the user.

            Possible values include:
            • "en"
            • "fr"
            • "ko"
            • "de"
            • "es"
            • "ja"
            • "ru"
            • "zh_CN"
            • "zh_TW"
            • "pt_BR"
            • "default"
          • Storage — (map)

            The storage for the user.

            • StorageUtilizedInBytes — (Integer)

              The amount of storage used, in bytes.

            • StorageRule — (map)

              The storage for a user.

              • StorageAllocatedInBytes — (Integer)

                The amount of storage allocated, in bytes.

              • StorageType — (String)

                The type of storage.

                Possible values include:
                • "UNLIMITED"
                • "QUOTA"
        • CreatedTimestamp — (Date)

          The timestamp that the comment was created.

        • CommentStatus — (String)

          The status of the comment.

          Possible values include:
          • "DRAFT"
          • "PUBLISHED"
          • "DELETED"
        • RecipientId — (String)

          The ID of the user being replied to.

        • ContributorId — (String)

          The ID of the user who made the comment.

      • DocumentVersionMetadata — (map)

        The document version that matches the metadata.

        • Id — (String)

          The ID of the version.

        • Name — (String)

          The name of the version.

        • ContentType — (String)

          The content type of the document.

        • Size — (Integer)

          The size of the document, in bytes.

        • Signature — (String)

          The signature of the document.

        • Status — (String)

          The status of the document.

          Possible values include:
          • "INITIALIZED"
          • "ACTIVE"
        • CreatedTimestamp — (Date)

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp — (Date)

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp — (Date)

          The timestamp when the content of the document was originally created.

        • ContentModifiedTimestamp — (Date)

          The timestamp when the content of the document was modified.

        • CreatorId — (String)

          The ID of the creator.

        • Thumbnail — (map<String>)

          The thumbnail of the document.

        • Source — (map<String>)

          The source of the document.

    • Marker — (String)

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.