1. Packages
  2. AWS
  3. API Docs
  4. account
  5. getRegions
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.account.getRegions

aws logo
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    The aws.account.getRegions data source lets you query AWS region information for any account in your AWS Organization. It uses the AWS Account REST Service to show all regions, including those that are enabled, disabled, or in the process of being enabled or disabled. You can list regions for any organization account, see all possible region opt-in statuses (ENABLED, ENABLING, DISABLING, DISABLED, ENABLED_BY_DEFAULT), and check which regions are being enabled or disabled.

    This is more comprehensive than the aws.getRegions data source, which only uses the EC2 REST service and is limited to the current account and a subset of region statuses.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.account.getRegions({});

    import pulumi
import pulumi_aws as aws

example = aws.account.get_regions()

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/account"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := account.GetRegions(ctx, &account.GetRegionsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Account.GetRegions.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.account.AccountFunctions;
import com.pulumi.aws.account.inputs.GetRegionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AccountFunctions.getRegions(GetRegionsArgs.builder()
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:account:getRegions
      arguments: {}

    Using getRegions

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRegions(args: GetRegionsArgs, opts?: InvokeOptions): Promise<GetRegionsResult>
function getRegionsOutput(args: GetRegionsOutputArgs, opts?: InvokeOptions): Output<GetRegionsResult>
    def get_regions(account_id: Optional[str] = None,
                region_opt_status_contains: Optional[Sequence[str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetRegionsResult
def get_regions_output(account_id: Optional[pulumi.Input[str]] = None,
                region_opt_status_contains: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRegionsResult]
    func GetRegions(ctx *Context, args *GetRegionsArgs, opts ...InvokeOption) (*GetRegionsResult, error)
func GetRegionsOutput(ctx *Context, args *GetRegionsOutputArgs, opts ...InvokeOption) GetRegionsResultOutput

    > Note: This function is named GetRegions in the Go SDK.

    public static class GetRegions 
{
    public static Task<GetRegionsResult> InvokeAsync(GetRegionsArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionsResult> Invoke(GetRegionsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRegionsResult> getRegions(GetRegionsArgs args, InvokeOptions options)
public static Output<GetRegionsResult> getRegions(GetRegionsArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:account/getRegions:getRegions
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountId string
    AWS account ID. Must be a member account in the same organization.
    RegionOptStatusContains List<string>
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    AccountId string
    AWS account ID. Must be a member account in the same organization.
    RegionOptStatusContains []string
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    accountId String
    AWS account ID. Must be a member account in the same organization.
    regionOptStatusContains List<String>
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    accountId string
    AWS account ID. Must be a member account in the same organization.
    regionOptStatusContains string[]
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    account_id str
    AWS account ID. Must be a member account in the same organization.
    region_opt_status_contains Sequence[str]
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    accountId String
    AWS account ID. Must be a member account in the same organization.
    regionOptStatusContains List<String>
    A list of region opt-in statuses to filter the results. Valid values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.

    getRegions Result

    The following output properties are available:

    AccountId string
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionOptStatusContains List<string>
    Regions List<GetRegionsRegion>
    The regions for a given account
    AccountId string
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionOptStatusContains []string
    Regions []GetRegionsRegion
    The regions for a given account
    accountId String
    id String
    The provider-assigned unique ID for this managed resource.
    regionOptStatusContains List<String>
    regions List<GetRegionsRegion>
    The regions for a given account
    accountId string
    id string
    The provider-assigned unique ID for this managed resource.
    regionOptStatusContains string[]
    regions GetRegionsRegion[]
    The regions for a given account
    account_id str
    id str
    The provider-assigned unique ID for this managed resource.
    region_opt_status_contains Sequence[str]
    regions Sequence[GetRegionsRegion]
    The regions for a given account
    accountId String
    id String
    The provider-assigned unique ID for this managed resource.
    regionOptStatusContains List<String>
    regions List<Property Map>
    The regions for a given account

    Supporting Types

    GetRegionsRegion

    RegionName string
    The Region code of a given Region
    RegionOptStatus string
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    RegionName string
    The Region code of a given Region
    RegionOptStatus string
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    regionName String
    The Region code of a given Region
    regionOptStatus String
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    regionName string
    The Region code of a given Region
    regionOptStatus string
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    region_name str
    The Region code of a given Region
    region_opt_status str
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.
    regionName String
    The Region code of a given Region
    regionOptStatus String
    The opt-in status of the region. Possible values are ENABLED, ENABLING, DISABLING, DISABLED, and ENABLED_BY_DEFAULT.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.22.0
    published on Wednesday, Mar 11, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.