Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSO.Types

Contents

Service Configuration
Errors
AccountInfo
RoleCredentials
RoleInfo

Description

Synopsis

defaultService :: Service
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
data AccountInfo = AccountInfo' {
- accountName :: Maybe Text
- accountId :: Maybe Text
- emailAddress :: Maybe Text
}
newAccountInfo :: AccountInfo
accountInfo_accountName :: Lens' AccountInfo (Maybe Text)
accountInfo_accountId :: Lens' AccountInfo (Maybe Text)
accountInfo_emailAddress :: Lens' AccountInfo (Maybe Text)
data RoleCredentials = RoleCredentials' {
- secretAccessKey :: Maybe (Sensitive Text)
- sessionToken :: Maybe (Sensitive Text)
- expiration :: Maybe Integer
- accessKeyId :: Maybe Text
}
newRoleCredentials :: RoleCredentials
roleCredentials_secretAccessKey :: Lens' RoleCredentials (Maybe Text)
roleCredentials_sessionToken :: Lens' RoleCredentials (Maybe Text)
roleCredentials_expiration :: Lens' RoleCredentials (Maybe Integer)
roleCredentials_accessKeyId :: Lens' RoleCredentials (Maybe Text)
data RoleInfo = RoleInfo' {
- roleName :: Maybe Text
- accountId :: Maybe Text
}
newRoleInfo :: RoleInfo
roleInfo_roleName :: Lens' RoleInfo (Maybe Text)
roleInfo_accountId :: 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 => Getting (First ServiceError) 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.

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource doesn't exist.

AccountInfo

data AccountInfo Source #

Provides information about your AWS account.

See: newAccountInfo smart constructor.

Constructors

AccountInfo'
Fields accountName :: Maybe Text The display name of the AWS account that is assigned to the user. accountId :: Maybe Text The identifier 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

Eq AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods (==) :: AccountInfo -> AccountInfo -> Bool # (/=) :: AccountInfo -> AccountInfo -> Bool #
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 #
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 #
NFData AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods rnf :: AccountInfo -> () #
Hashable AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods hashWithSalt :: Int -> AccountInfo -> Int # hash :: AccountInfo -> Int #
FromJSON AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo Methods parseJSON :: Value -> Parser AccountInfo # parseJSONList :: Value -> Parser [AccountInfo] #
type Rep AccountInfo Source #
Instance details Defined in Amazonka.SSO.Types.AccountInfo type Rep AccountInfo = D1 ('MetaData "AccountInfo" "Amazonka.SSO.Types.AccountInfo" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "AccountInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accountId") '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:accountName:AccountInfo', accountInfo_accountName - The display name of the AWS account that is assigned to the user.

$sel:accountId:AccountInfo', accountInfo_accountId - The identifier 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_accountName :: Lens' AccountInfo (Maybe Text) Source #

The display name 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_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

secretAccessKey :: Maybe (Sensitive Text)
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.
sessionToken :: Maybe (Sensitive Text)
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.
expiration :: Maybe Integer
The date on which temporary security credentials expire.
accessKeyId :: Maybe Text
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.

Instances

Instances details

Eq RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods (==) :: RoleCredentials -> RoleCredentials -> Bool # (/=) :: RoleCredentials -> RoleCredentials -> Bool #
Show RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods showsPrec :: Int -> RoleCredentials -> ShowS # show :: RoleCredentials -> String # showList :: [RoleCredentials] -> ShowS #
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 #
NFData RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods rnf :: RoleCredentials -> () #
Hashable RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods hashWithSalt :: Int -> RoleCredentials -> Int # hash :: RoleCredentials -> Int #
FromJSON RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials Methods parseJSON :: Value -> Parser RoleCredentials # parseJSONList :: Value -> Parser [RoleCredentials] #
type Rep RoleCredentials Source #
Instance details Defined in Amazonka.SSO.Types.RoleCredentials type Rep RoleCredentials = D1 ('MetaData "RoleCredentials" "Amazonka.SSO.Types.RoleCredentials" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "RoleCredentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "secretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "sessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newRoleCredentials :: RoleCredentials Source #

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

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

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

roleCredentials_secretAccessKey :: Lens' RoleCredentials (Maybe Text) 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.

roleCredentials_sessionToken :: Lens' RoleCredentials (Maybe Text) 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_expiration :: Lens' RoleCredentials (Maybe Integer) Source #

The date on which temporary security credentials expire.

roleCredentials_accessKeyId :: Lens' RoleCredentials (Maybe Text) 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.

RoleInfo

data RoleInfo Source #

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

See: newRoleInfo smart constructor.

Constructors

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

Instances

Instances details

Eq RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods (==) :: RoleInfo -> RoleInfo -> Bool # (/=) :: RoleInfo -> RoleInfo -> Bool #
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 #
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 #
NFData RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods rnf :: RoleInfo -> () #
Hashable RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods hashWithSalt :: Int -> RoleInfo -> Int # hash :: RoleInfo -> Int #
FromJSON RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo Methods parseJSON :: Value -> Parser RoleInfo # parseJSONList :: Value -> Parser [RoleInfo] #
type Rep RoleInfo Source #
Instance details Defined in Amazonka.SSO.Types.RoleInfo type Rep RoleInfo = D1 ('MetaData "RoleInfo" "Amazonka.SSO.Types.RoleInfo" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "RoleInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "accountId") '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:roleName:RoleInfo', roleInfo_roleName - The friendly name of the role that is assigned to the user.

$sel:accountId:RoleInfo', roleInfo_accountId - 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.

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

The identifier of the AWS account assigned to the user.