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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass UpdateUserRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#given_nameString

The given name of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#grant_poweruser_privilegesString

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

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#localeString

The locale of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#storage_ruleTypes::StorageRuleType

The amount of storage for the user.



3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#surnameString

The surname of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#typeString

The type of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#user_idString

The ID of the user.

Returns:

  • (String)


3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3097

class UpdateUserRequest < Struct.new(
  :authentication_token,
  :user_id,
  :given_name,
  :surname,
  :type,
  :storage_rule,
  :time_zone_id,
  :locale,
  :grant_poweruser_privileges)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end