Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workdocs ]



Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--authentication-token <value>]
--resource-id <value>
--principals <value>
[--notification-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--authentication-token (string)

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

--resource-id (string)

The ID of the resource.

--principals (list)

The users, groups, or organization being granted permission.


Describes the recipient type and ID, if available.

Id -> (string)

The ID of the recipient.

Type -> (string)

The type of the recipient.

Role -> (string)

The role of the recipient.

Shorthand Syntax:

Id=string,Type=string,Role=string ...

JSON Syntax:

    "Id": "string",

--notification-options (structure)

The notification options.

SendEmail -> (boolean)

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

EmailMessage -> (string)

Text value to be included in the email body.

Shorthand Syntax:


JSON Syntax:

  "SendEmail": true|false,
  "EmailMessage": "string"

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


To add permissions for a resource

This example adds permissions to the resource for the specified principals.


aws workdocs add-resource-permissions --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --principals Id=anonymous,Type=ANONYMOUS,Role=VIEWER


  "ShareResults": [
          "PrincipalId": "anonymous",
          "Role": "VIEWER",
          "Status": "SUCCESS",
          "ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
          "StatusMessage": ""


ShareResults -> (list)

The share results.


Describes the share results of a resource.

PrincipalId -> (string)

The ID of the principal.

InviteePrincipalId -> (string)

The ID of the invited user.

Role -> (string)

The role.

Status -> (string)

The status.

ShareId -> (string)

The ID of the resource that was shared.

StatusMessage -> (string)

The status message.