User (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.User

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class User
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A registered user of Amazon QuickSight.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`User`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getActive()` The active status of user.
`String`	`getArn()` The Amazon Resource Name (ARN) for the user.
`String`	`getCustomPermissionsName()` The custom permissions profile associated with this user.
`String`	`getEmail()` The user's email address.
`String`	`getExternalLoginFederationProviderType()` The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role.
`String`	`getExternalLoginFederationProviderUrl()` The URL of the external login provider.
`String`	`getExternalLoginId()` The identity ID for the user in the external login provider.
`String`	`getIdentityType()` The type of identity authentication used by the user.
`String`	`getPrincipalId()` The principal ID of the user.
`String`	`getRole()` The Amazon QuickSight role for the user.
`String`	`getUserName()` The user's user name.
`int`	`hashCode()`
`Boolean`	`isActive()` The active status of user.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActive(Boolean active)` The active status of user.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) for the user.
`void`	`setCustomPermissionsName(String customPermissionsName)` The custom permissions profile associated with this user.
`void`	`setEmail(String email)` The user's email address.
`void`	`setExternalLoginFederationProviderType(String externalLoginFederationProviderType)` The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role.
`void`	`setExternalLoginFederationProviderUrl(String externalLoginFederationProviderUrl)` The URL of the external login provider.
`void`	`setExternalLoginId(String externalLoginId)` The identity ID for the user in the external login provider.
`void`	`setIdentityType(String identityType)` The type of identity authentication used by the user.
`void`	`setPrincipalId(String principalId)` The principal ID of the user.
`void`	`setRole(String role)` The Amazon QuickSight role for the user.
`void`	`setUserName(String userName)` The user's user name.
`String`	`toString()` Returns a string representation of this object.
`User`	`withActive(Boolean active)` The active status of user.
`User`	`withArn(String arn)` The Amazon Resource Name (ARN) for the user.
`User`	`withCustomPermissionsName(String customPermissionsName)` The custom permissions profile associated with this user.
`User`	`withEmail(String email)` The user's email address.
`User`	`withExternalLoginFederationProviderType(String externalLoginFederationProviderType)` The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role.
`User`	`withExternalLoginFederationProviderUrl(String externalLoginFederationProviderUrl)` The URL of the external login provider.
`User`	`withExternalLoginId(String externalLoginId)` The identity ID for the user in the external login provider.
`User`	`withIdentityType(IdentityType identityType)` The type of identity authentication used by the user.
`User`	`withIdentityType(String identityType)` The type of identity authentication used by the user.
`User`	`withPrincipalId(String principalId)` The principal ID of the user.
`User`	`withRole(String role)` The Amazon QuickSight role for the user.
`User`	`withRole(UserRole role)` The Amazon QuickSight role for the user.
`User`	`withUserName(String userName)` The user's user name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) for the user.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) for the user.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) for the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the user.
  - withArn
```
public User withArn(String arn)
```
    The Amazon Resource Name (ARN) for the user.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) for the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
    
    Parameters:
    
    userName - The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
  - getUserName
```
public String getUserName()
```
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
    
    Returns:
    
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
  - withUserName
```
public User withUserName(String userName)
```
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
    
    Parameters:
    
    userName - The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmail
```
public void setEmail(String email)
```
    The user's email address.
    
    Parameters:
    
    email - The user's email address.
  - getEmail
```
public String getEmail()
```
    The user's email address.
    
    Returns:
    
    The user's email address.
  - withEmail
```
public User withEmail(String email)
```
    The user's email address.
    
    Parameters:
    
    email - The user's email address.
    
    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 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 Amazon QuickSight settings.
    - READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    - RESTRICTED_READER: This role isn't currently available for use.
    - RESTRICTED_AUTHOR: This role isn't currently available for use.
    Parameters:
    role - 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 Amazon QuickSight settings.
    
    READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    
    RESTRICTED_READER: This role isn't currently available for use.
    
    RESTRICTED_AUTHOR: This role isn't currently available for use.
    See Also:
    
    UserRole
  - getRole
```
public String getRole()
```
    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 Amazon QuickSight settings.
    - READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    - 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 Amazon QuickSight settings.
    
    READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    
    RESTRICTED_READER: This role isn't currently available for use.
    
    RESTRICTED_AUTHOR: This role isn't currently available for use.
    See Also:
    
    UserRole
  - withRole
```
public User withRole(String role)
```
    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 Amazon QuickSight settings.
    - READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    - RESTRICTED_READER: This role isn't currently available for use.
    - RESTRICTED_AUTHOR: This role isn't currently available for use.
    Parameters:
    role - 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 Amazon QuickSight settings.
    
    READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    
    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
  - withRole
```
public User withRole(UserRole role)
```
    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 Amazon QuickSight settings.
    - READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    - RESTRICTED_READER: This role isn't currently available for use.
    - RESTRICTED_AUTHOR: This role isn't currently available for use.
    Parameters:
    role - 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 Amazon QuickSight settings.
    
    READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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.
    
    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
  - setIdentityType
```
public void setIdentityType(String identityType)
```
    The type of identity authentication used by the user.
    
    Parameters:
    
    identityType - The type of identity authentication used by the user.
    
    See Also:
    
    IdentityType
  - getIdentityType
```
public String getIdentityType()
```
    The type of identity authentication used by the user.
    
    Returns:
    
    The type of identity authentication used by the user.
    
    See Also:
    
    IdentityType
  - withIdentityType
```
public User withIdentityType(String identityType)
```
    The type of identity authentication used by the user.
    
    Parameters:
    
    identityType - The type of identity authentication used by the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityType
  - withIdentityType
```
public User withIdentityType(IdentityType identityType)
```
    The type of identity authentication used by the user.
    
    Parameters:
    
    identityType - The type of identity authentication used by the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityType
  - setActive
```
public void setActive(Boolean active)
```
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Parameters:
    
    active - The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
  - getActive
```
public Boolean getActive()
```
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Returns:
    
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
  - withActive
```
public User withActive(Boolean active)
```
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Parameters:
    
    active - The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isActive
```
public Boolean isActive()
```
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Returns:
    
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
  - setPrincipalId
```
public void setPrincipalId(String principalId)
```
    The principal ID of the user.
    
    Parameters:
    
    principalId - The principal ID of the user.
  - getPrincipalId
```
public String getPrincipalId()
```
    The principal ID of the user.
    
    Returns:
    
    The principal ID of the user.
  - withPrincipalId
```
public User withPrincipalId(String principalId)
```
    The principal ID of the user.
    
    Parameters:
    
    principalId - The principal ID of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomPermissionsName
```
public void setCustomPermissionsName(String customPermissionsName)
```
    The custom permissions profile associated with this user.
    
    Parameters:
    
    customPermissionsName - The custom permissions profile associated with this user.
  - getCustomPermissionsName
```
public String getCustomPermissionsName()
```
    The custom permissions profile associated with this user.
    
    Returns:
    
    The custom permissions profile associated with this user.
  - withCustomPermissionsName
```
public User withCustomPermissionsName(String customPermissionsName)
```
    The custom permissions profile associated with this user.
    
    Parameters:
    
    customPermissionsName - The custom permissions profile associated with this user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalLoginFederationProviderType
```
public void setExternalLoginFederationProviderType(String externalLoginFederationProviderType)
```
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    - COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    - CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
    Parameters:
    externalLoginFederationProviderType - The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    
    COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    
    CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
  - getExternalLoginFederationProviderType
```
public String getExternalLoginFederationProviderType()
```
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    - COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    - CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
    Returns:
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    
    COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    
    CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
  - withExternalLoginFederationProviderType
```
public User withExternalLoginFederationProviderType(String externalLoginFederationProviderType)
```
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    - COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    - CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
    Parameters:
    externalLoginFederationProviderType - The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    
    COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    
    CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalLoginFederationProviderUrl
```
public void setExternalLoginFederationProviderUrl(String externalLoginFederationProviderUrl)
```
    The URL of the external login provider.
    
    Parameters:
    
    externalLoginFederationProviderUrl - The URL of the external login provider.
  - getExternalLoginFederationProviderUrl
```
public String getExternalLoginFederationProviderUrl()
```
    The URL of the external login provider.
    
    Returns:
    
    The URL of the external login provider.
  - withExternalLoginFederationProviderUrl
```
public User withExternalLoginFederationProviderUrl(String externalLoginFederationProviderUrl)
```
    The URL of the external login provider.
    
    Parameters:
    
    externalLoginFederationProviderUrl - The URL of the external login provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalLoginId
```
public void setExternalLoginId(String externalLoginId)
```
    The identity ID for the user in the external login provider.
    
    Parameters:
    
    externalLoginId - The identity ID for the user in the external login provider.
  - getExternalLoginId
```
public String getExternalLoginId()
```
    The identity ID for the user in the external login provider.
    
    Returns:
    
    The identity ID for the user in the external login provider.
  - withExternalLoginId
```
public User withExternalLoginId(String externalLoginId)
```
    The identity ID for the user in the external login provider.
    
    Parameters:
    
    externalLoginId - The identity ID for the user in the external login provider.
    
    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 User clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

setArn

getArn

withArn

setUserName

getUserName

withUserName

setEmail

getEmail

withEmail

setRole

getRole

withRole

withRole

setIdentityType

getIdentityType

withIdentityType

withIdentityType

setActive

getActive

withActive

isActive

setPrincipalId

getPrincipalId

withPrincipalId

setCustomPermissionsName

getCustomPermissionsName

withCustomPermissionsName

setExternalLoginFederationProviderType

getExternalLoginFederationProviderType

withExternalLoginFederationProviderType

setExternalLoginFederationProviderUrl

getExternalLoginFederationProviderUrl

withExternalLoginFederationProviderUrl

setExternalLoginId

getExternalLoginId

withExternalLoginId

toString

equals

hashCode

clone

marshall