AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getOrganizationalUnits

Get all direct child organizational units under a parent organizational unit. This only provides immediate children, not all children.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var org = Output.Create(Aws.Organizations.GetOrganization.InvokeAsync());
        var ou = org.Apply(org => Output.Create(Aws.Organizations.GetOrganizationalUnits.InvokeAsync(new Aws.Organizations.GetOrganizationalUnitsArgs
        {
            ParentId = org.Roots?[0]?.Id,
        })));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		org, err := organizations.LookupOrganization(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = organizations.GetOrganizationalUnits(ctx, &organizations.GetOrganizationalUnitsArgs{
			ParentId: org.Roots[0].Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var org = Output.of(OrganizationsFunctions.getOrganization());

        final var ou = Output.of(OrganizationsFunctions.getOrganizationalUnits(GetOrganizationalUnitsArgs.builder()
            .parentId(org.apply(getOrganizationResult -> getOrganizationResult.roots()[0].id()))
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

org = aws.organizations.get_organization()
ou = aws.organizations.get_organizational_units(parent_id=org.roots[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const org = aws.organizations.getOrganization({});
const ou = org.then(org => aws.organizations.getOrganizationalUnits({
    parentId: org.roots?[0]?.id,
}));
variables:
  org:
    Fn::Invoke:
      Function: aws:organizations:getOrganization
      Arguments: {}
  ou:
    Fn::Invoke:
      Function: aws:organizations:getOrganizationalUnits
      Arguments:
        parentId: ${org.roots[0].id}

Using getOrganizationalUnits

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 getOrganizationalUnits(args: GetOrganizationalUnitsArgs, opts?: InvokeOptions): Promise<GetOrganizationalUnitsResult>
function getOrganizationalUnitsOutput(args: GetOrganizationalUnitsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationalUnitsResult>
def get_organizational_units(parent_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetOrganizationalUnitsResult
def get_organizational_units_output(parent_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationalUnitsResult]
func GetOrganizationalUnits(ctx *Context, args *GetOrganizationalUnitsArgs, opts ...InvokeOption) (*GetOrganizationalUnitsResult, error)
func GetOrganizationalUnitsOutput(ctx *Context, args *GetOrganizationalUnitsOutputArgs, opts ...InvokeOption) GetOrganizationalUnitsResultOutput

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

public static class GetOrganizationalUnits 
{
    public static Task<GetOrganizationalUnitsResult> InvokeAsync(GetOrganizationalUnitsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationalUnitsResult> Invoke(GetOrganizationalUnitsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOrganizationalUnitsResult> getOrganizationalUnits(GetOrganizationalUnitsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:organizations/getOrganizationalUnits:getOrganizationalUnits
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ParentId string

The parent ID of the organizational unit.

ParentId string

The parent ID of the organizational unit.

parentId String

The parent ID of the organizational unit.

parentId string

The parent ID of the organizational unit.

parent_id str

The parent ID of the organizational unit.

parentId String

The parent ID of the organizational unit.

getOrganizationalUnits Result

The following output properties are available:

Childrens List<GetOrganizationalUnitsChildren>

List of child organizational units, which have the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

ParentId string
Childrens []GetOrganizationalUnitsChildren

List of child organizational units, which have the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

ParentId string
childrens List<GetOrganizationalUnitsChildren>

List of child organizational units, which have the following attributes:

id String

The provider-assigned unique ID for this managed resource.

parentId String
childrens GetOrganizationalUnitsChildren[]

List of child organizational units, which have the following attributes:

id string

The provider-assigned unique ID for this managed resource.

parentId string
childrens Sequence[GetOrganizationalUnitsChildren]

List of child organizational units, which have the following attributes:

id str

The provider-assigned unique ID for this managed resource.

parent_id str
childrens List<Property Map>

List of child organizational units, which have the following attributes:

id String

The provider-assigned unique ID for this managed resource.

parentId String

Supporting Types

GetOrganizationalUnitsChildren

Arn string

ARN of the organizational unit

Id string

Parent identifier of the organizational units.

Name string

Name of the organizational unit

Arn string

ARN of the organizational unit

Id string

Parent identifier of the organizational units.

Name string

Name of the organizational unit

arn String

ARN of the organizational unit

id String

Parent identifier of the organizational units.

name String

Name of the organizational unit

arn string

ARN of the organizational unit

id string

Parent identifier of the organizational units.

name string

Name of the organizational unit

arn str

ARN of the organizational unit

id str

Parent identifier of the organizational units.

name str

Name of the organizational unit

arn String

ARN of the organizational unit

id String

Parent identifier of the organizational units.

name String

Name of the organizational unit

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.