GetRegionOptStatusCommand

Suggest an Edit

Retrieves the opt-in status of a particular Region.

Example Syntax

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

import { AccountClient, GetRegionOptStatusCommand } from "@aws-sdk/client-account"; // ES Modules import
// const { AccountClient, GetRegionOptStatusCommand } = require("@aws-sdk/client-account"); // CommonJS import
const client = new AccountClient(config);
const input = { // GetRegionOptStatusRequest
  AccountId: "STRING_VALUE",
  RegionName: "STRING_VALUE", // required
};
const command = new GetRegionOptStatusCommand(input);
const response = await client.send(command);
// { // GetRegionOptStatusResponse
//   RegionName: "STRING_VALUE",
//   RegionOptStatus: "STRING_VALUE",
// };

GetRegionOptStatusCommand Input

See GetRegionOptStatusCommandInput for more details

Parameter
Type
Description
RegionName
Required
string | undefined

Specifies the Region-code for a given Region name (for example, af-south-1). This function will return the status of whatever Region you pass into this parameter.

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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.

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.

GetRegionOptStatusCommand Output

See GetRegionOptStatusCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RegionName
string | undefined

The Region code that was passed in.

RegionOptStatus
RegionOptStatus | undefined

One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).

Throws

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.