- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListRegionsCommand
Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains
parameter.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AccountClient, ListRegionsCommand } from "@aws-sdk/client-account"; // ES Modules import
// const { AccountClient, ListRegionsCommand } = require("@aws-sdk/client-account"); // CommonJS import
const client = new AccountClient(config);
const input = { // ListRegionsRequest
AccountId: "STRING_VALUE",
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
RegionOptStatusContains: [ // RegionOptStatusList
"STRING_VALUE",
],
};
const command = new ListRegionsCommand(input);
const response = await client.send(command);
// { // ListRegionsResponse
// NextToken: "STRING_VALUE",
// Regions: [ // RegionOptList
// { // Region
// RegionName: "STRING_VALUE",
// RegionOptStatus: "STRING_VALUE",
// },
// ],
// };
ListRegionsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AccountId | string | undefined | Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled , and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. |
MaxResults | number | undefined | The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a |
NextToken | string | undefined | A token used to specify where to start paginating. This is the |
RegionOptStatusContains | RegionOptStatus[] | undefined | A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING. |
ListRegionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | If there is more data to be returned, this will be populated. It should be passed into the |
Regions | Region[] | undefined | This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The operation failed because the calling identity doesn't have the minimum required permissions. |
InternalServerException | server | The operation failed because of an error internal to Amazon Web Services. Try your operation again later. |
TooManyRequestsException | client | The operation failed because it was called too frequently and exceeded a throttle limit. |
ValidationException | client | The operation failed because one of the input parameters was invalid. |
AccountServiceException | Base exception class for all service exceptions from Account service. |