Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListAccountAliasesCommand

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.

Example Syntax

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

import { IAMClient, ListAccountAliasesCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListAccountAliasesCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ListAccountAliasesRequest
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListAccountAliasesCommand(input);
const response = await client.send(command);
// { // ListAccountAliasesResponse
//   AccountAliases: [ // accountAliasListType // required
//     "STRING_VALUE",
//   ],
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
// };

Example Usage

Loading code editor

ListAccountAliasesCommand Input

See ListAccountAliasesCommandInput for more details

Parameter	Type	Description
`Marker`	`string \| undefined`	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the `Marker` element in the response that you received to indicate where the next call should start.
`MaxItems`	`number \| undefined`	Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the `IsTruncated` response element is `true`. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the `IsTruncated` response element returns `true`, and `Marker` contains a value to include in the subsequent call that tells the service where to continue from.

ListAccountAliasesCommand Output

See ListAccountAliasesCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`AccountAliases` Required	`string[] \| undefined`	A list of aliases associated with the account. Amazon Web Services supports only one alias per account.
`IsTruncated`	`boolean \| undefined`	A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the `Marker` request parameter to retrieve more items. Note that IAM might return fewer than the `MaxItems` number of results even when there are more results available. We recommend that you check `IsTruncated` after every call to ensure that you receive all your results.
`Marker`	`string \| undefined`	When `IsTruncated` is `true`, this element is present and contains the value to use for the `Marker` parameter in a subsequent pagination request.

Throws

Name	Fault	Details
ServiceFailureException	server	The request processing has failed because of an unknown error, exception or failure.
IAMServiceException		Base exception class for all service exceptions from IAM service.

Getting Started

References