Class RegisterUserRequest

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.RegisterUserRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterUserRequest extends QuickSightRequest implements ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

  • Method Details

    • identityType

      public final IdentityType identityType()

      The identity type that your Quick Sight account uses to manage the identity of users.

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

      Returns:
      The identity type that your Quick Sight account uses to manage the identity of users.
      See Also:

    • identityTypeAsString

      public final String identityTypeAsString()

      The identity type that your Quick Sight account uses to manage the identity of users.

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

      Returns:
      The identity type that your Quick Sight account uses to manage the identity of users.
      See Also:

    • email

      public final String email()

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

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

    • userRole

      public final UserRole userRole()

      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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.

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

      Returns:
      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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:

    • userRoleAsString

      public final String userRoleAsString()

      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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.

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

      Returns:
      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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:

    • iamArn

      public final String iamArn()

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

      Returns:
      The ARN of the IAM user or role that you are registering with Amazon Quick Sight.

    • sessionName

      public final 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 Quick Sight 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 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 Quick Sight 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 CLI Reference.

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

    • userName

      public final String userName()

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

      Returns:
      The Amazon Quick Sight user name that you want to create for the user you are registering.

    • 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

      To add custom permissions to an existing user, use UpdateUser instead.

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

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

      This feature is available only to Quick Sight 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

      To add custom permissions to an existing user, use UpdateUser instead.

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

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

      This feature is available only to Quick Sight Enterprise edition subscriptions.

    • externalLoginFederationProviderType

      public final String externalLoginFederationProviderType()

      The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight 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.

      Returns:
      The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight 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.

    • customFederationProviderUrl

      public final String customFederationProviderUrl()

      The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight 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 Quick Sight 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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags to associate with the user.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags to associate with the user.

    • toBuilder

      public RegisterUserRequest.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<RegisterUserRequest.Builder,RegisterUserRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterUserRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisterUserRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.