ListAccountsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeClient, ListAccountsCommand } from "@aws-sdk/client-chime"; // ES Modules import
// const { ChimeClient, ListAccountsCommand } = require("@aws-sdk/client-chime"); // CommonJS import
const client = new ChimeClient(config);
const input = { // ListAccountsRequest
  Name: "STRING_VALUE",
  UserEmail: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListAccountsCommand(input);
const response = await client.send(command);
// { // ListAccountsResponse
//   Accounts: [ // AccountList
//     { // Account
//       AwsAccountId: "STRING_VALUE", // required
//       AccountId: "STRING_VALUE", // required
//       Name: "STRING_VALUE", // required
//       AccountType: "Team" || "EnterpriseDirectory" || "EnterpriseLWA" || "EnterpriseOIDC",
//       CreatedTimestamp: new Date("TIMESTAMP"),
//       DefaultLicense: "Basic" || "Plus" || "Pro" || "ProTrial",
//       SupportedLicenses: [ // LicenseList
//         "Basic" || "Plus" || "Pro" || "ProTrial",
//       ],
//       AccountStatus: "Suspended" || "Active",
//       SigninDelegateGroups: [ // SigninDelegateGroupList
//         { // SigninDelegateGroup
//           GroupName: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListAccountsCommand Input

See ListAccountsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

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

Name
string | undefined

Amazon Chime account name prefix with which to filter results.

NextToken
string | undefined

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

UserEmail
string | undefined

User email address with which to filter results.

ListAccountsCommand Output

See ListAccountsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Accounts
Account[] | undefined

List of Amazon Chime accounts and account details.

NextToken
string | undefined

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

Throws

Name
Fault
Details
BadRequestException
client

The input parameters don't match the service's restrictions.

ForbiddenException
client

The client is permanently forbidden from making the request.

NotFoundException
client

One or more of the resources in the request does not exist in the system.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The client exceeded its request rate limit.

UnauthorizedClientException
client

The client is not currently authorized to make the request.

ChimeServiceException
Base exception class for all service exceptions from Chime service.