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

Contents

Service Configuration
Errors
AccountInfo
RoleCredentials
RoleInfo

Description

Synopsis

defaultService :: Service
_InvalidRequestException :: AsError a => Fold a ServiceError
_ResourceNotFoundException :: AsError a => Fold a ServiceError
_TooManyRequestsException :: AsError a => Fold a ServiceError
_UnauthorizedException :: AsError a => Fold a ServiceError
data AccountInfo = AccountInfo' {
- accountId :: Maybe Text
- accountName :: Maybe Text
- emailAddress :: Maybe Text
}
newAccountInfo :: AccountInfo
accountInfo_accountId :: Lens' AccountInfo (Maybe Text)
accountInfo_accountName :: Lens' AccountInfo (Maybe Text)
accountInfo_emailAddress :: Lens' AccountInfo (Maybe Text)
data RoleCredentials = RoleCredentials' {
- expiration :: Maybe Integer
- sessionToken :: Maybe (Sensitive SessionToken)
- accessKeyId :: AccessKey
- secretAccessKey :: Sensitive SecretKey
}
newRoleCredentials :: AccessKey -> SecretKey -> RoleCredentials
roleCredentials_expiration :: Lens' RoleCredentials (Maybe Integer)
roleCredentials_sessionToken :: Lens' RoleCredentials (Maybe SessionToken)
roleCredentials_accessKeyId :: Lens' RoleCredentials AccessKey
roleCredentials_secretAccessKey :: Lens' RoleCredentials SecretKey
data RoleInfo = RoleInfo' {
- accountId :: Maybe Text
- roleName :: Maybe Text
}
newRoleInfo :: RoleInfo
roleInfo_accountId :: Lens' RoleInfo (Maybe Text)
roleInfo_roleName :: Lens' RoleInfo (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2019-06-10 of the Amazon Single Sign-On SDK configuration.

Errors

_InvalidRequestException :: AsError a => Fold a ServiceError Source #

Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource doesn't exist.

_TooManyRequestsException :: AsError a => Fold a ServiceError Source #

Indicates that the request is being made too frequently and is more than what the server can handle.

_UnauthorizedException :: AsError a => Fold a ServiceError Source #

Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

AccountInfo

data AccountInfo Source #

Provides information about your AWS account.

See: newAccountInfo smart constructor.

Constructors

AccountInfo'
Fields accountId :: Maybe Text The identifier of the AWS account that is assigned to the user. accountName :: Maybe Text The display name of the AWS account that is assigned to the user. emailAddress :: Maybe Text The email address of the AWS account that is assigned to the user.

Instances

Instances details

FromJSON AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods parseJSON :: Value -> Parser AccountInfo # parseJSONList :: Value -> Parser [AccountInfo] #
Generic AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Associated Types type Rep AccountInfo :: Type -> Type # Methods from :: AccountInfo -> Rep AccountInfo x # to :: Rep AccountInfo x -> AccountInfo #
Read AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods readsPrec :: Int -> ReadS AccountInfo # readList :: ReadS [AccountInfo] # readPrec :: ReadPrec AccountInfo # readListPrec :: ReadPrec [AccountInfo] #
Show AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods showsPrec :: Int -> AccountInfo -> ShowS # show :: AccountInfo -> String # showList :: [AccountInfo] -> ShowS #
NFData AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods rnf :: AccountInfo -> () #
Eq AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods (==) :: AccountInfo -> AccountInfo -> Bool # (/=) :: AccountInfo -> AccountInfo -> Bool #
Hashable AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods hashWithSalt :: Int -> AccountInfo -> Int # hash :: AccountInfo -> Int #
type Rep AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo type Rep AccountInfo = D1 ('MetaData "AccountInfo" "Amazonka.SSO.Types.AccountInfo" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "AccountInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAccountInfo :: AccountInfo Source #

Create a value of AccountInfo 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:accountId:AccountInfo', accountInfo_accountId - The identifier of the AWS account that is assigned to the user.

$sel:accountName:AccountInfo', accountInfo_accountName - The display name of the AWS account that is assigned to the user.

$sel:emailAddress:AccountInfo', accountInfo_emailAddress - The email address of the AWS account that is assigned to the user.

accountInfo_accountId :: Lens' AccountInfo (Maybe Text) Source #

The identifier of the AWS account that is assigned to the user.

accountInfo_accountName :: Lens' AccountInfo (Maybe Text) Source #

The display name of the AWS account that is assigned to the user.

accountInfo_emailAddress :: Lens' AccountInfo (Maybe Text) Source #

The email address of the AWS account that is assigned to the user.

RoleCredentials

data RoleCredentials Source #

Provides information about the role credentials that are assigned to the user.

See: newRoleCredentials smart constructor.

Constructors

RoleCredentials'

Fields

expiration :: Maybe Integer
The date on which temporary security credentials expire.
sessionToken :: Maybe (Sensitive SessionToken)
The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.
accessKeyId :: AccessKey
The identifier used for the temporary security credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.
secretAccessKey :: Sensitive SecretKey
The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

Instances

Instances details

FromJSON RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods parseJSON :: Value -> Parser RoleCredentials # parseJSONList :: Value -> Parser [RoleCredentials] #
Generic RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Associated Types type Rep RoleCredentials :: Type -> Type # Methods from :: RoleCredentials -> Rep RoleCredentials x # to :: Rep RoleCredentials x -> RoleCredentials #
Show RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods showsPrec :: Int -> RoleCredentials -> ShowS # show :: RoleCredentials -> String # showList :: [RoleCredentials] -> ShowS #
NFData RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods rnf :: RoleCredentials -> () #
Eq RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods (==) :: RoleCredentials -> RoleCredentials -> Bool # (/=) :: RoleCredentials -> RoleCredentials -> Bool #
Hashable RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods hashWithSalt :: Int -> RoleCredentials -> Int # hash :: RoleCredentials -> Int #
type Rep RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials type Rep RoleCredentials = D1 ('MetaData "RoleCredentials" "Amazonka.SSO.Types.RoleCredentials" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "RoleCredentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "sessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive SessionToken)))) :: (S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKey) :*: S1 ('MetaSel ('Just "secretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive SecretKey)))))

newRoleCredentials Source #

Arguments

:: AccessKey	`$sel:accessKeyId:RoleCredentials'`
-> SecretKey	`$sel:secretAccessKey:RoleCredentials'`
-> RoleCredentials

Create a value of RoleCredentials 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:expiration:RoleCredentials', roleCredentials_expiration - The date on which temporary security credentials expire.

$sel:sessionToken:RoleCredentials', roleCredentials_sessionToken - The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

$sel:accessKeyId:RoleCredentials', roleCredentials_accessKeyId - The identifier used for the temporary security credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

$sel:secretAccessKey:RoleCredentials', roleCredentials_secretAccessKey - The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

roleCredentials_expiration :: Lens' RoleCredentials (Maybe Integer) Source #

The date on which temporary security credentials expire.

roleCredentials_sessionToken :: Lens' RoleCredentials (Maybe SessionToken) Source #

The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

roleCredentials_accessKeyId :: Lens' RoleCredentials AccessKey Source #

The identifier used for the temporary security credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

roleCredentials_secretAccessKey :: Lens' RoleCredentials SecretKey Source #

The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

RoleInfo

data RoleInfo Source #

Provides information about the role that is assigned to the user.

See: newRoleInfo smart constructor.

Constructors

RoleInfo'
Fields accountId :: Maybe Text The identifier of the AWS account assigned to the user. roleName :: Maybe Text The friendly name of the role that is assigned to the user.

Instances

Instances details

FromJSON RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods parseJSON :: Value -> Parser RoleInfo # parseJSONList :: Value -> Parser [RoleInfo] #
Generic RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Associated Types type Rep RoleInfo :: Type -> Type # Methods from :: RoleInfo -> Rep RoleInfo x # to :: Rep RoleInfo x -> RoleInfo #
Read RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods readsPrec :: Int -> ReadS RoleInfo # readList :: ReadS [RoleInfo] # readPrec :: ReadPrec RoleInfo # readListPrec :: ReadPrec [RoleInfo] #
Show RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods showsPrec :: Int -> RoleInfo -> ShowS # show :: RoleInfo -> String # showList :: [RoleInfo] -> ShowS #
NFData RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods rnf :: RoleInfo -> () #
Eq RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods (==) :: RoleInfo -> RoleInfo -> Bool # (/=) :: RoleInfo -> RoleInfo -> Bool #
Hashable RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods hashWithSalt :: Int -> RoleInfo -> Int # hash :: RoleInfo -> Int #
type Rep RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo type Rep RoleInfo = D1 ('MetaData "RoleInfo" "Amazonka.SSO.Types.RoleInfo" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "RoleInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRoleInfo :: RoleInfo Source #

Create a value of RoleInfo 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:accountId:RoleInfo', roleInfo_accountId - The identifier of the AWS account assigned to the user.

$sel:roleName:RoleInfo', roleInfo_roleName - The friendly name of the role that is assigned to the user.

roleInfo_accountId :: Lens' RoleInfo (Maybe Text) Source #

The identifier of the AWS account assigned to the user.

roleInfo_roleName :: Lens' RoleInfo (Maybe Text) Source #

The friendly name of the role that is assigned to the user.