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

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

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

Overview

A registered user of Amazon QuickSight.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean

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) —

    The active status of user.

#arn ⇒ String

The Amazon Resource Name (ARN) for the user.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the user.

#custom_permissions_name ⇒ String

The custom permissions profile associated with this user.

Returns:

  • (String) —

    The custom permissions profile associated with this user.

#email ⇒ String

The user\'s email address.

Returns:

  • (String) —

    The user\'s email address.

#identity_type ⇒ String

The type of identity authentication used by the user.

Possible values:

  • IAM
  • QUICKSIGHT

Returns:

  • (String) —

    The type of identity authentication used by the user.

#principal_id ⇒ String

The principal ID of the user.

Returns:

  • (String) —

    The principal ID of the user.

#role ⇒ String

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.

    Possible values:

    • ADMIN
    • AUTHOR
    • READER
    • RESTRICTED_AUTHOR
    • RESTRICTED_READER

Returns:

  • (String) —

    The Amazon QuickSight role for the user.

#user_name ⇒ String

The user\'s user name.

Returns:

  • (String) —

    The user\'s user name.