You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkDocs::Types::UpdateUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateUserRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  authentication_token: "AuthenticationHeaderType",
  user_id: "IdType", # required
  given_name: "UserAttributeValueType",
  surname: "UserAttributeValueType",
  type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
  storage_rule: {
    storage_allocated_in_bytes: 1,
    storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
  },
  time_zone_id: "TimeZoneIdType",
  locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
  grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

  • (String) —

    Amazon WorkDocs authentication token.

#given_name ⇒ String

The given name of the user.

Returns:

  • (String) —

    The given name of the user.

#grant_poweruser_privileges ⇒ String

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

Possible values:

  • TRUE
  • FALSE

Returns:

  • (String) —

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

#locale ⇒ String

The locale of the user.

Possible values:

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

Returns:

  • (String) —

    The locale of the user.

#storage_rule ⇒ Types::StorageRuleType

The amount of storage for the user.

Returns:

#surname ⇒ String

The surname of the user.

Returns:

  • (String) —

    The surname of the user.

#time_zone_id ⇒ String

The time zone ID of the user.

Returns:

  • (String) —

    The time zone ID of the user.

#type ⇒ String

The type of the user.

Possible values:

  • USER
  • ADMIN
  • POWERUSER
  • MINIMALUSER
  • WORKSPACESUSER

Returns:

  • (String) —

    The type of the user.

#user_id ⇒ String

The ID of the user.

Returns:

  • (String) —

    The ID of the user.