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

Class: Aws::WorkDocs::Types::User

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

Overview

Describes a user.

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestampTime

The time when the user was created.

Returns:

  • (Time)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#email_addressString

The email address of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#given_nameString

The given name of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#idString

The ID of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#localeString

The locale of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#modified_timestampTime

The time when the user was modified.

Returns:

  • (Time)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#organization_idString

The ID of the organization.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#recycle_bin_folder_idString

The ID of the recycle bin folder.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#root_folder_idString

The ID of the root folder.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#statusString

The status of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#storageTypes::UserStorageMetadata

The storage for the user.



2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#surnameString

The surname of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#time_zone_idString

The time zone ID of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#typeString

The type of user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end

#usernameString

The login name of the user.

Returns:

  • (String)


2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2614

class User < Struct.new(
  :id,
  :username,
  :email_address,
  :given_name,
  :surname,
  :organization_id,
  :root_folder_id,
  :recycle_bin_folder_id,
  :status,
  :type,
  :created_timestamp,
  :modified_timestamp,
  :time_zone_id,
  :locale,
  :storage)
  include Aws::Structure
end