Package software.amazon.awssdk.services.quicksight.model

Class UpdateUserRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.UpdateUserRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateUserRequest extends QuickSightRequest implements ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

  • Method Details

    • userName

      public final String userName()

      The Amazon QuickSight user name that you want to update.

      Returns:
      The Amazon QuickSight user name that you want to update.

    • awsAccountId

      public final String 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:
      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.

    • namespace

      public final String namespace()

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

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

    • email

      public final String email()

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

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

    • role

      public final 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.

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

      If the service returns an enum value that is not available in the current SDK version, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      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.

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

      See Also:

    • roleAsString

      public final String roleAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      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.

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

      See Also:

    • customPermissionsName

      public final 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 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:
      (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.

    • unapplyCustomPermissions

      public final 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.

      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.

    • externalLoginFederationProviderType

      public final 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 the COGNITO 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 choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

      • NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

      Returns:
      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 the COGNITO 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 choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

      • NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

    • customFederationProviderUrl

      public final 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. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

      Returns:
      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 to CUSTOM_OIDC.

    • externalLoginId

      public final String externalLoginId()

      The identity ID for a user in the external login provider.

      Returns:
      The identity ID for a user in the external login provider.

    • toBuilder

      public UpdateUserRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateUserRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateUserRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.