Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workdocs ]

update-document

Description

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-document
[--authentication-token <value>]
--document-id <value>
[--name <value>]
[--parent-folder-id <value>]
[--resource-state <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--authentication-token (string)

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

--document-id (string)

The ID of the document.

--name (string)

The name of the document.

--parent-folder-id (string)

The ID of the parent folder.

--resource-state (string)

The resource state of the document. Only ACTIVE and RECYCLED are supported.

Possible values:

  • ACTIVE
  • RESTORING
  • RECYCLING
  • RECYCLED

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a document

This example updates a document's name and parent folder.

Command:

aws workdocs update-document --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --name updatedDoc --parent-folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08

Output:

None

Output

None