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

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

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#given_nameString

The given name of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#localeString

The locale of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#storage_ruleTypes::StorageRuleType

The amount of storage for the user.



2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#surnameString

The surname of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#typeString

The type of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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

#user_idString

The ID of the user.

Returns:

  • (String)


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2509

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