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. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#activeBoolean

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

Returns:

  • (Boolean)

    Active status of user.

#arnString

The Amazon Resource Name (ARN) for the user.

Returns:

  • (String)

    The Amazon Resource Name (ARN) for the user.

#emailString

The user\'s email address.

Returns:

  • (String)

    The user\'s email address.

#identity_typeString

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_idString

The principal ID of the user.

Returns:

  • (String)

    The principal ID of the user.

#roleString

The Amazon QuickSight role for the user.

Possible values:

  • ADMIN
  • AUTHOR
  • READER
  • RESTRICTED_AUTHOR
  • RESTRICTED_READER

Returns:

  • (String)

    The Amazon QuickSight role for the user.

#user_nameString

The user\'s user name.

Returns:

  • (String)

    The user\'s user name.