Skip to content

Disable Region

account_disable_region R Documentation

Disables (opts-out) a particular Region for an account

Description

Disables (opts-out) a particular Region for an account.

The act of disabling a Region will remove all IAM access to any resources that reside in that Region.

Usage

account_disable_region(AccountId, RegionName)

Arguments

AccountId

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.

RegionName

[required] Specifies the Region-code for a given Region name (for example, af-south-1). When you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.

Value

An empty list.

Request syntax

svc$disable_region(
  AccountId = "string",
  RegionName = "string"
)