com.amazonaws.services.quicksight.model

Class RegisterUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.RegisterUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterUserRequest
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
RegisterUserRequest()

Method Summary

Modifier and Type	Method and Description
RegisterUserRequest	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	getEmail() The email address of the user that you want to register.
String	getIamArn() The ARN of the IAM user or role that you are registering with Amazon QuickSight.
String	getIdentityType() Amazon QuickSight supports several ways of managing the identity of users.
String	getNamespace() The namespace.
String	getSessionName() You need to use this parameter only when you register one or more users using an assumed IAM role.
String	getUserName() The Amazon QuickSight user name that you want to create for the user you are registering.
String	getUserRole() The Amazon QuickSight role for the user.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID for the AWS account that the user is in.
void	setEmail(String email) The email address of the user that you want to register.
void	setIamArn(String iamArn) The ARN of the IAM user or role that you are registering with Amazon QuickSight.
void	setIdentityType(String identityType) Amazon QuickSight supports several ways of managing the identity of users.
void	setNamespace(String namespace) The namespace.
void	setSessionName(String sessionName) You need to use this parameter only when you register one or more users using an assumed IAM role.
void	setUserName(String userName) The Amazon QuickSight user name that you want to create for the user you are registering.
void	setUserRole(String userRole) The Amazon QuickSight role for the user.
String	toString() Returns a string representation of this object.
RegisterUserRequest	withAwsAccountId(String awsAccountId) The ID for the AWS account that the user is in.
RegisterUserRequest	withEmail(String email) The email address of the user that you want to register.
RegisterUserRequest	withIamArn(String iamArn) The ARN of the IAM user or role that you are registering with Amazon QuickSight.
RegisterUserRequest	withIdentityType(IdentityType identityType) Amazon QuickSight supports several ways of managing the identity of users.
RegisterUserRequest	withIdentityType(String identityType) Amazon QuickSight supports several ways of managing the identity of users.
RegisterUserRequest	withNamespace(String namespace) The namespace.
RegisterUserRequest	withSessionName(String sessionName) You need to use this parameter only when you register one or more users using an assumed IAM role.
RegisterUserRequest	withUserName(String userName) The Amazon QuickSight user name that you want to create for the user you are registering.
RegisterUserRequest	withUserRole(String userRole) The Amazon QuickSight role for the user.
RegisterUserRequest	withUserRole(UserRole userRole) The Amazon QuickSight role for the user.

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

RegisterUserRequest

public RegisterUserRequest()

Method Detail

setIdentityType

public void setIdentityType(String identityType)

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 IAM user or role.

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

Parameters:

identityType - 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 IAM user or role.

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

See Also:

IdentityType

getIdentityType

public String getIdentityType()

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 IAM user or role.

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

Returns:

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 IAM user or role.

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

See Also:

IdentityType

withIdentityType

public RegisterUserRequest withIdentityType(String identityType)

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 IAM user or role.

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

Parameters:

identityType - 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 IAM user or role.

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

Returns:

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

See Also:

IdentityType

withIdentityType

public RegisterUserRequest withIdentityType(IdentityType identityType)

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 IAM user or role.

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

Parameters:

identityType - 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 IAM user or role.

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

Returns:

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

See Also:

IdentityType

setEmail

public void setEmail(String email)

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

Parameters:

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

getEmail

public String getEmail()

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

Returns:

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

withEmail

public RegisterUserRequest withEmail(String email)

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

Parameters:

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

Returns:

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

setUserRole

public void setUserRole(String userRole)

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.

Parameters:

userRole - 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.

See Also:

UserRole

getUserRole

public String getUserRole()

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.

Returns:

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.

See Also:

UserRole

withUserRole

public RegisterUserRequest withUserRole(String userRole)

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.

Parameters:

userRole - 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.

Returns:

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

See Also:

UserRole

withUserRole

public RegisterUserRequest withUserRole(UserRole userRole)

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.

Parameters:

userRole - 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.

Returns:

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

See Also:

UserRole

setIamArn

public void setIamArn(String iamArn)

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

Parameters:

iamArn - The ARN of the IAM user or role that you are registering with Amazon QuickSight.

getIamArn

public String getIamArn()

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

Returns:

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

withIamArn

public RegisterUserRequest withIamArn(String iamArn)

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

Parameters:

iamArn - The ARN of the IAM user or role that you are registering with Amazon QuickSight.

Returns:

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

setSessionName

public void setSessionName(String sessionName)

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

Parameters:

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

getSessionName

public String getSessionName()

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

Returns:

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

withSessionName

public RegisterUserRequest withSessionName(String sessionName)

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

Parameters:

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

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 RegisterUserRequest 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 RegisterUserRequest 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.

setUserName

public void setUserName(String userName)

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

Parameters:

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

getUserName

public String getUserName()

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

Returns:

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

withUserName

public RegisterUserRequest withUserName(String userName)

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

Parameters:

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

Returns:

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

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