amazonka-chime-2.0: Amazon Chime SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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
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 #

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

Methods

showsPrec :: Int -> ListAccounts -> ShowS #

show :: ListAccounts -> String #

showList :: [ListAccounts] -> ShowS #

NFData ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

rnf :: ListAccounts -> () #

Eq ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

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

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

Hashable ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

hashWithSalt :: Int -> ListAccounts -> Int #

hash :: ListAccounts -> Int #

type AWSResponse ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type AWSResponse ListAccounts = ListAccountsResponse
type Rep ListAccounts Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type Rep ListAccounts = D1 ('MetaData "ListAccounts" "Amazonka.Chime.ListAccounts" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListAccounts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

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:maxResults:ListAccounts', listAccounts_maxResults - The maximum number of results to return in a single call. Defaults to 100.

ListAccounts, listAccounts_name - Amazon Chime account name prefix with which to filter results.

ListAccounts, listAccounts_nextToken - The token to use to retrieve the next page of results.

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

Request Lenses

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

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

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

Amazon Chime account name prefix with which to filter results.

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

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

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

User email address with which to filter results.

Destructuring the Response

data ListAccountsResponse Source #

See: newListAccountsResponse smart constructor.

Constructors

ListAccountsResponse' 

Fields

Instances

Instances details
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 #

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 #

NFData ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

rnf :: ListAccountsResponse -> () #

Eq ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

Methods

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

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

type Rep ListAccountsResponse Source # 
Instance details

Defined in Amazonka.Chime.ListAccounts

type Rep ListAccountsResponse = D1 ('MetaData "ListAccountsResponse" "Amazonka.Chime.ListAccounts" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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.

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.