| 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 | None |
| Language | Haskell2010 |
Amazonka.SSO
Description
Derived from API version 2019-06-10 of the AWS service descriptions, licensed under Apache 2.0.
AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.
Although AWS Single Sign-On was renamed, the sso and identitystore
API namespaces will continue to retain their original name for backward
compatibility purposes. For more information, see
IAM Identity Center rename.
This reference guide describes the IAM Identity Center Portal operations that you can call programatically and includes detailed information on data types and errors.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
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 GetRoleCredentials = GetRoleCredentials' Text Text (Sensitive Text)
- newGetRoleCredentials :: Text -> Text -> Text -> GetRoleCredentials
- data GetRoleCredentialsResponse = GetRoleCredentialsResponse' Int RoleCredentials
- newGetRoleCredentialsResponse :: Int -> RoleCredentials -> GetRoleCredentialsResponse
- data ListAccountRoles = ListAccountRoles' (Maybe Natural) (Maybe Text) (Sensitive Text) Text
- newListAccountRoles :: Text -> Text -> ListAccountRoles
- data ListAccountRolesResponse = ListAccountRolesResponse' (Maybe Text) (Maybe [RoleInfo]) Int
- newListAccountRolesResponse :: Int -> ListAccountRolesResponse
- data ListAccounts = ListAccounts' (Maybe Natural) (Maybe Text) (Sensitive Text)
- newListAccounts :: Text -> ListAccounts
- data ListAccountsResponse = ListAccountsResponse' (Maybe [AccountInfo]) (Maybe Text) Int
- newListAccountsResponse :: Int -> ListAccountsResponse
- data Logout = Logout' (Sensitive Text)
- newLogout :: Text -> Logout
- data LogoutResponse = LogoutResponse'
- newLogoutResponse :: LogoutResponse
- data AccountInfo = AccountInfo' (Maybe Text) (Maybe Text) (Maybe Text)
- newAccountInfo :: AccountInfo
- data RoleCredentials = RoleCredentials' (Maybe Integer) (Maybe (Sensitive SessionToken)) AccessKey (Sensitive SecretKey)
- newRoleCredentials :: AccessKey -> SecretKey -> RoleCredentials
- data RoleInfo = RoleInfo' (Maybe Text) (Maybe Text)
- newRoleInfo :: RoleInfo
Service Configuration
defaultService :: Service Source #
API version 2019-06-10 of the Amazon Single Sign-On SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SSO.
InvalidRequestException
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource doesn't exist.
TooManyRequestsException
_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
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetRoleCredentials
data GetRoleCredentials Source #
See: newGetRoleCredentials smart constructor.
Constructors
| GetRoleCredentials' Text Text (Sensitive Text) |
Instances
newGetRoleCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetRoleCredentials |
Create a value of GetRoleCredentials 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:
roleName, getRoleCredentials_roleName - The friendly name of the role that is assigned to the user.
accountId, getRoleCredentials_accountId - The identifier for the AWS account that is assigned to the user.
accessToken, getRoleCredentials_accessToken - The token issued by the CreateToken API call. For more information,
see
CreateToken
in the IAM Identity Center OIDC API Reference Guide.
data GetRoleCredentialsResponse Source #
See: newGetRoleCredentialsResponse smart constructor.
Constructors
| GetRoleCredentialsResponse' Int RoleCredentials |
Instances
| NFData GetRoleCredentialsResponse Source # | |||||
Defined in Amazonka.SSO.GetRoleCredentials Methods rnf :: GetRoleCredentialsResponse -> () # | |||||
| Generic GetRoleCredentialsResponse Source # | |||||
Defined in Amazonka.SSO.GetRoleCredentials Associated Types
Methods from :: GetRoleCredentialsResponse -> Rep GetRoleCredentialsResponse x # to :: Rep GetRoleCredentialsResponse x -> GetRoleCredentialsResponse # | |||||
| Show GetRoleCredentialsResponse Source # | |||||
Defined in Amazonka.SSO.GetRoleCredentials Methods showsPrec :: Int -> GetRoleCredentialsResponse -> ShowS # show :: GetRoleCredentialsResponse -> String # showList :: [GetRoleCredentialsResponse] -> ShowS # | |||||
| Eq GetRoleCredentialsResponse Source # | |||||
Defined in Amazonka.SSO.GetRoleCredentials Methods (==) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool # (/=) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool # | |||||
| type Rep GetRoleCredentialsResponse Source # | |||||
Defined in Amazonka.SSO.GetRoleCredentials type Rep GetRoleCredentialsResponse = D1 ('MetaData "GetRoleCredentialsResponse" "Amazonka.SSO.GetRoleCredentials" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" 'False) (C1 ('MetaCons "GetRoleCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "roleCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoleCredentials))) | |||||
newGetRoleCredentialsResponse Source #
Arguments
| :: Int | |
| -> RoleCredentials | |
| -> GetRoleCredentialsResponse |
Create a value of GetRoleCredentialsResponse 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:
httpStatus, getRoleCredentialsResponse_httpStatus - The response's http status code.
roleCredentials, getRoleCredentialsResponse_roleCredentials - The credentials for the role that is assigned to the user.
ListAccountRoles (Paginated)
data ListAccountRoles Source #
See: newListAccountRoles smart constructor.
Instances
| ToHeaders ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods toHeaders :: ListAccountRoles -> [Header] Source # | |||||
| ToPath ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods toPath :: ListAccountRoles -> ByteString Source # | |||||
| ToQuery ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods | |||||
| AWSPager ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods page :: ListAccountRoles -> AWSResponse ListAccountRoles -> Maybe ListAccountRoles Source # | |||||
| AWSRequest ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Associated Types
Methods request :: (Service -> Service) -> ListAccountRoles -> Request ListAccountRoles Source # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccountRoles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccountRoles))) Source # | |||||
| NFData ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRoles -> () # | |||||
| Generic ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Associated Types
Methods from :: ListAccountRoles -> Rep ListAccountRoles x # to :: Rep ListAccountRoles x -> ListAccountRoles # | |||||
| Show ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods showsPrec :: Int -> ListAccountRoles -> ShowS # show :: ListAccountRoles -> String # showList :: [ListAccountRoles] -> ShowS # | |||||
| Eq ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRoles -> ListAccountRoles -> Bool # (/=) :: ListAccountRoles -> ListAccountRoles -> Bool # | |||||
| Hashable ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods hashWithSalt :: Int -> ListAccountRoles -> Int Source # hash :: ListAccountRoles -> Int Source # | |||||
| type AWSResponse ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles | |||||
| type Rep ListAccountRoles Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRoles = D1 ('MetaData "ListAccountRoles" "Amazonka.SSO.ListAccountRoles" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" 'False) (C1 ('MetaCons "ListAccountRoles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |||||
Arguments
| :: Text | |
| -> Text | |
| -> ListAccountRoles |
Create a value of ListAccountRoles 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:
maxResults, listAccountRoles_maxResults - The number of items that clients can request per page.
nextToken, listAccountRoles_nextToken - The page token from the previous response output when you request
subsequent pages.
accessToken, listAccountRoles_accessToken - The token issued by the CreateToken API call. For more information,
see
CreateToken
in the IAM Identity Center OIDC API Reference Guide.
accountId, listAccountRoles_accountId - The identifier for the AWS account that is assigned to the user.
data ListAccountRolesResponse Source #
See: newListAccountRolesResponse smart constructor.
Instances
| NFData ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRolesResponse -> () # | |||||
| Generic ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Associated Types
Methods from :: ListAccountRolesResponse -> Rep ListAccountRolesResponse x # to :: Rep ListAccountRolesResponse x -> ListAccountRolesResponse # | |||||
| Read ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles | |||||
| Show ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods showsPrec :: Int -> ListAccountRolesResponse -> ShowS # show :: ListAccountRolesResponse -> String # showList :: [ListAccountRolesResponse] -> ShowS # | |||||
| Eq ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool # (/=) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool # | |||||
| type Rep ListAccountRolesResponse Source # | |||||
Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRolesResponse = D1 ('MetaData "ListAccountRolesResponse" "Amazonka.SSO.ListAccountRoles" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" 'False) (C1 ('MetaCons "ListAccountRolesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roleList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RoleInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |||||
newListAccountRolesResponse Source #
Arguments
| :: Int | |
| -> ListAccountRolesResponse |
Create a value of ListAccountRolesResponse 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:
nextToken, listAccountRolesResponse_nextToken - The page token client that is used to retrieve the list of accounts.
roleList, listAccountRolesResponse_roleList - A paginated response with the list of roles and the next token if more
results are available.
httpStatus, listAccountRolesResponse_httpStatus - The response's http status code.
ListAccounts (Paginated)
data ListAccounts Source #
See: newListAccounts smart constructor.
Instances
| ToHeaders ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods toHeaders :: ListAccounts -> [Header] Source # | |||||
| ToPath ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods toPath :: ListAccounts -> ByteString Source # | |||||
| ToQuery ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods toQuery :: ListAccounts -> QueryString Source # | |||||
| AWSPager ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods page :: ListAccounts -> AWSResponse ListAccounts -> Maybe ListAccounts Source # | |||||
| AWSRequest ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Associated Types
Methods request :: (Service -> Service) -> ListAccounts -> Request ListAccounts Source # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccounts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccounts))) Source # | |||||
| NFData ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods rnf :: ListAccounts -> () # | |||||
| Generic ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Associated Types
| |||||
| Show ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods showsPrec :: Int -> ListAccounts -> ShowS # show :: ListAccounts -> String # showList :: [ListAccounts] -> ShowS # | |||||
| Eq ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts | |||||
| Hashable ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts | |||||
| type AWSResponse ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts | |||||
| type Rep ListAccounts Source # | |||||
Defined in Amazonka.SSO.ListAccounts type Rep ListAccounts = D1 ('MetaData "ListAccounts" "Amazonka.SSO.ListAccounts" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" 'False) (C1 ('MetaCons "ListAccounts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))) | |||||
Arguments
| :: Text | |
| -> ListAccounts |
Create a value of ListAccounts 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:
maxResults, listAccounts_maxResults - This is the number of items clients can request per page.
nextToken, listAccounts_nextToken - (Optional) When requesting subsequent pages, this is the page token from
the previous response output.
accessToken, listAccounts_accessToken - The token issued by the CreateToken API call. For more information,
see
CreateToken
in the IAM Identity Center OIDC API Reference Guide.
data ListAccountsResponse Source #
See: newListAccountsResponse smart constructor.
Constructors
| ListAccountsResponse' (Maybe [AccountInfo]) (Maybe Text) Int |
Instances
| NFData ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods rnf :: ListAccountsResponse -> () # | |||||
| Generic ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts Associated Types
Methods from :: ListAccountsResponse -> Rep ListAccountsResponse x # to :: Rep ListAccountsResponse x -> ListAccountsResponse # | |||||
| Read ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods readsPrec :: Int -> ReadS ListAccountsResponse # readList :: ReadS [ListAccountsResponse] # | |||||
| Show ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods showsPrec :: Int -> ListAccountsResponse -> ShowS # show :: ListAccountsResponse -> String # showList :: [ListAccountsResponse] -> ShowS # | |||||
| Eq ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts Methods (==) :: ListAccountsResponse -> ListAccountsResponse -> Bool # (/=) :: ListAccountsResponse -> ListAccountsResponse -> Bool # | |||||
| type Rep ListAccountsResponse Source # | |||||
Defined in Amazonka.SSO.ListAccounts type Rep ListAccountsResponse = D1 ('MetaData "ListAccountsResponse" "Amazonka.SSO.ListAccounts" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" 'False) (C1 ('MetaCons "ListAccountsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccountInfo])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |||||
newListAccountsResponse Source #
Arguments
| :: Int | |
| -> ListAccountsResponse |
Create a value of ListAccountsResponse 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:
accountList, listAccountsResponse_accountList - A paginated response with the list of account information and the next
token if more results are available.
nextToken, listAccountsResponse_nextToken - The page token client that is used to retrieve the list of accounts.
httpStatus, listAccountsResponse_httpStatus - The response's http status code.
Logout
See: newLogout smart constructor.
Instances
| ToJSON Logout Source # | |||||
| ToHeaders Logout Source # | |||||
| ToPath Logout Source # | |||||
Defined in Amazonka.SSO.Logout Methods toPath :: Logout -> ByteString Source # | |||||
| ToQuery Logout Source # | |||||
Defined in Amazonka.SSO.Logout Methods toQuery :: Logout -> QueryString Source # | |||||
| AWSRequest Logout Source # | |||||
Defined in Amazonka.SSO.Logout Associated Types
Methods request :: (Service -> Service) -> Logout -> Request Logout Source # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Logout -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Logout))) Source # | |||||
| NFData Logout Source # | |||||
Defined in Amazonka.SSO.Logout | |||||
| Generic Logout Source # | |||||
Defined in Amazonka.SSO.Logout Associated Types
| |||||
| Show Logout Source # | |||||
| Eq Logout Source # | |||||
| Hashable Logout Source # | |||||
| type AWSResponse Logout Source # | |||||
Defined in Amazonka.SSO.Logout | |||||
| type Rep Logout Source # | |||||
Defined in Amazonka.SSO.Logout | |||||
Create a value of Logout 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:
accessToken, logout_accessToken - The token issued by the CreateToken API call. For more information,
see
CreateToken
in the IAM Identity Center OIDC API Reference Guide.
data LogoutResponse Source #
See: newLogoutResponse smart constructor.
Constructors
| LogoutResponse' |
Instances
| NFData LogoutResponse Source # | |||||
Defined in Amazonka.SSO.Logout Methods rnf :: LogoutResponse -> () # | |||||
| Generic LogoutResponse Source # | |||||
Defined in Amazonka.SSO.Logout Associated Types
Methods from :: LogoutResponse -> Rep LogoutResponse x # to :: Rep LogoutResponse x -> LogoutResponse # | |||||
| Read LogoutResponse Source # | |||||
Defined in Amazonka.SSO.Logout Methods readsPrec :: Int -> ReadS LogoutResponse # readList :: ReadS [LogoutResponse] # | |||||
| Show LogoutResponse Source # | |||||
Defined in Amazonka.SSO.Logout Methods showsPrec :: Int -> LogoutResponse -> ShowS # show :: LogoutResponse -> String # showList :: [LogoutResponse] -> ShowS # | |||||
| Eq LogoutResponse Source # | |||||
Defined in Amazonka.SSO.Logout Methods (==) :: LogoutResponse -> LogoutResponse -> Bool # (/=) :: LogoutResponse -> LogoutResponse -> Bool # | |||||
| type Rep LogoutResponse Source # | |||||
newLogoutResponse :: LogoutResponse Source #
Create a value of LogoutResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
AccountInfo
data AccountInfo Source #
Provides information about your AWS account.
See: newAccountInfo smart constructor.
Instances
| FromJSON AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo Methods parseJSON :: Value -> Parser AccountInfo Source # parseJSONList :: Value -> Parser [AccountInfo] Source # | |||||
| NFData AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo Methods rnf :: AccountInfo -> () # | |||||
| Generic AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo Associated Types
| |||||
| Read AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo Methods readsPrec :: Int -> ReadS AccountInfo # readList :: ReadS [AccountInfo] # readPrec :: ReadPrec AccountInfo # readListPrec :: ReadPrec [AccountInfo] # | |||||
| Show AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo Methods showsPrec :: Int -> AccountInfo -> ShowS # show :: AccountInfo -> String # showList :: [AccountInfo] -> ShowS # | |||||
| Eq AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo | |||||
| Hashable AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo | |||||
| type Rep AccountInfo Source # | |||||
Defined in Amazonka.SSO.Types.AccountInfo type Rep AccountInfo = D1 ('MetaData "AccountInfo" "Amazonka.SSO.Types.AccountInfo" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" '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:
accountId, accountInfo_accountId - The identifier of the AWS account that is assigned to the user.
accountName, accountInfo_accountName - The display name of the AWS account that is assigned to the user.
emailAddress, accountInfo_emailAddress - 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' (Maybe Integer) (Maybe (Sensitive SessionToken)) AccessKey (Sensitive SecretKey) |
Instances
| FromJSON RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Methods parseJSON :: Value -> Parser RoleCredentials Source # parseJSONList :: Value -> Parser [RoleCredentials] Source # | |||||
| NFData RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Methods rnf :: RoleCredentials -> () # | |||||
| Generic RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Associated Types
Methods from :: RoleCredentials -> Rep RoleCredentials x # to :: Rep RoleCredentials x -> RoleCredentials # | |||||
| Show RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Methods showsPrec :: Int -> RoleCredentials -> ShowS # show :: RoleCredentials -> String # showList :: [RoleCredentials] -> ShowS # | |||||
| Eq RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Methods (==) :: RoleCredentials -> RoleCredentials -> Bool # (/=) :: RoleCredentials -> RoleCredentials -> Bool # | |||||
| Hashable RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials Methods hashWithSalt :: Int -> RoleCredentials -> Int Source # hash :: RoleCredentials -> Int Source # | |||||
| type Rep RoleCredentials Source # | |||||
Defined in Amazonka.SSO.Types.RoleCredentials type Rep RoleCredentials = D1 ('MetaData "RoleCredentials" "Amazonka.SSO.Types.RoleCredentials" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" '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))))) | |||||
Arguments
| :: AccessKey | |
| -> SecretKey | |
| -> 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:
expiration, roleCredentials_expiration - The date on which temporary security credentials expire.
sessionToken, 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.
accessKeyId, 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.
secretAccessKey, 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.
RoleInfo
Provides information about the role that is assigned to the user.
See: newRoleInfo smart constructor.
Instances
| FromJSON RoleInfo Source # | |||||
| NFData RoleInfo Source # | |||||
Defined in Amazonka.SSO.Types.RoleInfo | |||||
| Generic RoleInfo Source # | |||||
Defined in Amazonka.SSO.Types.RoleInfo Associated Types
| |||||
| Read RoleInfo Source # | |||||
| Show RoleInfo Source # | |||||
| Eq RoleInfo Source # | |||||
| Hashable RoleInfo Source # | |||||
| type Rep RoleInfo Source # | |||||
Defined in Amazonka.SSO.Types.RoleInfo type Rep RoleInfo = D1 ('MetaData "RoleInfo" "Amazonka.SSO.Types.RoleInfo" "amazonka-sso-2.0-DOouWRdcxDlFDrquCwcbWX" '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:
accountId, roleInfo_accountId - The identifier of the AWS account assigned to the user.
roleName, roleInfo_roleName - The friendly name of the role that is assigned to the user.