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

#include <UpdateUserRequest.h>

+ Inheritance diagram for Aws::QuickSight::Model::UpdateUserRequest:

Public Member Functions

 UpdateUserRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
UpdateUserRequestWithUserName (const Aws::String &value)
 
UpdateUserRequestWithUserName (Aws::String &&value)
 
UpdateUserRequestWithUserName (const char *value)
 
const Aws::StringGetAwsAccountId () const
 
bool AwsAccountIdHasBeenSet () const
 
void SetAwsAccountId (const Aws::String &value)
 
void SetAwsAccountId (Aws::String &&value)
 
void SetAwsAccountId (const char *value)
 
UpdateUserRequestWithAwsAccountId (const Aws::String &value)
 
UpdateUserRequestWithAwsAccountId (Aws::String &&value)
 
UpdateUserRequestWithAwsAccountId (const char *value)
 
const Aws::StringGetNamespace () const
 
bool NamespaceHasBeenSet () const
 
void SetNamespace (const Aws::String &value)
 
void SetNamespace (Aws::String &&value)
 
void SetNamespace (const char *value)
 
UpdateUserRequestWithNamespace (const Aws::String &value)
 
UpdateUserRequestWithNamespace (Aws::String &&value)
 
UpdateUserRequestWithNamespace (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)
 
UpdateUserRequestWithEmail (const Aws::String &value)
 
UpdateUserRequestWithEmail (Aws::String &&value)
 
UpdateUserRequestWithEmail (const char *value)
 
const UserRoleGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const UserRole &value)
 
void SetRole (UserRole &&value)
 
UpdateUserRequestWithRole (const UserRole &value)
 
UpdateUserRequestWithRole (UserRole &&value)
 
const Aws::StringGetCustomPermissionsName () const
 
bool CustomPermissionsNameHasBeenSet () const
 
void SetCustomPermissionsName (const Aws::String &value)
 
void SetCustomPermissionsName (Aws::String &&value)
 
void SetCustomPermissionsName (const char *value)
 
UpdateUserRequestWithCustomPermissionsName (const Aws::String &value)
 
UpdateUserRequestWithCustomPermissionsName (Aws::String &&value)
 
UpdateUserRequestWithCustomPermissionsName (const char *value)
 
bool GetUnapplyCustomPermissions () const
 
bool UnapplyCustomPermissionsHasBeenSet () const
 
void SetUnapplyCustomPermissions (bool value)
 
UpdateUserRequestWithUnapplyCustomPermissions (bool value)
 
- Public Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual ~QuickSightRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file UpdateUserRequest.h.

Constructor & Destructor Documentation

◆ UpdateUserRequest()

Aws::QuickSight::Model::UpdateUserRequest::UpdateUserRequest ( )

Member Function Documentation

◆ AwsAccountIdHasBeenSet()

bool Aws::QuickSight::Model::UpdateUserRequest::AwsAccountIdHasBeenSet ( ) const
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 87 of file UpdateUserRequest.h.

◆ CustomPermissionsNameHasBeenSet()

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 317 of file UpdateUserRequest.h.

◆ EmailHasBeenSet()

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

The email address of the user that you want to update.

Definition at line 175 of file UpdateUserRequest.h.

◆ GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::UpdateUserRequest::GetAwsAccountId ( ) const
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 81 of file UpdateUserRequest.h.

◆ GetCustomPermissionsName()

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 298 of file UpdateUserRequest.h.

◆ GetEmail()

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

The email address of the user that you want to update.

Definition at line 170 of file UpdateUserRequest.h.

◆ GetNamespace()

const Aws::String& Aws::QuickSight::Model::UpdateUserRequest::GetNamespace ( ) const
inline

The namespace. Currently, you should set this to default.

Definition at line 129 of file UpdateUserRequest.h.

◆ GetRole()

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 218 of file UpdateUserRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::QuickSight::Model::UpdateUserRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file UpdateUserRequest.h.

◆ GetUnapplyCustomPermissions()

bool Aws::QuickSight::Model::UpdateUserRequest::GetUnapplyCustomPermissions ( ) const
inline

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Definition at line 440 of file UpdateUserRequest.h.

◆ GetUserName()

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

The Amazon QuickSight user name that you want to update.

Definition at line 39 of file UpdateUserRequest.h.

◆ NamespaceHasBeenSet()

bool Aws::QuickSight::Model::UpdateUserRequest::NamespaceHasBeenSet ( ) const
inline

The namespace. Currently, you should set this to default.

Definition at line 134 of file UpdateUserRequest.h.

◆ RoleHasBeenSet()

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 230 of file UpdateUserRequest.h.

◆ SerializePayload()

Aws::String Aws::QuickSight::Model::UpdateUserRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetAwsAccountId ( const Aws::String value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 93 of file UpdateUserRequest.h.

◆ SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetAwsAccountId ( Aws::String &&  value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 99 of file UpdateUserRequest.h.

◆ SetAwsAccountId() [3/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetAwsAccountId ( const char *  value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 105 of file UpdateUserRequest.h.

◆ SetCustomPermissionsName() [1/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 336 of file UpdateUserRequest.h.

◆ SetCustomPermissionsName() [2/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 355 of file UpdateUserRequest.h.

◆ SetCustomPermissionsName() [3/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 374 of file UpdateUserRequest.h.

◆ SetEmail() [1/3]

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

The email address of the user that you want to update.

Definition at line 180 of file UpdateUserRequest.h.

◆ SetEmail() [2/3]

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

The email address of the user that you want to update.

Definition at line 185 of file UpdateUserRequest.h.

◆ SetEmail() [3/3]

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

The email address of the user that you want to update.

Definition at line 190 of file UpdateUserRequest.h.

◆ SetNamespace() [1/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetNamespace ( const Aws::String value)
inline

The namespace. Currently, you should set this to default.

Definition at line 139 of file UpdateUserRequest.h.

◆ SetNamespace() [2/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetNamespace ( Aws::String &&  value)
inline

The namespace. Currently, you should set this to default.

Definition at line 144 of file UpdateUserRequest.h.

◆ SetNamespace() [3/3]

void Aws::QuickSight::Model::UpdateUserRequest::SetNamespace ( const char *  value)
inline

The namespace. Currently, you should set this to default.

Definition at line 149 of file UpdateUserRequest.h.

◆ SetRole() [1/2]

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 242 of file UpdateUserRequest.h.

◆ SetRole() [2/2]

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 254 of file UpdateUserRequest.h.

◆ SetUnapplyCustomPermissions()

void Aws::QuickSight::Model::UpdateUserRequest::SetUnapplyCustomPermissions ( bool  value)
inline

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Definition at line 456 of file UpdateUserRequest.h.

◆ SetUserName() [1/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 49 of file UpdateUserRequest.h.

◆ SetUserName() [2/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 54 of file UpdateUserRequest.h.

◆ SetUserName() [3/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 59 of file UpdateUserRequest.h.

◆ UnapplyCustomPermissionsHasBeenSet()

bool Aws::QuickSight::Model::UpdateUserRequest::UnapplyCustomPermissionsHasBeenSet ( ) const
inline

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Definition at line 448 of file UpdateUserRequest.h.

◆ UserNameHasBeenSet()

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

The Amazon QuickSight user name that you want to update.

Definition at line 44 of file UpdateUserRequest.h.

◆ WithAwsAccountId() [1/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithAwsAccountId ( const Aws::String value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 111 of file UpdateUserRequest.h.

◆ WithAwsAccountId() [2/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithAwsAccountId ( Aws::String &&  value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 117 of file UpdateUserRequest.h.

◆ WithAwsAccountId() [3/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithAwsAccountId ( const char *  value)
inline

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Definition at line 123 of file UpdateUserRequest.h.

◆ WithCustomPermissionsName() [1/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 393 of file UpdateUserRequest.h.

◆ WithCustomPermissionsName() [2/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 412 of file UpdateUserRequest.h.

◆ WithCustomPermissionsName() [3/3]

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

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).

This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Definition at line 431 of file UpdateUserRequest.h.

◆ WithEmail() [1/3]

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

The email address of the user that you want to update.

Definition at line 195 of file UpdateUserRequest.h.

◆ WithEmail() [2/3]

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

The email address of the user that you want to update.

Definition at line 200 of file UpdateUserRequest.h.

◆ WithEmail() [3/3]

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

The email address of the user that you want to update.

Definition at line 205 of file UpdateUserRequest.h.

◆ WithNamespace() [1/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithNamespace ( const Aws::String value)
inline

The namespace. Currently, you should set this to default.

Definition at line 154 of file UpdateUserRequest.h.

◆ WithNamespace() [2/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithNamespace ( Aws::String &&  value)
inline

The namespace. Currently, you should set this to default.

Definition at line 159 of file UpdateUserRequest.h.

◆ WithNamespace() [3/3]

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithNamespace ( const char *  value)
inline

The namespace. Currently, you should set this to default.

Definition at line 164 of file UpdateUserRequest.h.

◆ WithRole() [1/2]

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 266 of file UpdateUserRequest.h.

◆ WithRole() [2/2]

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

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

  • 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.

The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 278 of file UpdateUserRequest.h.

◆ WithUnapplyCustomPermissions()

UpdateUserRequest& Aws::QuickSight::Model::UpdateUserRequest::WithUnapplyCustomPermissions ( bool  value)
inline

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Definition at line 464 of file UpdateUserRequest.h.

◆ WithUserName() [1/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 64 of file UpdateUserRequest.h.

◆ WithUserName() [2/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 69 of file UpdateUserRequest.h.

◆ WithUserName() [3/3]

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

The Amazon QuickSight user name that you want to update.

Definition at line 74 of file UpdateUserRequest.h.


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