| 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.ListAccounts
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 AWS SSO User Guide. This operation returns a paginated response.
This operation returns paginated results.
Synopsis
- data ListAccounts = ListAccounts' {}
- newListAccounts :: Text -> ListAccounts
- listAccounts_nextToken :: Lens' ListAccounts (Maybe Text)
- listAccounts_maxResults :: Lens' ListAccounts (Maybe Natural)
- listAccounts_accessToken :: Lens' ListAccounts Text
- data ListAccountsResponse = ListAccountsResponse' {
- accountList :: Maybe [AccountInfo]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListAccountsResponse :: Int -> ListAccountsResponse
- listAccountsResponse_accountList :: Lens' ListAccountsResponse (Maybe [AccountInfo])
- listAccountsResponse_nextToken :: Lens' ListAccountsResponse (Maybe Text)
- listAccountsResponse_httpStatus :: Lens' ListAccountsResponse Int
Creating a Request
data ListAccounts Source #
See: newListAccounts smart constructor.
Constructors
| ListAccounts' | |
Fields
| |
Instances
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:
$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.
Request Lenses
listAccounts_nextToken :: Lens' ListAccounts (Maybe Text) Source #
(Optional) When requesting subsequent pages, this is the page token from the previous response output.
listAccounts_maxResults :: Lens' ListAccounts (Maybe Natural) Source #
This is the number of items clients can request per page.
listAccounts_accessToken :: Lens' ListAccounts Text Source #
The token issued by the CreateToken API call. For more information,
see
CreateToken
in the AWS SSO OIDC API Reference Guide.
Destructuring the Response
data ListAccountsResponse Source #
See: newListAccountsResponse smart constructor.
Constructors
| ListAccountsResponse' | |
Fields
| |
Instances
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:
$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.
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.