Interface UpdateUserRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateUserRequest.Builder,
,UpdateUserRequest> QuickSightRequest.Builder
,SdkBuilder<UpdateUserRequest.Builder,
,UpdateUserRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateUserRequest
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) The ID for the Amazon Web Services account that the user is in.customFederationProviderUrl
(String customFederationProviderUrl) 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.customPermissionsName
(String customPermissionsName) (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.The email address of the user that you want to update.externalLoginFederationProviderType
(String externalLoginFederationProviderType) 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.externalLoginId
(String externalLoginId) The identity ID for a user in the external login provider.The namespace.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon QuickSight role of the user.The Amazon QuickSight role of the user.unapplyCustomPermissions
(Boolean unapplyCustomPermissions) A flag that you use to indicate that you want to remove all custom permissions from this user.The Amazon QuickSight user name that you want to update.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
userName
The Amazon QuickSight user name that you want to update.
- Parameters:
userName
- The Amazon QuickSight user name that you want to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsAccountId
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.
- Parameters:
awsAccountId
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespace
The namespace. Currently, you should set this to
default
.- Parameters:
namespace
- The namespace. Currently, you should set this todefault
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
email
The email address of the user that you want to update.
- Parameters:
email
- The email address of the user that you want to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
role
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. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
- Parameters:
role
- 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. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
role
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. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
- Parameters:
role
- 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. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
customPermissionsName
(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 IAM policies. 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.
- Parameters:
customPermissionsName
- (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 IAM policies. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
unapplyCustomPermissions
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.
- Parameters:
unapplyCustomPermissions
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalLoginFederationProviderType
UpdateUserRequest.Builder externalLoginFederationProviderType(String externalLoginFederationProviderType) 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 theCOGNITO
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 choosingCUSTOM_OIDC
type, use theCustomFederationProviderUrl
parameter to provide the custom OIDC provider URL. -
NONE
: This clears all the previously saved external login information for a user. Use theDescribeUser
API operation to check the external login information.
- Parameters:
externalLoginFederationProviderType
- 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 theCOGNITO
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 choosingCUSTOM_OIDC
type, use theCustomFederationProviderUrl
parameter to provide the custom OIDC provider URL. -
NONE
: This clears all the previously saved external login information for a user. Use theDescribeUser
API operation to check the external login information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
customFederationProviderUrl
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 toCUSTOM_OIDC
.- Parameters:
customFederationProviderUrl
- 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 whenExternalLoginFederationProviderType
parameter is set toCUSTOM_OIDC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalLoginId
The identity ID for a user in the external login provider.
- Parameters:
externalLoginId
- The identity ID for a user in the external login provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-