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

#include <RegisterUserRequest.h>

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

Public Member Functions

 RegisterUserRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const IdentityTypeGetIdentityType () const
 
bool IdentityTypeHasBeenSet () const
 
void SetIdentityType (const IdentityType &value)
 
void SetIdentityType (IdentityType &&value)
 
RegisterUserRequestWithIdentityType (const IdentityType &value)
 
RegisterUserRequestWithIdentityType (IdentityType &&value)
 
const Aws::StringGetEmail () const
 
bool EmailHasBeenSet () const
 
void SetEmail (const Aws::String &value)
 
void SetEmail (Aws::String &&value)
 
void SetEmail (const char *value)
 
RegisterUserRequestWithEmail (const Aws::String &value)
 
RegisterUserRequestWithEmail (Aws::String &&value)
 
RegisterUserRequestWithEmail (const char *value)
 
const UserRoleGetUserRole () const
 
bool UserRoleHasBeenSet () const
 
void SetUserRole (const UserRole &value)
 
void SetUserRole (UserRole &&value)
 
RegisterUserRequestWithUserRole (const UserRole &value)
 
RegisterUserRequestWithUserRole (UserRole &&value)
 
const Aws::StringGetIamArn () const
 
bool IamArnHasBeenSet () const
 
void SetIamArn (const Aws::String &value)
 
void SetIamArn (Aws::String &&value)
 
void SetIamArn (const char *value)
 
RegisterUserRequestWithIamArn (const Aws::String &value)
 
RegisterUserRequestWithIamArn (Aws::String &&value)
 
RegisterUserRequestWithIamArn (const char *value)
 
const Aws::StringGetSessionName () const
 
bool SessionNameHasBeenSet () const
 
void SetSessionName (const Aws::String &value)
 
void SetSessionName (Aws::String &&value)
 
void SetSessionName (const char *value)
 
RegisterUserRequestWithSessionName (const Aws::String &value)
 
RegisterUserRequestWithSessionName (Aws::String &&value)
 
RegisterUserRequestWithSessionName (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)
 
RegisterUserRequestWithAwsAccountId (const Aws::String &value)
 
RegisterUserRequestWithAwsAccountId (Aws::String &&value)
 
RegisterUserRequestWithAwsAccountId (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)
 
RegisterUserRequestWithNamespace (const Aws::String &value)
 
RegisterUserRequestWithNamespace (Aws::String &&value)
 
RegisterUserRequestWithNamespace (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)
 
RegisterUserRequestWithUserName (const Aws::String &value)
 
RegisterUserRequestWithUserName (Aws::String &&value)
 
RegisterUserRequestWithUserName (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)
 
RegisterUserRequestWithCustomPermissionsName (const Aws::String &value)
 
RegisterUserRequestWithCustomPermissionsName (Aws::String &&value)
 
RegisterUserRequestWithCustomPermissionsName (const char *value)
 
const Aws::StringGetExternalLoginFederationProviderType () const
 
bool ExternalLoginFederationProviderTypeHasBeenSet () const
 
void SetExternalLoginFederationProviderType (const Aws::String &value)
 
void SetExternalLoginFederationProviderType (Aws::String &&value)
 
void SetExternalLoginFederationProviderType (const char *value)
 
RegisterUserRequestWithExternalLoginFederationProviderType (const Aws::String &value)
 
RegisterUserRequestWithExternalLoginFederationProviderType (Aws::String &&value)
 
RegisterUserRequestWithExternalLoginFederationProviderType (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)
 
RegisterUserRequestWithCustomFederationProviderUrl (const Aws::String &value)
 
RegisterUserRequestWithCustomFederationProviderUrl (Aws::String &&value)
 
RegisterUserRequestWithCustomFederationProviderUrl (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)
 
RegisterUserRequestWithExternalLoginId (const Aws::String &value)
 
RegisterUserRequestWithExternalLoginId (Aws::String &&value)
 
RegisterUserRequestWithExternalLoginId (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 23 of file RegisterUserRequest.h.

Constructor & Destructor Documentation

◆ RegisterUserRequest()

Aws::QuickSight::Model::RegisterUserRequest::RegisterUserRequest ( )

Member Function Documentation

◆ AwsAccountIdHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::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 370 of file RegisterUserRequest.h.

◆ CustomFederationProviderUrlHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::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 803 of file RegisterUserRequest.h.

◆ CustomPermissionsNameHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 543 of file RegisterUserRequest.h.

◆ EmailHasBeenSet()

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

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

Definition at line 100 of file RegisterUserRequest.h.

◆ ExternalLoginFederationProviderTypeHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 694 of file RegisterUserRequest.h.

◆ ExternalLoginIdHasBeenSet()

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

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

Definition at line 868 of file RegisterUserRequest.h.

◆ GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::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 363 of file RegisterUserRequest.h.

◆ GetCustomFederationProviderUrl()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::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 794 of file RegisterUserRequest.h.

◆ GetCustomPermissionsName()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 523 of file RegisterUserRequest.h.

◆ GetEmail()

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

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

Definition at line 95 of file RegisterUserRequest.h.

◆ GetExternalLoginFederationProviderType()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 679 of file RegisterUserRequest.h.

◆ GetExternalLoginId()

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

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

Definition at line 863 of file RegisterUserRequest.h.

◆ GetIamArn()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::GetIamArn ( ) const
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 216 of file RegisterUserRequest.h.

◆ GetIdentityType()

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 44 of file RegisterUserRequest.h.

◆ GetNamespace()

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

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

Definition at line 418 of file RegisterUserRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file RegisterUserRequest.h.

◆ GetSessionName()

const Aws::String& Aws::QuickSight::Model::RegisterUserRequest::GetSessionName ( ) const
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 271 of file RegisterUserRequest.h.

◆ GetUserName()

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 460 of file RegisterUserRequest.h.

◆ GetUserRole()

const UserRole& Aws::QuickSight::Model::RegisterUserRequest::GetUserRole ( ) 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 144 of file RegisterUserRequest.h.

◆ IamArnHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::IamArnHasBeenSet ( ) const
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 222 of file RegisterUserRequest.h.

◆ IdentityTypeHasBeenSet()

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 53 of file RegisterUserRequest.h.

◆ NamespaceHasBeenSet()

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

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

Definition at line 423 of file RegisterUserRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionNameHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::SessionNameHasBeenSet ( ) const
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 283 of file RegisterUserRequest.h.

◆ SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 384 of file RegisterUserRequest.h.

◆ SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 377 of file RegisterUserRequest.h.

◆ SetAwsAccountId() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 391 of file RegisterUserRequest.h.

◆ SetCustomFederationProviderUrl() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 821 of file RegisterUserRequest.h.

◆ SetCustomFederationProviderUrl() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 812 of file RegisterUserRequest.h.

◆ SetCustomFederationProviderUrl() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::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 830 of file RegisterUserRequest.h.

◆ SetCustomPermissionsName() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 583 of file RegisterUserRequest.h.

◆ SetCustomPermissionsName() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 563 of file RegisterUserRequest.h.

◆ SetCustomPermissionsName() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 603 of file RegisterUserRequest.h.

◆ SetEmail() [1/3]

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

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

Definition at line 110 of file RegisterUserRequest.h.

◆ SetEmail() [2/3]

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

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

Definition at line 105 of file RegisterUserRequest.h.

◆ SetEmail() [3/3]

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

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

Definition at line 115 of file RegisterUserRequest.h.

◆ SetExternalLoginFederationProviderType() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 724 of file RegisterUserRequest.h.

◆ SetExternalLoginFederationProviderType() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 709 of file RegisterUserRequest.h.

◆ SetExternalLoginFederationProviderType() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 739 of file RegisterUserRequest.h.

◆ SetExternalLoginId() [1/3]

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

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

Definition at line 878 of file RegisterUserRequest.h.

◆ SetExternalLoginId() [2/3]

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

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

Definition at line 873 of file RegisterUserRequest.h.

◆ SetExternalLoginId() [3/3]

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

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

Definition at line 883 of file RegisterUserRequest.h.

◆ SetIamArn() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetIamArn ( Aws::String &&  value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 234 of file RegisterUserRequest.h.

◆ SetIamArn() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetIamArn ( const Aws::String value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 228 of file RegisterUserRequest.h.

◆ SetIamArn() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetIamArn ( const char *  value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 240 of file RegisterUserRequest.h.

◆ SetIdentityType() [1/2]

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 62 of file RegisterUserRequest.h.

◆ SetIdentityType() [2/2]

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 71 of file RegisterUserRequest.h.

◆ SetNamespace() [1/3]

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

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

Definition at line 433 of file RegisterUserRequest.h.

◆ SetNamespace() [2/3]

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

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

Definition at line 428 of file RegisterUserRequest.h.

◆ SetNamespace() [3/3]

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

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

Definition at line 438 of file RegisterUserRequest.h.

◆ SetSessionName() [1/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetSessionName ( Aws::String &&  value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 307 of file RegisterUserRequest.h.

◆ SetSessionName() [2/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetSessionName ( const Aws::String value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 295 of file RegisterUserRequest.h.

◆ SetSessionName() [3/3]

void Aws::QuickSight::Model::RegisterUserRequest::SetSessionName ( const char *  value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 319 of file RegisterUserRequest.h.

◆ SetUserName() [1/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 478 of file RegisterUserRequest.h.

◆ SetUserName() [2/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 472 of file RegisterUserRequest.h.

◆ SetUserName() [3/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 484 of file RegisterUserRequest.h.

◆ SetUserRole() [1/2]

void Aws::QuickSight::Model::RegisterUserRequest::SetUserRole ( 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 170 of file RegisterUserRequest.h.

◆ SetUserRole() [2/2]

void Aws::QuickSight::Model::RegisterUserRequest::SetUserRole ( 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 183 of file RegisterUserRequest.h.

◆ UserNameHasBeenSet()

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 466 of file RegisterUserRequest.h.

◆ UserRoleHasBeenSet()

bool Aws::QuickSight::Model::RegisterUserRequest::UserRoleHasBeenSet ( ) 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 157 of file RegisterUserRequest.h.

◆ WithAwsAccountId() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 405 of file RegisterUserRequest.h.

◆ WithAwsAccountId() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 398 of file RegisterUserRequest.h.

◆ WithAwsAccountId() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 412 of file RegisterUserRequest.h.

◆ WithCustomFederationProviderUrl() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 848 of file RegisterUserRequest.h.

◆ WithCustomFederationProviderUrl() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 839 of file RegisterUserRequest.h.

◆ WithCustomFederationProviderUrl() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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 857 of file RegisterUserRequest.h.

◆ WithCustomPermissionsName() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 643 of file RegisterUserRequest.h.

◆ WithCustomPermissionsName() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 623 of file RegisterUserRequest.h.

◆ WithCustomPermissionsName() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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

To add custom permissions to an existing user, use UpdateUser instead.

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 663 of file RegisterUserRequest.h.

◆ WithEmail() [1/3]

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

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

Definition at line 125 of file RegisterUserRequest.h.

◆ WithEmail() [2/3]

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

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

Definition at line 120 of file RegisterUserRequest.h.

◆ WithEmail() [3/3]

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

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

Definition at line 130 of file RegisterUserRequest.h.

◆ WithExternalLoginFederationProviderType() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 769 of file RegisterUserRequest.h.

◆ WithExternalLoginFederationProviderType() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 754 of file RegisterUserRequest.h.

◆ WithExternalLoginFederationProviderType() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::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.

Definition at line 784 of file RegisterUserRequest.h.

◆ WithExternalLoginId() [1/3]

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

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

Definition at line 893 of file RegisterUserRequest.h.

◆ WithExternalLoginId() [2/3]

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

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

Definition at line 888 of file RegisterUserRequest.h.

◆ WithExternalLoginId() [3/3]

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

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

Definition at line 898 of file RegisterUserRequest.h.

◆ WithIamArn() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithIamArn ( Aws::String &&  value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 252 of file RegisterUserRequest.h.

◆ WithIamArn() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithIamArn ( const Aws::String value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 246 of file RegisterUserRequest.h.

◆ WithIamArn() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithIamArn ( const char *  value)
inline

The ARN of the IAMuser or role that you are registering with Amazon QuickSight.

Definition at line 258 of file RegisterUserRequest.h.

◆ WithIdentityType() [1/2]

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 80 of file RegisterUserRequest.h.

◆ WithIdentityType() [2/2]

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

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAMuser or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Definition at line 89 of file RegisterUserRequest.h.

◆ WithNamespace() [1/3]

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

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

Definition at line 448 of file RegisterUserRequest.h.

◆ WithNamespace() [2/3]

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

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

Definition at line 443 of file RegisterUserRequest.h.

◆ WithNamespace() [3/3]

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

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

Definition at line 453 of file RegisterUserRequest.h.

◆ WithSessionName() [1/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithSessionName ( Aws::String &&  value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 343 of file RegisterUserRequest.h.

◆ WithSessionName() [2/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithSessionName ( const Aws::String value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 331 of file RegisterUserRequest.h.

◆ WithSessionName() [3/3]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithSessionName ( const char *  value)
inline

You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

Definition at line 355 of file RegisterUserRequest.h.

◆ WithUserName() [1/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 496 of file RegisterUserRequest.h.

◆ WithUserName() [2/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 490 of file RegisterUserRequest.h.

◆ WithUserName() [3/3]

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

The Amazon QuickSight user name that you want to create for the user you are registering.

Definition at line 502 of file RegisterUserRequest.h.

◆ WithUserRole() [1/2]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithUserRole ( 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 196 of file RegisterUserRequest.h.

◆ WithUserRole() [2/2]

RegisterUserRequest& Aws::QuickSight::Model::RegisterUserRequest::WithUserRole ( 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 209 of file RegisterUserRequest.h.


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