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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the IAM Identity Center User Guide. This operation returns a paginated response.

This operation returns paginated results.

Creating a Request

data ListAccounts Source #

See: newListAccounts smart constructor.

Constructors

ListAccounts'
Fields maxResults :: Maybe Natural This is the number of items clients can request per page. nextToken :: Maybe Text (Optional) When requesting subsequent pages, this is the page token from the previous response output. 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.

Instances

Instances details

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

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:maxResults:ListAccounts', listAccounts_maxResults - This is the number of items clients can request per page.

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

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

Request Lenses

listAccounts_maxResults :: Lens' ListAccounts (Maybe Natural) Source #

This is the number of items clients can request per page.

listAccounts_nextToken :: Lens' ListAccounts (Maybe Text) Source #

(Optional) When requesting subsequent pages, this is the page token from the previous response output.

listAccounts_accessToken :: Lens' ListAccounts Text Source #

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

Destructuring the Response

data ListAccountsResponse Source #

See: newListAccountsResponse smart constructor.

Constructors

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

Instances

Instances details

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

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.

Response Lenses

listAccountsResponse_accountList :: Lens' ListAccountsResponse (Maybe [AccountInfo]) Source #

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

listAccountsResponse_nextToken :: Lens' ListAccountsResponse (Maybe Text) Source #

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

listAccountsResponse_httpStatus :: Lens' ListAccountsResponse Int Source #

The response's http status code.