com.amazonaws.services.quicksight.model

Class UpdateUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.UpdateUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateUserRequest()

Method Summary

Modifier and Type	Method and Description
UpdateUserRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID for the AWS account that the user is in.
String	getCustomPermissionsName() (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
String	getEmail() The email address of the user that you want to update.
String	getNamespace() The namespace.
String	getRole() The Amazon QuickSight role of the user.
Boolean	getUnapplyCustomPermissions() A flag that you use to indicate that you want to remove all custom permissions from this user.
String	getUserName() The Amazon QuickSight user name that you want to update.
int	hashCode()
Boolean	isUnapplyCustomPermissions() A flag that you use to indicate that you want to remove all custom permissions from this user.
void	setAwsAccountId(String awsAccountId) The ID for the AWS account that the user is in.
void	setCustomPermissionsName(String customPermissionsName) (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
void	setEmail(String email) The email address of the user that you want to update.
void	setNamespace(String namespace) The namespace.
void	setRole(String role) The Amazon QuickSight role of the user.
void	setUnapplyCustomPermissions(Boolean unapplyCustomPermissions) A flag that you use to indicate that you want to remove all custom permissions from this user.
void	setUserName(String userName) The Amazon QuickSight user name that you want to update.
String	toString() Returns a string representation of this object.
UpdateUserRequest	withAwsAccountId(String awsAccountId) The ID for the AWS account that the user is in.
UpdateUserRequest	withCustomPermissionsName(String customPermissionsName) (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
UpdateUserRequest	withEmail(String email) The email address of the user that you want to update.
UpdateUserRequest	withNamespace(String namespace) The namespace.
UpdateUserRequest	withRole(String role) The Amazon QuickSight role of the user.
UpdateUserRequest	withRole(UserRole role) The Amazon QuickSight role of the user.
UpdateUserRequest	withUnapplyCustomPermissions(Boolean unapplyCustomPermissions) A flag that you use to indicate that you want to remove all custom permissions from this user.
UpdateUserRequest	withUserName(String userName) The Amazon QuickSight user name that you want to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateUserRequest

public UpdateUserRequest()

Method Detail

setUserName

public void setUserName(String userName)

The Amazon QuickSight user name that you want to update.

Parameters:

userName - The Amazon QuickSight user name that you want to update.

getUserName

public String getUserName()

The Amazon QuickSight user name that you want to update.

Returns:

The Amazon QuickSight user name that you want to update.

withUserName

public UpdateUserRequest withUserName(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.

setAwsAccountId

public void setAwsAccountId(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.

getAwsAccountId

public String getAwsAccountId()

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:

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.

withAwsAccountId

public UpdateUserRequest withAwsAccountId(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.

setNamespace

public void setNamespace(String namespace)

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

Parameters:

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

getNamespace

public String getNamespace()

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

Returns:

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

withNamespace

public UpdateUserRequest withNamespace(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.

setEmail

public void setEmail(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.

getEmail

public String getEmail()

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

Returns:

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

withEmail

public UpdateUserRequest withEmail(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.

setRole

public void setRole(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.

See Also:

UserRole

getRole

public String getRole()

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:

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.

See Also:

UserRole

withRole

public UpdateUserRequest withRole(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

withRole

public UpdateUserRequest withRole(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

setCustomPermissionsName

public void setCustomPermissionsName(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).

getCustomPermissionsName

public String getCustomPermissionsName()

(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:

(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).

withCustomPermissionsName

public UpdateUserRequest withCustomPermissionsName(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.

setUnapplyCustomPermissions

public void setUnapplyCustomPermissions(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.

getUnapplyCustomPermissions

public Boolean getUnapplyCustomPermissions()

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:

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.

withUnapplyCustomPermissions

public UpdateUserRequest withUnapplyCustomPermissions(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.

isUnapplyCustomPermissions

public Boolean isUnapplyCustomPermissions()

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:

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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateUserRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()