Class RegisterUserRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RegisterUserRequest.Builder,
RegisterUserRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID for the Amazon Web Services account that the user is in.static RegisterUserRequest.Builder
builder()
final String
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.final String
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.final String
email()
The email address of the user that you want to register.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
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.final String
The identity ID for a user in the external login provider.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
iamArn()
The ARN of the IAM user or role that you are registering with Amazon QuickSight.final IdentityType
Amazon QuickSight supports several ways of managing the identity of users.final String
Amazon QuickSight supports several ways of managing the identity of users.final String
The namespace.static Class
<? extends RegisterUserRequest.Builder> final String
You need to use this parameter only when you register one or more users using an assumed IAM role.tags()
The tags to associate with the user.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userName()
The Amazon QuickSight user name that you want to create for the user you are registering.final UserRole
userRole()
The Amazon QuickSight role for the user.final String
The Amazon QuickSight role for the user.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- 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:
-
-
identityTypeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
identityType
will returnIdentityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityTypeAsString()
.- 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:
-
-
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
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.
If the service returns an enum value that is not available in the current SDK version,
userRole
will returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserRoleAsString()
.- 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:
-
-
userRoleAsString
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.
If the service returns an enum value that is not available in the current SDK version,
userRole
will returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserRoleAsString()
.- 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:
-
-
iamArn
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.
-
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 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 CLI Reference.
-
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
The namespace. Currently, you should set this to
default
.- Returns:
- The namespace. Currently, you should set this to
default
.
-
userName
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.
-
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 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
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 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.
-
-
-
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 theCOGNITO
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 choosingCUSTOM_OIDC
type, use theCustomFederationProviderUrl
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
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 theCOGNITO
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 choosingCUSTOM_OIDC
type, use theCustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
-
-
-
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 toCUSTOM_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 toCUSTOM_OIDC
.
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<RegisterUserRequest.Builder,
RegisterUserRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-