AWS SDK for C++  1.8.96
AWS SDK for C++
Public Member Functions | List of all members
Aws::QuickSight::Model::User Class Reference

#include <User.h>

Public Member Functions

 User ()
 
 User (Aws::Utils::Json::JsonView jsonValue)
 
Useroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
UserWithArn (const Aws::String &value)
 
UserWithArn (Aws::String &&value)
 
UserWithArn (const char *value)
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
UserWithUserName (const Aws::String &value)
 
UserWithUserName (Aws::String &&value)
 
UserWithUserName (const char *value)
 
const Aws::StringGetEmail () const
 
bool EmailHasBeenSet () const
 
void SetEmail (const Aws::String &value)
 
void SetEmail (Aws::String &&value)
 
void SetEmail (const char *value)
 
UserWithEmail (const Aws::String &value)
 
UserWithEmail (Aws::String &&value)
 
UserWithEmail (const char *value)
 
const UserRoleGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const UserRole &value)
 
void SetRole (UserRole &&value)
 
UserWithRole (const UserRole &value)
 
UserWithRole (UserRole &&value)
 
const IdentityTypeGetIdentityType () const
 
bool IdentityTypeHasBeenSet () const
 
void SetIdentityType (const IdentityType &value)
 
void SetIdentityType (IdentityType &&value)
 
UserWithIdentityType (const IdentityType &value)
 
UserWithIdentityType (IdentityType &&value)
 
bool GetActive () const
 
bool ActiveHasBeenSet () const
 
void SetActive (bool value)
 
UserWithActive (bool value)
 
const Aws::StringGetPrincipalId () const
 
bool PrincipalIdHasBeenSet () const
 
void SetPrincipalId (const Aws::String &value)
 
void SetPrincipalId (Aws::String &&value)
 
void SetPrincipalId (const char *value)
 
UserWithPrincipalId (const Aws::String &value)
 
UserWithPrincipalId (Aws::String &&value)
 
UserWithPrincipalId (const char *value)
 
const Aws::StringGetCustomPermissionsName () const
 
bool CustomPermissionsNameHasBeenSet () const
 
void SetCustomPermissionsName (const Aws::String &value)
 
void SetCustomPermissionsName (Aws::String &&value)
 
void SetCustomPermissionsName (const char *value)
 
UserWithCustomPermissionsName (const Aws::String &value)
 
UserWithCustomPermissionsName (Aws::String &&value)
 
UserWithCustomPermissionsName (const char *value)
 

Detailed Description

A registered user of Amazon QuickSight.

See Also:

AWS API Reference

Definition at line 33 of file User.h.

Constructor & Destructor Documentation

◆ User() [1/2]

Aws::QuickSight::Model::User::User ( )

◆ User() [2/2]

Aws::QuickSight::Model::User::User ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActiveHasBeenSet()

bool Aws::QuickSight::Model::User::ActiveHasBeenSet ( ) const
inline

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.

Definition at line 287 of file User.h.

◆ ArnHasBeenSet()

bool Aws::QuickSight::Model::User::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 50 of file User.h.

◆ CustomPermissionsNameHasBeenSet()

bool Aws::QuickSight::Model::User::CustomPermissionsNameHasBeenSet ( ) const
inline

The custom permissions profile associated with this user.

Definition at line 353 of file User.h.

◆ EmailHasBeenSet()

bool Aws::QuickSight::Model::User::EmailHasBeenSet ( ) const
inline

The user's email address.

Definition at line 132 of file User.h.

◆ GetActive()

bool Aws::QuickSight::Model::User::GetActive ( ) const
inline

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.

Definition at line 280 of file User.h.

◆ GetArn()

const Aws::String& Aws::QuickSight::Model::User::GetArn ( ) const
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 45 of file User.h.

◆ GetCustomPermissionsName()

const Aws::String& Aws::QuickSight::Model::User::GetCustomPermissionsName ( ) const
inline

The custom permissions profile associated with this user.

Definition at line 348 of file User.h.

◆ GetEmail()

const Aws::String& Aws::QuickSight::Model::User::GetEmail ( ) const
inline

The user's email address.

Definition at line 127 of file User.h.

◆ GetIdentityType()

const IdentityType& Aws::QuickSight::Model::User::GetIdentityType ( ) const
inline

The type of identity authentication used by the user.

Definition at line 247 of file User.h.

◆ GetPrincipalId()

const Aws::String& Aws::QuickSight::Model::User::GetPrincipalId ( ) const
inline

The principal ID of the user.

Definition at line 307 of file User.h.

◆ GetRole()

const UserRole& Aws::QuickSight::Model::User::GetRole ( ) const
inline

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.

Definition at line 176 of file User.h.

◆ GetUserName()

const Aws::String& Aws::QuickSight::Model::User::GetUserName ( ) const
inline

The user's user name.

Definition at line 86 of file User.h.

◆ IdentityTypeHasBeenSet()

bool Aws::QuickSight::Model::User::IdentityTypeHasBeenSet ( ) const
inline

The type of identity authentication used by the user.

Definition at line 252 of file User.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::QuickSight::Model::User::Jsonize ( ) const

◆ operator=()

User& Aws::QuickSight::Model::User::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PrincipalIdHasBeenSet()

bool Aws::QuickSight::Model::User::PrincipalIdHasBeenSet ( ) const
inline

The principal ID of the user.

Definition at line 312 of file User.h.

◆ RoleHasBeenSet()

bool Aws::QuickSight::Model::User::RoleHasBeenSet ( ) const
inline

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.

Definition at line 189 of file User.h.

◆ SetActive()

void Aws::QuickSight::Model::User::SetActive ( bool  value)
inline

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.

Definition at line 294 of file User.h.

◆ SetArn() [1/3]

void Aws::QuickSight::Model::User::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 55 of file User.h.

◆ SetArn() [2/3]

void Aws::QuickSight::Model::User::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 60 of file User.h.

◆ SetArn() [3/3]

void Aws::QuickSight::Model::User::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 65 of file User.h.

◆ SetCustomPermissionsName() [1/3]

void Aws::QuickSight::Model::User::SetCustomPermissionsName ( const Aws::String value)
inline

The custom permissions profile associated with this user.

Definition at line 358 of file User.h.

◆ SetCustomPermissionsName() [2/3]

void Aws::QuickSight::Model::User::SetCustomPermissionsName ( Aws::String &&  value)
inline

The custom permissions profile associated with this user.

Definition at line 363 of file User.h.

◆ SetCustomPermissionsName() [3/3]

void Aws::QuickSight::Model::User::SetCustomPermissionsName ( const char *  value)
inline

The custom permissions profile associated with this user.

Definition at line 368 of file User.h.

◆ SetEmail() [1/3]

void Aws::QuickSight::Model::User::SetEmail ( const Aws::String value)
inline

The user's email address.

Definition at line 137 of file User.h.

◆ SetEmail() [2/3]

void Aws::QuickSight::Model::User::SetEmail ( Aws::String &&  value)
inline

The user's email address.

Definition at line 142 of file User.h.

◆ SetEmail() [3/3]

void Aws::QuickSight::Model::User::SetEmail ( const char *  value)
inline

The user's email address.

Definition at line 147 of file User.h.

◆ SetIdentityType() [1/2]

void Aws::QuickSight::Model::User::SetIdentityType ( const IdentityType value)
inline

The type of identity authentication used by the user.

Definition at line 257 of file User.h.

◆ SetIdentityType() [2/2]

void Aws::QuickSight::Model::User::SetIdentityType ( IdentityType &&  value)
inline

The type of identity authentication used by the user.

Definition at line 262 of file User.h.

◆ SetPrincipalId() [1/3]

void Aws::QuickSight::Model::User::SetPrincipalId ( const Aws::String value)
inline

The principal ID of the user.

Definition at line 317 of file User.h.

◆ SetPrincipalId() [2/3]

void Aws::QuickSight::Model::User::SetPrincipalId ( Aws::String &&  value)
inline

The principal ID of the user.

Definition at line 322 of file User.h.

◆ SetPrincipalId() [3/3]

void Aws::QuickSight::Model::User::SetPrincipalId ( const char *  value)
inline

The principal ID of the user.

Definition at line 327 of file User.h.

◆ SetRole() [1/2]

void Aws::QuickSight::Model::User::SetRole ( const UserRole value)
inline

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.

Definition at line 202 of file User.h.

◆ SetRole() [2/2]

void Aws::QuickSight::Model::User::SetRole ( UserRole &&  value)
inline

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.

Definition at line 215 of file User.h.

◆ SetUserName() [1/3]

void Aws::QuickSight::Model::User::SetUserName ( const Aws::String value)
inline

The user's user name.

Definition at line 96 of file User.h.

◆ SetUserName() [2/3]

void Aws::QuickSight::Model::User::SetUserName ( Aws::String &&  value)
inline

The user's user name.

Definition at line 101 of file User.h.

◆ SetUserName() [3/3]

void Aws::QuickSight::Model::User::SetUserName ( const char *  value)
inline

The user's user name.

Definition at line 106 of file User.h.

◆ UserNameHasBeenSet()

bool Aws::QuickSight::Model::User::UserNameHasBeenSet ( ) const
inline

The user's user name.

Definition at line 91 of file User.h.

◆ WithActive()

User& Aws::QuickSight::Model::User::WithActive ( bool  value)
inline

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.

Definition at line 301 of file User.h.

◆ WithArn() [1/3]

User& Aws::QuickSight::Model::User::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 70 of file User.h.

◆ WithArn() [2/3]

User& Aws::QuickSight::Model::User::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 75 of file User.h.

◆ WithArn() [3/3]

User& Aws::QuickSight::Model::User::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the user.

Definition at line 80 of file User.h.

◆ WithCustomPermissionsName() [1/3]

User& Aws::QuickSight::Model::User::WithCustomPermissionsName ( const Aws::String value)
inline

The custom permissions profile associated with this user.

Definition at line 373 of file User.h.

◆ WithCustomPermissionsName() [2/3]

User& Aws::QuickSight::Model::User::WithCustomPermissionsName ( Aws::String &&  value)
inline

The custom permissions profile associated with this user.

Definition at line 378 of file User.h.

◆ WithCustomPermissionsName() [3/3]

User& Aws::QuickSight::Model::User::WithCustomPermissionsName ( const char *  value)
inline

The custom permissions profile associated with this user.

Definition at line 383 of file User.h.

◆ WithEmail() [1/3]

User& Aws::QuickSight::Model::User::WithEmail ( const Aws::String value)
inline

The user's email address.

Definition at line 152 of file User.h.

◆ WithEmail() [2/3]

User& Aws::QuickSight::Model::User::WithEmail ( Aws::String &&  value)
inline

The user's email address.

Definition at line 157 of file User.h.

◆ WithEmail() [3/3]

User& Aws::QuickSight::Model::User::WithEmail ( const char *  value)
inline

The user's email address.

Definition at line 162 of file User.h.

◆ WithIdentityType() [1/2]

User& Aws::QuickSight::Model::User::WithIdentityType ( const IdentityType value)
inline

The type of identity authentication used by the user.

Definition at line 267 of file User.h.

◆ WithIdentityType() [2/2]

User& Aws::QuickSight::Model::User::WithIdentityType ( IdentityType &&  value)
inline

The type of identity authentication used by the user.

Definition at line 272 of file User.h.

◆ WithPrincipalId() [1/3]

User& Aws::QuickSight::Model::User::WithPrincipalId ( const Aws::String value)
inline

The principal ID of the user.

Definition at line 332 of file User.h.

◆ WithPrincipalId() [2/3]

User& Aws::QuickSight::Model::User::WithPrincipalId ( Aws::String &&  value)
inline

The principal ID of the user.

Definition at line 337 of file User.h.

◆ WithPrincipalId() [3/3]

User& Aws::QuickSight::Model::User::WithPrincipalId ( const char *  value)
inline

The principal ID of the user.

Definition at line 342 of file User.h.

◆ WithRole() [1/2]

User& Aws::QuickSight::Model::User::WithRole ( const UserRole value)
inline

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.

Definition at line 228 of file User.h.

◆ WithRole() [2/2]

User& Aws::QuickSight::Model::User::WithRole ( UserRole &&  value)
inline

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.

Definition at line 241 of file User.h.

◆ WithUserName() [1/3]

User& Aws::QuickSight::Model::User::WithUserName ( const Aws::String value)
inline

The user's user name.

Definition at line 111 of file User.h.

◆ WithUserName() [2/3]

User& Aws::QuickSight::Model::User::WithUserName ( Aws::String &&  value)
inline

The user's user name.

Definition at line 116 of file User.h.

◆ WithUserName() [3/3]

User& Aws::QuickSight::Model::User::WithUserName ( const char *  value)
inline

The user's user name.

Definition at line 121 of file User.h.


The documentation for this class was generated from the following file: