software.amazon.awssdk.services.quicksight.model

Interface UpdateUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, QuickSightRequest.Builder, SdkBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateUserRequest

public static interface UpdateUserRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Method Summary

Modifier and Type	Method and Description
UpdateUserRequest.Builder	awsAccountId(String awsAccountId) The ID for the AWS account that the user is in.
UpdateUserRequest.Builder	customPermissionsName(String customPermissionsName) (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
UpdateUserRequest.Builder	email(String email) The email address of the user that you want to update.
UpdateUserRequest.Builder	namespace(String namespace) The namespace.
UpdateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateUserRequest.Builder	role(String role) The Amazon QuickSight role of the user.
UpdateUserRequest.Builder	role(UserRole role) The Amazon QuickSight role of the user.
UpdateUserRequest.Builder	unapplyCustomPermissions(Boolean unapplyCustomPermissions) A flag that you use to indicate that you want to remove all custom permissions from this user.
UpdateUserRequest.Builder	userName(String userName) The Amazon QuickSight user name that you want to update.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

userName

UpdateUserRequest.Builder userName(String 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

UpdateUserRequest.Builder awsAccountId(String awsAccountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

namespace

UpdateUserRequest.Builder namespace(String namespace)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

email

UpdateUserRequest.Builder email(String 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

UpdateUserRequest.Builder role(String 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.

The name of the 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.

The name of the 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:

UserRole, UserRole

role

UpdateUserRequest.Builder role(UserRole 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.

The name of the 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.

The name of the 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:

UserRole, UserRole

customPermissionsName

UpdateUserRequest.Builder customPermissionsName(String 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 QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.

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

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

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

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

unapplyCustomPermissions

UpdateUserRequest.Builder unapplyCustomPermissions(Boolean 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.

overrideConfiguration

UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder