Table Of Contents

Feedback

User Guide

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

[ aws . workdocs ]

update-user

Description

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-user
[--authentication-token <value>]
--user-id <value>
[--given-name <value>]
[--surname <value>]
[--type <value>]
[--storage-rule <value>]
[--time-zone-id <value>]
[--locale <value>]
[--grant-poweruser-privileges <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.

--user-id (string)

The ID of the user.

--given-name (string)

The given name of the user.

--surname (string)

The surname of the user.

--type (string)

The type of the user.

Possible values:

  • USER
  • ADMIN
  • POWERUSER
  • MINIMALUSER
  • WORKSPACESUSER

--storage-rule (structure)

The amount of storage for the user.

Shorthand Syntax:

StorageAllocatedInBytes=long,StorageType=string

JSON Syntax:

{
  "StorageAllocatedInBytes": long,
  "StorageType": "UNLIMITED"|"QUOTA"
}

--time-zone-id (string)

The time zone ID of the user.

--locale (string)

The locale of the user.

Possible values:

  • en
  • fr
  • ko
  • de
  • es
  • ja
  • ru
  • zh_CN
  • zh_TW
  • pt_BR
  • default

--grant-poweruser-privileges (string)

Boolean value to determine whether the user is granted Poweruser privileges.

Possible values:

  • TRUE
  • FALSE

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

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

Output

User -> (structure)

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.

Type -> (string)

The type of user.

CreatedTimestamp -> (timestamp)

The time when the user was created.

ModifiedTimestamp -> (timestamp)

The time when the user was modified.

TimeZoneId -> (string)

The time zone ID of the user.

Locale -> (string)

The locale of the user.

Storage -> (structure)

The storage for the user.

StorageUtilizedInBytes -> (long)

The amount of storage used, in bytes.

StorageRule -> (structure)

The storage for a user.

StorageAllocatedInBytes -> (long)

The amount of storage allocated, in bytes.

StorageType -> (string)

The type of storage.