AWS SDK for C++  1.9.130
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)
 
const Aws::StringGetExternalLoginFederationProviderType () const
 
bool ExternalLoginFederationProviderTypeHasBeenSet () const
 
void SetExternalLoginFederationProviderType (const Aws::String &value)
 
void SetExternalLoginFederationProviderType (Aws::String &&value)
 
void SetExternalLoginFederationProviderType (const char *value)
 
UpdateUserRequestWithExternalLoginFederationProviderType (const Aws::String &value)
 
UpdateUserRequestWithExternalLoginFederationProviderType (Aws::String &&value)
 
UpdateUserRequestWithExternalLoginFederationProviderType (const char *value)
 
const Aws::StringGetCustomFederationProviderUrl () const
 
bool CustomFederationProviderUrlHasBeenSet () const
 
void SetCustomFederationProviderUrl (const Aws::String &value)
 
void SetCustomFederationProviderUrl (Aws::String &&value)
 
void SetCustomFederationProviderUrl (const char *value)
 
UpdateUserRequestWithCustomFederationProviderUrl (const Aws::String &value)
 
UpdateUserRequestWithCustomFederationProviderUrl (Aws::String &&value)
 
UpdateUserRequestWithCustomFederationProviderUrl (const char *value)
 
const Aws::StringGetExternalLoginId () const
 
bool ExternalLoginIdHasBeenSet () const
 
void SetExternalLoginId (const Aws::String &value)
 
void SetExternalLoginId (Aws::String &&value)
 
void SetExternalLoginId (const char *value)
 
UpdateUserRequestWithExternalLoginId (const Aws::String &value)
 
UpdateUserRequestWithExternalLoginId (Aws::String &&value)
 
UpdateUserRequestWithExternalLoginId (const char *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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Definition at line 89 of file UpdateUserRequest.h.

◆ CustomFederationProviderUrlHasBeenSet()

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 636 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 325 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 183 of file UpdateUserRequest.h.

◆ ExternalLoginFederationProviderTypeHasBeenSet()

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 509 of file UpdateUserRequest.h.

◆ ExternalLoginIdHasBeenSet()

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

The identity ID for a user in the external login provider.

Definition at line 701 of file UpdateUserRequest.h.

◆ GetAwsAccountId()

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

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

Definition at line 82 of file UpdateUserRequest.h.

◆ GetCustomFederationProviderUrl()

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 627 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 306 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 178 of file UpdateUserRequest.h.

◆ GetExternalLoginFederationProviderType()

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 491 of file UpdateUserRequest.h.

◆ GetExternalLoginId()

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

The identity ID for a user in the external login provider.

Definition at line 696 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 137 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 226 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 448 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 142 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 238 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 ( Aws::String &&  value)
inline

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

Definition at line 103 of file UpdateUserRequest.h.

◆ SetAwsAccountId() [2/3]

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

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

Definition at line 96 of file UpdateUserRequest.h.

◆ SetAwsAccountId() [3/3]

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

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

Definition at line 110 of file UpdateUserRequest.h.

◆ SetCustomFederationProviderUrl() [1/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 654 of file UpdateUserRequest.h.

◆ SetCustomFederationProviderUrl() [2/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 645 of file UpdateUserRequest.h.

◆ SetCustomFederationProviderUrl() [3/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 663 of file UpdateUserRequest.h.

◆ SetCustomPermissionsName() [1/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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 363 of file UpdateUserRequest.h.

◆ SetCustomPermissionsName() [2/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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 344 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 382 of file UpdateUserRequest.h.

◆ SetEmail() [1/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 193 of file UpdateUserRequest.h.

◆ SetEmail() [2/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 188 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 198 of file UpdateUserRequest.h.

◆ SetExternalLoginFederationProviderType() [1/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 545 of file UpdateUserRequest.h.

◆ SetExternalLoginFederationProviderType() [2/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 527 of file UpdateUserRequest.h.

◆ SetExternalLoginFederationProviderType() [3/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 563 of file UpdateUserRequest.h.

◆ SetExternalLoginId() [1/3]

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

The identity ID for a user in the external login provider.

Definition at line 711 of file UpdateUserRequest.h.

◆ SetExternalLoginId() [2/3]

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

The identity ID for a user in the external login provider.

Definition at line 706 of file UpdateUserRequest.h.

◆ SetExternalLoginId() [3/3]

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

The identity ID for a user in the external login provider.

Definition at line 716 of file UpdateUserRequest.h.

◆ SetNamespace() [1/3]

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

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

Definition at line 152 of file UpdateUserRequest.h.

◆ SetNamespace() [2/3]

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

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

Definition at line 147 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 157 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 250 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 262 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 464 of file UpdateUserRequest.h.

◆ SetUserName() [1/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() [2/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() [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 456 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 ( Aws::String &&  value)
inline

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

Definition at line 124 of file UpdateUserRequest.h.

◆ WithAwsAccountId() [2/3]

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

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Definition at line 131 of file UpdateUserRequest.h.

◆ WithCustomFederationProviderUrl() [1/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 681 of file UpdateUserRequest.h.

◆ WithCustomFederationProviderUrl() [2/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 672 of file UpdateUserRequest.h.

◆ WithCustomFederationProviderUrl() [3/3]

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Definition at line 690 of file UpdateUserRequest.h.

◆ WithCustomPermissionsName() [1/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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 420 of file UpdateUserRequest.h.

◆ WithCustomPermissionsName() [2/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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 401 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Definition at line 439 of file UpdateUserRequest.h.

◆ WithEmail() [1/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 208 of file UpdateUserRequest.h.

◆ WithEmail() [2/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 203 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 213 of file UpdateUserRequest.h.

◆ WithExternalLoginFederationProviderType() [1/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 599 of file UpdateUserRequest.h.

◆ WithExternalLoginFederationProviderType() [2/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 581 of file UpdateUserRequest.h.

◆ WithExternalLoginFederationProviderType() [3/3]

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

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

Definition at line 617 of file UpdateUserRequest.h.

◆ WithExternalLoginId() [1/3]

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

The identity ID for a user in the external login provider.

Definition at line 726 of file UpdateUserRequest.h.

◆ WithExternalLoginId() [2/3]

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

The identity ID for a user in the external login provider.

Definition at line 721 of file UpdateUserRequest.h.

◆ WithExternalLoginId() [3/3]

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

The identity ID for a user in the external login provider.

Definition at line 731 of file UpdateUserRequest.h.

◆ WithNamespace() [1/3]

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

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

Definition at line 167 of file UpdateUserRequest.h.

◆ WithNamespace() [2/3]

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

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

Definition at line 162 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 172 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 274 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Definition at line 286 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 472 of file UpdateUserRequest.h.

◆ WithUserName() [1/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() [2/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() [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: