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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all roles that are assigned to the user for a given AWS account.

This operation returns paginated results.

Synopsis

data ListAccountRoles = ListAccountRoles' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- accessToken :: Sensitive Text
- accountId :: Text
}
newListAccountRoles :: Text -> Text -> ListAccountRoles
listAccountRoles_maxResults :: Lens' ListAccountRoles (Maybe Natural)
listAccountRoles_nextToken :: Lens' ListAccountRoles (Maybe Text)
listAccountRoles_accessToken :: Lens' ListAccountRoles Text
listAccountRoles_accountId :: Lens' ListAccountRoles Text
data ListAccountRolesResponse = ListAccountRolesResponse' {
- nextToken :: Maybe Text
- roleList :: Maybe [RoleInfo]
- httpStatus :: Int
}
newListAccountRolesResponse :: Int -> ListAccountRolesResponse
listAccountRolesResponse_nextToken :: Lens' ListAccountRolesResponse (Maybe Text)
listAccountRolesResponse_roleList :: Lens' ListAccountRolesResponse (Maybe [RoleInfo])
listAccountRolesResponse_httpStatus :: Lens' ListAccountRolesResponse Int

Creating a Request

data ListAccountRoles Source #

See: newListAccountRoles smart constructor.

Constructors

ListAccountRoles'

Fields

maxResults :: Maybe Natural
The number of items that clients can request per page.
nextToken :: Maybe Text
The page token from the previous response output when you request subsequent pages.
accessToken :: Sensitive Text
The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.
accountId :: Text
The identifier for the AWS account that is assigned to the user.

Instances

Instances details

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 #
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 :: (Service -> Service) -> ListAccountRoles -> Request ListAccountRoles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccountRoles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccountRoles))) #
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 #
Show ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods showsPrec :: Int -> ListAccountRoles -> ShowS # show :: ListAccountRoles -> String # showList :: [ListAccountRoles] -> ShowS #
NFData ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRoles -> () #
Eq ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRoles -> ListAccountRoles -> Bool # (/=) :: ListAccountRoles -> ListAccountRoles -> Bool #
Hashable ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods hashWithSalt :: Int -> ListAccountRoles -> Int # hash :: ListAccountRoles -> Int #
type AWSResponse ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type AWSResponse ListAccountRoles = ListAccountRolesResponse
type Rep ListAccountRoles Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRoles = D1 ('MetaData "ListAccountRoles" "Amazonka.SSO.ListAccountRoles" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" '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))))

newListAccountRoles Source #

Arguments

:: Text	`$sel:accessToken:ListAccountRoles'`
-> Text	`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:maxResults:ListAccountRoles', listAccountRoles_maxResults - The number of items that clients can request per page.

ListAccountRoles, listAccountRoles_nextToken - The page token from the previous response output when you request subsequent pages.

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

ListAccountRoles, listAccountRoles_accountId - The identifier for the AWS account that is assigned to the user.

Request Lenses

listAccountRoles_maxResults :: Lens' ListAccountRoles (Maybe Natural) Source #

The number of items that clients can request per page.

listAccountRoles_nextToken :: Lens' ListAccountRoles (Maybe Text) Source #

The page token from the previous response output when you request subsequent pages.

listAccountRoles_accessToken :: Lens' ListAccountRoles Text Source #

The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

listAccountRoles_accountId :: Lens' ListAccountRoles Text Source #

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

Destructuring the Response

data ListAccountRolesResponse Source #

See: newListAccountRolesResponse smart constructor.

Constructors

ListAccountRolesResponse'
Fields nextToken :: Maybe Text The page token client that is used to retrieve the list of accounts. roleList :: Maybe [RoleInfo] A paginated response with the list of roles and the next token if more results are available. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods rnf :: ListAccountRolesResponse -> () #
Eq ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles Methods (==) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool # (/=) :: ListAccountRolesResponse -> ListAccountRolesResponse -> Bool #
type Rep ListAccountRolesResponse Source #
Instance details Defined in Amazonka.SSO.ListAccountRoles type Rep ListAccountRolesResponse = D1 ('MetaData "ListAccountRolesResponse" "Amazonka.SSO.ListAccountRoles" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" '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	`$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:

ListAccountRoles, listAccountRolesResponse_nextToken - The page token client that is used to retrieve the list of accounts.

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

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

Response Lenses

listAccountRolesResponse_nextToken :: Lens' ListAccountRolesResponse (Maybe Text) Source #

The page token client that is used to retrieve the list of accounts.

listAccountRolesResponse_roleList :: Lens' ListAccountRolesResponse (Maybe [RoleInfo]) Source #

A paginated response with the list of roles and the next token if more results are available.

listAccountRolesResponse_httpStatus :: Lens' ListAccountRolesResponse Int Source #

The response's http status code.