Class: Aws::QuickSight::Types::User

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

Overview

A registered user of Amazon QuickSight.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#activeBoolean

The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

Returns:

  • (Boolean)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) for the user.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#custom_permissions_nameString

The custom permissions profile associated with this user.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#emailString

The user's email address.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#identity_typeString

The type of identity authentication used by the user.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#principal_idString

The principal ID of the user.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

The Amazon QuickSight role for the user. The user role can be one of the following:.

  • READER: A user who has read-only access to dashboards.

  • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

  • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

  • RESTRICTED_READER: This role isn't currently available for use.

  • RESTRICTED_AUTHOR: This role isn't currently available for use.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The user's user name.

Returns:

  • (String)


12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12809

class User < Struct.new(
  :arn,
  :user_name,
  :email,
  :role,
  :identity_type,
  :active,
  :principal_id,
  :custom_permissions_name)
  SENSITIVE = []
  include Aws::Structure
end