libZSservicesZSamazonka-chimeZSamazonka-chime
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.Chime.ListAccounts

Description

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

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

Methods

(==) :: ListAccounts -> ListAccounts -> Bool #

(/=) :: ListAccounts -> ListAccounts -> Bool #

Show ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

showsPrec :: Int -> ListAccounts -> ShowS #

show :: ListAccounts -> String #

showList :: [ListAccounts] -> ShowS #

Generic ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.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.Chime.ListAccounts

Methods

rnf :: ListAccounts -> () #

Hashable ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

hashWithSalt :: Int -> ListAccounts -> Int #

hash :: ListAccounts -> Int #

AWSPager ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

page :: ListAccounts -> AWSResponse ListAccounts -> Maybe ListAccounts #

AWSRequest ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.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.Chime.ListAccounts

Methods

toHeaders :: ListAccounts -> [Header] #

ToPath ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

toPath :: ListAccounts -> ByteString #

ToQuery ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

toQuery :: ListAccounts -> QueryString #

type Rep ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type Rep ListAccounts = D1 ('MetaData "ListAccounts" "Amazonka.Chime.ListAccounts" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "ListAccounts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type AWSResponse ListAccounts = ListAccountsResponse

newListAccounts :: ListAccounts 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 - The token to use to retrieve the next page of results.

$sel:name:ListAccounts', listAccounts_name - Amazon Chime account name prefix with which to filter results.

$sel:userEmail:ListAccounts', listAccounts_userEmail - User email address with which to filter results.

$sel:maxResults:ListAccounts', listAccounts_maxResults - The maximum number of results to return in a single call. Defaults to 100.

Request Lenses

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

The token to use to retrieve the next page of results.

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

Amazon Chime account name prefix with which to filter results.

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

User email address with which to filter results.

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

The maximum number of results to return in a single call. Defaults to 100.

Destructuring the Response

data ListAccountsResponse Source #

See: newListAccountsResponse smart constructor.

Constructors

ListAccountsResponse' 

Fields

Instances

Instances details
Eq ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

(==) :: ListAccountsResponse -> ListAccountsResponse -> Bool #

(/=) :: ListAccountsResponse -> ListAccountsResponse -> Bool #

Read ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

readsPrec :: Int -> ReadS ListAccountsResponse #

readList :: ReadS [ListAccountsResponse] #

readPrec :: ReadPrec ListAccountsResponse #

readListPrec :: ReadPrec [ListAccountsResponse] #

Show ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

showsPrec :: Int -> ListAccountsResponse -> ShowS #

show :: ListAccountsResponse -> String #

showList :: [ListAccountsResponse] -> ShowS #

Generic ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.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.Chime.ListAccounts

Methods

rnf :: ListAccountsResponse -> () #

type Rep ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type Rep ListAccountsResponse = D1 ('MetaData "ListAccountsResponse" "Amazonka.Chime.ListAccounts" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "ListAccountsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Account])) :*: (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:accounts:ListAccountsResponse', listAccountsResponse_accounts - List of Amazon Chime accounts and account details.

$sel:nextToken:ListAccounts', listAccountsResponse_nextToken - The token to use to retrieve the next page of results.

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

Response Lenses

listAccountsResponse_accounts :: Lens' ListAccountsResponse (Maybe [Account]) Source #

List of Amazon Chime accounts and account details.

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

The token to use to retrieve the next page of results.

listAccountsResponse_httpStatus :: Lens' ListAccountsResponse Int Source #

The response's http status code.