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

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

Derived from API version 2019-06-10 of the AWS service descriptions, licensed under Apache 2.0.

AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO 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 AWS SSO 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 => 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 Logout = Logout' (Sensitive Text)
newLogout :: Text -> Logout
data LogoutResponse = LogoutResponse' {
}
newLogoutResponse :: LogoutResponse
data GetRoleCredentials = GetRoleCredentials' Text Text (Sensitive Text)
newGetRoleCredentials :: Text -> Text -> Text -> GetRoleCredentials
data GetRoleCredentialsResponse = GetRoleCredentialsResponse' (Maybe RoleCredentials) Int
newGetRoleCredentialsResponse :: Int -> GetRoleCredentialsResponse
data ListAccounts = ListAccounts' (Maybe Text) (Maybe Natural) (Sensitive Text)
newListAccounts :: Text -> ListAccounts
data ListAccountsResponse = ListAccountsResponse' (Maybe [AccountInfo]) (Maybe Text) Int
newListAccountsResponse :: Int -> ListAccountsResponse
data ListAccountRoles = ListAccountRoles' (Maybe Text) (Maybe Natural) (Sensitive Text) Text
newListAccountRoles :: Text -> Text -> ListAccountRoles
data ListAccountRolesResponse = ListAccountRolesResponse' (Maybe [RoleInfo]) (Maybe Text) Int
newListAccountRolesResponse :: Int -> ListAccountRolesResponse
data AccountInfo = AccountInfo' (Maybe Text) (Maybe Text) (Maybe Text)
newAccountInfo :: AccountInfo
data RoleCredentials = RoleCredentials' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Text)
newRoleCredentials :: 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 => 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

_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

_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

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

The specified resource doesn't exist.

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.

Logout

data Logout Source #

See: newLogout smart constructor.

Constructors

Logout' (Sensitive Text)

Instances

Instances details

Eq Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods (==) :: Logout -> Logout -> Bool # (/=) :: Logout -> Logout -> Bool #
Show Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods showsPrec :: Int -> Logout -> ShowS # show :: Logout -> String # showList :: [Logout] -> ShowS #
Generic Logout Source #
Instance details Defined in Amazonka.SSO.Logout Associated Types type Rep Logout :: Type -> Type # Methods from :: Logout -> Rep Logout x # to :: Rep Logout x -> Logout #
NFData Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods rnf :: Logout -> () #
Hashable Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods hashWithSalt :: Int -> Logout -> Int # hash :: Logout -> Int #
ToJSON Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods toJSON :: Logout -> Value # toEncoding :: Logout -> Encoding # toJSONList :: [Logout] -> Value # toEncodingList :: [Logout] -> Encoding #
AWSRequest Logout Source #
Instance details Defined in Amazonka.SSO.Logout Associated Types type AWSResponse Logout # Methods request :: Logout -> Request Logout # response :: MonadResource m => Logger -> Service -> Proxy Logout -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Logout))) #
ToHeaders Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods toHeaders :: Logout -> [Header] #
ToPath Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods toPath :: Logout -> ByteString #
ToQuery Logout Source #
Instance details Defined in Amazonka.SSO.Logout Methods toQuery :: Logout -> QueryString #
type Rep Logout Source #
Instance details Defined in Amazonka.SSO.Logout type Rep Logout = D1 ('MetaData "Logout" "Amazonka.SSO.Logout" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "Logout'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))
type AWSResponse Logout Source #
Instance details Defined in Amazonka.SSO.Logout type AWSResponse Logout = LogoutResponse

newLogout Source #

Arguments

:: Text	`$sel:accessToken:Logout'`
-> 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:

$sel:accessToken:Logout', logout_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

data LogoutResponse Source #

See: newLogoutResponse smart constructor.

Constructors

LogoutResponse'

Instances

Instances details

Eq LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods (==) :: LogoutResponse -> LogoutResponse -> Bool # (/=) :: LogoutResponse -> LogoutResponse -> Bool #
Read LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods readsPrec :: Int -> ReadS LogoutResponse # readList :: ReadS [LogoutResponse] # readPrec :: ReadPrec LogoutResponse # readListPrec :: ReadPrec [LogoutResponse] #
Show LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods showsPrec :: Int -> LogoutResponse -> ShowS # show :: LogoutResponse -> String # showList :: [LogoutResponse] -> ShowS #
Generic LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Associated Types type Rep LogoutResponse :: Type -> Type # Methods from :: LogoutResponse -> Rep LogoutResponse x # to :: Rep LogoutResponse x -> LogoutResponse #
NFData LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods rnf :: LogoutResponse -> () #
type Rep LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout type Rep LogoutResponse = D1 ('MetaData "LogoutResponse" "Amazonka.SSO.Logout" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "LogoutResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newLogoutResponse :: LogoutResponse Source #

Create a value of LogoutResponse with all optional fields omitted.

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

GetRoleCredentials

data GetRoleCredentials Source #

See: newGetRoleCredentials smart constructor.

Constructors

GetRoleCredentials' Text Text (Sensitive Text)

Instances

Instances details

Eq GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods (==) :: GetRoleCredentials -> GetRoleCredentials -> Bool # (/=) :: GetRoleCredentials -> GetRoleCredentials -> Bool #
Show GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods showsPrec :: Int -> GetRoleCredentials -> ShowS # show :: GetRoleCredentials -> String # showList :: [GetRoleCredentials] -> ShowS #
Generic GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type Rep GetRoleCredentials :: Type -> Type # Methods from :: GetRoleCredentials -> Rep GetRoleCredentials x # to :: Rep GetRoleCredentials x -> GetRoleCredentials #
NFData GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods rnf :: GetRoleCredentials -> () #
Hashable GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods hashWithSalt :: Int -> GetRoleCredentials -> Int # hash :: GetRoleCredentials -> Int #
AWSRequest GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type AWSResponse GetRoleCredentials # Methods request :: GetRoleCredentials -> Request GetRoleCredentials # response :: MonadResource m => Logger -> Service -> Proxy GetRoleCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoleCredentials))) #
ToHeaders GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toHeaders :: GetRoleCredentials -> [Header] #
ToPath GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toPath :: GetRoleCredentials -> ByteString #
ToQuery GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods toQuery :: GetRoleCredentials -> QueryString #
type Rep GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type Rep GetRoleCredentials = D1 ('MetaData "GetRoleCredentials" "Amazonka.SSO.GetRoleCredentials" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "GetRoleCredentials'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))
type AWSResponse GetRoleCredentials Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type AWSResponse GetRoleCredentials = GetRoleCredentialsResponse

newGetRoleCredentials Source #

Arguments

:: Text	`$sel:roleName:GetRoleCredentials'`
-> Text	`$sel:accountId:GetRoleCredentials'`
-> Text	`$sel:accessToken:GetRoleCredentials'`
-> 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:

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

$sel:accountId:GetRoleCredentials', getRoleCredentials_accountId - The identifier for the AWS account that is assigned to the user.

$sel:accessToken:GetRoleCredentials', getRoleCredentials_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

data GetRoleCredentialsResponse Source #

See: newGetRoleCredentialsResponse smart constructor.

Constructors

GetRoleCredentialsResponse' (Maybe RoleCredentials) Int

Instances

Instances details

Eq GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods (==) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool # (/=) :: GetRoleCredentialsResponse -> GetRoleCredentialsResponse -> Bool #
Show GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods showsPrec :: Int -> GetRoleCredentialsResponse -> ShowS # show :: GetRoleCredentialsResponse -> String # showList :: [GetRoleCredentialsResponse] -> ShowS #
Generic GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Associated Types type Rep GetRoleCredentialsResponse :: Type -> Type # Methods from :: GetRoleCredentialsResponse -> Rep GetRoleCredentialsResponse x # to :: Rep GetRoleCredentialsResponse x -> GetRoleCredentialsResponse #
NFData GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials Methods rnf :: GetRoleCredentialsResponse -> () #
type Rep GetRoleCredentialsResponse Source #
Instance details Defined in Amazonka.SSO.GetRoleCredentials type Rep GetRoleCredentialsResponse = D1 ('MetaData "GetRoleCredentialsResponse" "Amazonka.SSO.GetRoleCredentials" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "GetRoleCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoleCredentials)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetRoleCredentialsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRoleCredentialsResponse'`
-> 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:

$sel:roleCredentials:GetRoleCredentialsResponse', getRoleCredentialsResponse_roleCredentials - The credentials for the role that is assigned to the user.

$sel:httpStatus:GetRoleCredentialsResponse', getRoleCredentialsResponse_httpStatus - The response's http status code.

ListAccounts (Paginated)

data ListAccounts Source #

See: newListAccounts smart constructor.

Constructors

ListAccounts' (Maybe Text) (Maybe Natural) (Sensitive Text)

Instances

Instances details

Eq ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods (==) :: ListAccounts -> ListAccounts -> Bool # (/=) :: ListAccounts -> ListAccounts -> Bool #
Show ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods showsPrec :: Int -> ListAccounts -> ShowS # show :: ListAccounts -> String # showList :: [ListAccounts] -> ShowS #
Generic ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Associated Types type Rep ListAccounts :: Type -> Type # Methods from :: ListAccounts -> Rep ListAccounts x # to :: Rep ListAccounts x -> ListAccounts #
NFData ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods rnf :: ListAccounts -> () #
Hashable ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods hashWithSalt :: Int -> ListAccounts -> Int # hash :: ListAccounts -> Int #
AWSPager ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods page :: ListAccounts -> AWSResponse ListAccounts -> Maybe ListAccounts #
AWSRequest ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Associated Types type AWSResponse ListAccounts # Methods request :: ListAccounts -> Request ListAccounts # response :: MonadResource m => Logger -> Service -> Proxy ListAccounts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccounts))) #
ToHeaders ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods toHeaders :: ListAccounts -> [Header] #
ToPath ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods toPath :: ListAccounts -> ByteString #
ToQuery ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods toQuery :: ListAccounts -> QueryString #
type Rep ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts type Rep ListAccounts = D1 ('MetaData "ListAccounts" "Amazonka.SSO.ListAccounts" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "ListAccounts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))
type AWSResponse ListAccounts Source #
Instance details Defined in Amazonka.SSO.ListAccounts type AWSResponse ListAccounts = ListAccountsResponse

newListAccounts Source #

Arguments

:: Text	`$sel:accessToken:ListAccounts'`
-> 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:

$sel:nextToken:ListAccounts', listAccounts_nextToken - (Optional) When requesting subsequent pages, this is the page token from the previous response output.

$sel:maxResults:ListAccounts', listAccounts_maxResults - This is the number of items clients can request per page.

$sel:accessToken:ListAccounts', listAccounts_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

data ListAccountsResponse Source #

See: newListAccountsResponse smart constructor.

Constructors

ListAccountsResponse' (Maybe [AccountInfo]) (Maybe Text) Int

Instances

Instances details

Eq ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods (==) :: ListAccountsResponse -> ListAccountsResponse -> Bool # (/=) :: ListAccountsResponse -> ListAccountsResponse -> Bool #
Read ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods readsPrec :: Int -> ReadS ListAccountsResponse # readList :: ReadS [ListAccountsResponse] # readPrec :: ReadPrec ListAccountsResponse # readListPrec :: ReadPrec [ListAccountsResponse] #
Show ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods showsPrec :: Int -> ListAccountsResponse -> ShowS # show :: ListAccountsResponse -> String # showList :: [ListAccountsResponse] -> ShowS #
Generic ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts Associated Types type Rep ListAccountsResponse :: Type -> Type # Methods from :: ListAccountsResponse -> Rep ListAccountsResponse x # to :: Rep ListAccountsResponse x -> ListAccountsResponse #
NFData ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts Methods rnf :: ListAccountsResponse -> () #
type Rep ListAccountsResponse Source #
Instance details Defined in Amazonka.SSO.ListAccounts type Rep ListAccountsResponse = D1 ('MetaData "ListAccountsResponse" "Amazonka.SSO.ListAccounts" "libZSservicesZSamazonka-ssoZSamazonka-sso" '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	`$sel:httpStatus:ListAccountsResponse'`
-> 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:

$sel:accountList:ListAccountsResponse', listAccountsResponse_accountList - A paginated response with the list of account information and the next token if more results are available.

$sel:nextToken:ListAccounts', listAccountsResponse_nextToken - The page token client that is used to retrieve the list of accounts.

$sel:httpStatus:ListAccountsResponse', listAccountsResponse_httpStatus - The response's http status code.

ListAccountRoles (Paginated)

data ListAccountRoles Source #

See: newListAccountRoles smart constructor.

Constructors

ListAccountRoles' (Maybe Text) (Maybe Natural) (Sensitive Text) Text

Instances

Instances details

Eq ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRoles -> ListAccountRoles -> Bool # (/=) :: ListAccountRoles -> ListAccountRoles -> Bool #
Show ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods showsPrec :: Int -> ListAccountRoles -> ShowS # show :: ListAccountRoles -> String # showList :: [ListAccountRoles] -> ShowS #
Generic ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Associated Types type Rep ListAccountRoles :: Type -> Type # Methods from :: ListAccountRoles -> Rep ListAccountRoles x # to :: Rep ListAccountRoles x -> ListAccountRoles #
NFData ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRoles -> () #
Hashable ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods hashWithSalt :: Int -> ListAccountRoles -> Int # hash :: ListAccountRoles -> Int #
AWSPager ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods page :: ListAccountRoles -> AWSResponse ListAccountRoles -> Maybe ListAccountRoles #
AWSRequest ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Associated Types type AWSResponse ListAccountRoles # Methods request :: ListAccountRoles -> Request ListAccountRoles # response :: MonadResource m => Logger -> Service -> Proxy ListAccountRoles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccountRoles))) #
ToHeaders ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods toHeaders :: ListAccountRoles -> [Header] #
ToPath ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods toPath :: ListAccountRoles -> ByteString #
ToQuery ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods toQuery :: ListAccountRoles -> QueryString #
type Rep ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRoles = D1 ('MetaData "ListAccountRoles" "Amazonka.SSO.ListAccountRoles" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "ListAccountRoles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type AWSResponse ListAccountRoles = ListAccountRolesResponse

newListAccountRoles Source #

Arguments

:: Text	`$sel:accessToken:ListAccountRoles'`
-> Text	`$sel:accountId:ListAccountRoles'`
-> 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:

$sel:nextToken:ListAccountRoles', listAccountRoles_nextToken - The page token from the previous response output when you request subsequent pages.

$sel:maxResults:ListAccountRoles', listAccountRoles_maxResults - The number of items that clients can request per page.

$sel:accessToken:ListAccountRoles', listAccountRoles_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

$sel:accountId:ListAccountRoles', listAccountRoles_accountId - The identifier for the AWS account that is assigned to the user.

data ListAccountRolesResponse Source #

See: newListAccountRolesResponse smart constructor.

Constructors

ListAccountRolesResponse' (Maybe [RoleInfo]) (Maybe Text) Int

Instances

Instances details

Eq ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool # (/=) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool #
Read ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods readsPrec :: Int -> ReadS ListAccountRolesResponse # readList :: ReadS [ListAccountRolesResponse] # readPrec :: ReadPrec ListAccountRolesResponse # readListPrec :: ReadPrec [ListAccountRolesResponse] #
Show ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods showsPrec :: Int -> ListAccountRolesResponse -> ShowS # show :: ListAccountRolesResponse -> String # showList :: [ListAccountRolesResponse] -> ShowS #
Generic ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Associated Types type Rep ListAccountRolesResponse :: Type -> Type # Methods from :: ListAccountRolesResponse -> Rep ListAccountRolesResponse x # to :: Rep ListAccountRolesResponse x -> ListAccountRolesResponse #
NFData ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRolesResponse -> () #
type Rep ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRolesResponse = D1 ('MetaData "ListAccountRolesResponse" "Amazonka.SSO.ListAccountRoles" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "ListAccountRolesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RoleInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAccountRolesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAccountRolesResponse'`
-> 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:

$sel:roleList:ListAccountRolesResponse', listAccountRolesResponse_roleList - A paginated response with the list of roles and the next token if more results are available.

$sel:nextToken:ListAccountRoles', listAccountRolesResponse_nextToken - The page token client that is used to retrieve the list of accounts.

$sel:httpStatus:ListAccountRolesResponse', listAccountRolesResponse_httpStatus - The response's http status code.

Types

AccountInfo

data AccountInfo Source #

Provides information about your AWS account.

See: newAccountInfo smart constructor.

Constructors

AccountInfo' (Maybe Text) (Maybe Text) (Maybe Text)

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.

RoleCredentials

data RoleCredentials Source #

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

See: newRoleCredentials smart constructor.

Constructors

RoleCredentials' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Text)

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.

RoleInfo

data RoleInfo Source #

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

See: newRoleInfo smart constructor.

Constructors

RoleInfo' (Maybe Text) (Maybe Text)

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.