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.Types.User

Description

Synopsis

data User = User' {
- active :: Maybe Bool
- arn :: Maybe Text
- customPermissionsName :: Maybe Text
- email :: Maybe Text
- externalLoginFederationProviderType :: Maybe Text
- externalLoginFederationProviderUrl :: Maybe Text
- externalLoginId :: Maybe Text
- identityType :: Maybe IdentityType
- principalId :: Maybe Text
- role' :: Maybe UserRole
- userName :: Maybe Text
}
newUser :: User
user_active :: Lens' User (Maybe Bool)
user_arn :: Lens' User (Maybe Text)
user_customPermissionsName :: Lens' User (Maybe Text)
user_email :: Lens' User (Maybe Text)
user_externalLoginFederationProviderType :: Lens' User (Maybe Text)
user_externalLoginFederationProviderUrl :: Lens' User (Maybe Text)
user_externalLoginId :: Lens' User (Maybe Text)
user_identityType :: Lens' User (Maybe IdentityType)
user_principalId :: Lens' User (Maybe Text)
user_role :: Lens' User (Maybe UserRole)
user_userName :: Lens' User (Maybe Text)

Documentation

data User Source #

A registered user of Amazon QuickSight.

See: newUser smart constructor.

Constructors

User'

Fields

active :: Maybe Bool
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.
arn :: Maybe Text
The Amazon Resource Name (ARN) for the user.
customPermissionsName :: Maybe Text
The custom permissions profile associated with this user.
email :: Maybe Text
The user's email address.
externalLoginFederationProviderType :: Maybe Text
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.
externalLoginFederationProviderUrl :: Maybe Text
The URL of the external login provider.
externalLoginId :: Maybe Text
The identity ID for the user in the external login provider.
identityType :: Maybe IdentityType
The type of identity authentication used by the user.
principalId :: Maybe Text
The principal ID of the user.
role' :: Maybe 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 Amazon QuickSight settings.
- RESTRICTED_READER: This role isn't currently available for use.
- RESTRICTED_AUTHOR: This role isn't currently available for use.
userName :: Maybe Text
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.

Instances

Instances details

FromJSON User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
Generic User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
Read User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
NFData User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods rnf :: User -> () #
Eq User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Hashable User Source #
Instance details Defined in Amazonka.QuickSight.Types.User Methods hashWithSalt :: Int -> User -> Int # hash :: User -> Int #
type Rep User Source #
Instance details Defined in Amazonka.QuickSight.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.QuickSight.Types.User" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customPermissionsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "externalLoginFederationProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "externalLoginFederationProviderUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "externalLoginId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityType)))) :: (S1 ('MetaSel ('Just "principalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserRole)) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newUser :: User Source #

Create a value of User 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:active:User', user_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.

$sel:arn:User', user_arn - The Amazon Resource Name (ARN) for the user.

$sel:customPermissionsName:User', user_customPermissionsName - The custom permissions profile associated with this user.

$sel:email:User', user_email - The user's email address.

$sel:externalLoginFederationProviderType:User', user_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.

$sel:externalLoginFederationProviderUrl:User', user_externalLoginFederationProviderUrl - The URL of the external login provider.

$sel:externalLoginId:User', user_externalLoginId - The identity ID for the user in the external login provider.

$sel:identityType:User', user_identityType - The type of identity authentication used by the user.

$sel:principalId:User', user_principalId - The principal ID of the user.

$sel:role':User', user_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.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.

$sel:userName:User', user_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.

user_active :: Lens' User (Maybe Bool) Source #

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.

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) for the user.

user_customPermissionsName :: Lens' User (Maybe Text) Source #

The custom permissions profile associated with this user.

user_email :: Lens' User (Maybe Text) Source #

The user's email address.

user_externalLoginFederationProviderType :: Lens' User (Maybe Text) Source #

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.

user_externalLoginFederationProviderUrl :: Lens' User (Maybe Text) Source #

The URL of the external login provider.

user_externalLoginId :: Lens' User (Maybe Text) Source #

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

user_identityType :: Lens' User (Maybe IdentityType) Source #

The type of identity authentication used by the user.

user_principalId :: Lens' User (Maybe Text) Source #

The principal ID of the user.

user_role :: Lens' User (Maybe UserRole) Source #

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.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.

user_userName :: Lens' User (Maybe Text) Source #

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.