Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.UpdateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an Amazon QuickSight user.

Synopsis

data UpdateUser = UpdateUser' {
- customFederationProviderUrl :: Maybe Text
- customPermissionsName :: Maybe Text
- externalLoginFederationProviderType :: Maybe Text
- externalLoginId :: Maybe Text
- unapplyCustomPermissions :: Maybe Bool
- userName :: Text
- awsAccountId :: Text
- namespace :: Text
- email :: Text
- role' :: UserRole
}
newUpdateUser :: Text -> Text -> Text -> Text -> UserRole -> UpdateUser
updateUser_customFederationProviderUrl :: Lens' UpdateUser (Maybe Text)
updateUser_customPermissionsName :: Lens' UpdateUser (Maybe Text)
updateUser_externalLoginFederationProviderType :: Lens' UpdateUser (Maybe Text)
updateUser_externalLoginId :: Lens' UpdateUser (Maybe Text)
updateUser_unapplyCustomPermissions :: Lens' UpdateUser (Maybe Bool)
updateUser_userName :: Lens' UpdateUser Text
updateUser_awsAccountId :: Lens' UpdateUser Text
updateUser_namespace :: Lens' UpdateUser Text
updateUser_email :: Lens' UpdateUser Text
updateUser_role :: Lens' UpdateUser UserRole
data UpdateUserResponse = UpdateUserResponse' {
- requestId :: Maybe Text
- user :: Maybe User
- status :: Int
}
newUpdateUserResponse :: Int -> UpdateUserResponse
updateUserResponse_requestId :: Lens' UpdateUserResponse (Maybe Text)
updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User)
updateUserResponse_status :: Lens' UpdateUserResponse Int

Creating a Request

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser'

Fields

customFederationProviderUrl :: Maybe Text
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.
customPermissionsName :: Maybe Text
(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.
externalLoginFederationProviderType :: Maybe Text
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.
externalLoginId :: Maybe Text
The identity ID for a user in the external login provider.
unapplyCustomPermissions :: Maybe Bool
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.
userName :: Text
The Amazon QuickSight user name that you want to update.
awsAccountId :: Text
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 :: Text
The namespace. Currently, you should set this to default.
email :: Text
The email address of the user that you want to update.
role' :: UserRole
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.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Instances

Instances details

ToJSON UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods toJSON :: UpdateUser -> Value # toEncoding :: UpdateUser -> Encoding # toJSONList :: [UpdateUser] -> Value # toEncodingList :: [UpdateUser] -> Encoding #
ToHeaders UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods toHeaders :: UpdateUser -> [Header] #
ToPath UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods toPath :: UpdateUser -> ByteString #
ToQuery UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods toQuery :: UpdateUser -> QueryString #
AWSRequest UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Associated Types type AWSResponse UpdateUser # Methods request :: (Service -> Service) -> UpdateUser -> Request UpdateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUser))) #
Generic UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Associated Types type Rep UpdateUser :: Type -> Type # Methods from :: UpdateUser -> Rep UpdateUser x # to :: Rep UpdateUser x -> UpdateUser #
Read UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUser # readList :: ReadS [UpdateUser] # readPrec :: ReadPrec UpdateUser # readListPrec :: ReadPrec [UpdateUser] #
Show UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods showsPrec :: Int -> UpdateUser -> ShowS # show :: UpdateUser -> String # showList :: [UpdateUser] -> ShowS #
NFData UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods rnf :: UpdateUser -> () #
Eq UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods (==) :: UpdateUser -> UpdateUser -> Bool # (/=) :: UpdateUser -> UpdateUser -> Bool #
Hashable UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods hashWithSalt :: Int -> UpdateUser -> Int # hash :: UpdateUser -> Int #
type AWSResponse UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser type AWSResponse UpdateUser = UpdateUserResponse
type Rep UpdateUser Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.QuickSight.UpdateUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customFederationProviderUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "customPermissionsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "externalLoginFederationProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "externalLoginId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "unapplyCustomPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserRole))))))

newUpdateUser Source #

Arguments

:: Text	`UpdateUser`
-> Text	`UpdateUser`
-> Text	`UpdateUser`
-> Text	`UpdateUser`
-> UserRole	`UpdateUser`
-> UpdateUser

Create a value of UpdateUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customFederationProviderUrl:UpdateUser', updateUser_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.

UpdateUser, updateUser_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.

UpdateUser, updateUser_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.

UpdateUser, updateUser_externalLoginId - The identity ID for a user in the external login provider.

$sel:unapplyCustomPermissions:UpdateUser', updateUser_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.

UpdateUser, updateUser_userName - The Amazon QuickSight user name that you want to update.

UpdateUser, updateUser_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.

UpdateUser, updateUser_namespace - The namespace. Currently, you should set this to default.

UpdateUser, updateUser_email - The email address of the user that you want to update.

UpdateUser, updateUser_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.

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Request Lenses

updateUser_customFederationProviderUrl :: Lens' UpdateUser (Maybe Text) Source #

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.

updateUser_customPermissionsName :: Lens' UpdateUser (Maybe Text) Source #

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

updateUser_externalLoginFederationProviderType :: Lens' UpdateUser (Maybe Text) Source #

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.

updateUser_externalLoginId :: Lens' UpdateUser (Maybe Text) Source #

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

updateUser_unapplyCustomPermissions :: Lens' UpdateUser (Maybe Bool) Source #

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.

updateUser_userName :: Lens' UpdateUser Text Source #

The Amazon QuickSight user name that you want to update.

updateUser_awsAccountId :: Lens' UpdateUser Text Source #

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.

updateUser_namespace :: Lens' UpdateUser Text Source #

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

updateUser_email :: Lens' UpdateUser Text Source #

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

updateUser_role :: Lens' UpdateUser UserRole Source #

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.

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Destructuring the Response

data UpdateUserResponse Source #

See: newUpdateUserResponse smart constructor.

Constructors

UpdateUserResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. user :: Maybe User The Amazon QuickSight user. status :: Int The HTTP status of the request.

Instances

Instances details

Generic UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Associated Types type Rep UpdateUserResponse :: Type -> Type # Methods from :: UpdateUserResponse -> Rep UpdateUserResponse x # to :: Rep UpdateUserResponse x -> UpdateUserResponse #
Read UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUserResponse # readList :: ReadS [UpdateUserResponse] # readPrec :: ReadPrec UpdateUserResponse # readListPrec :: ReadPrec [UpdateUserResponse] #
Show UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods showsPrec :: Int -> UpdateUserResponse -> ShowS # show :: UpdateUserResponse -> String # showList :: [UpdateUserResponse] -> ShowS #
NFData UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods rnf :: UpdateUserResponse -> () #
Eq UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser Methods (==) :: UpdateUserResponse -> UpdateUserResponse -> Bool # (/=) :: UpdateUserResponse -> UpdateUserResponse -> Bool #
type Rep UpdateUserResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateUser type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.QuickSight.UpdateUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateUserResponse Source #

Arguments

:: Int	`UpdateUserResponse`
-> UpdateUserResponse

Create a value of UpdateUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:UpdateUserResponse', updateUserResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:user:UpdateUserResponse', updateUserResponse_user - The Amazon QuickSight user.

UpdateUserResponse, updateUserResponse_status - The HTTP status of the request.

Response Lenses

updateUserResponse_requestId :: Lens' UpdateUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User) Source #

The Amazon QuickSight user.

updateUserResponse_status :: Lens' UpdateUserResponse Int Source #

The HTTP status of the request.