libZSservicesZSamazonka-ssoZSamazonka-sso
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ListAccounts Source #

See: newListAccounts smart constructor.

Constructors

ListAccounts' 

Fields

Instances

Instances details
Eq ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Show ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Generic ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Associated Types

type Rep ListAccounts :: Type -> Type #

NFData ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Methods

rnf :: ListAccounts -> () #

Hashable ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

AWSPager ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

AWSRequest ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Associated Types

type AWSResponse ListAccounts #

ToHeaders ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

ToPath ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

ToQuery ListAccounts Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

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

newListAccounts Source #

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

Instances details
Eq ListAccountsResponse Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Read ListAccountsResponse Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Show ListAccountsResponse Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Generic ListAccountsResponse Source # 
Instance details

Defined in Amazonka.SSO.ListAccounts

Associated Types

type Rep ListAccountsResponse :: Type -> Type #

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 #

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.