1. Packages
  2. AWS
  3. API Docs
  4. organizations
  5. getEntityPath
AWS v7.20.0 published on Thursday, Feb 19, 2026 by Pulumi
aws logo
AWS v7.20.0 published on Thursday, Feb 19, 2026 by Pulumi

    Get the entity path for an entity. An entity’s path is the text representation of the structure of that AWS Organizations entity.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.organizations.getEntityPath({
        entityId: "ou-ghi0-awsccccc",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.organizations.get_entity_path(entity_id="ou-ghi0-awsccccc")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := organizations.GetEntityPath(ctx, &organizations.GetEntityPathArgs{
    			EntityId: "ou-ghi0-awsccccc",
    		}, 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.Organizations.GetEntityPath.Invoke(new()
        {
            EntityId = "ou-ghi0-awsccccc",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.organizations.OrganizationsFunctions;
    import com.pulumi.aws.organizations.inputs.GetEntityPathArgs;
    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 = OrganizationsFunctions.getEntityPath(GetEntityPathArgs.builder()
                .entityId("ou-ghi0-awsccccc")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:organizations:getEntityPath
          arguments:
            entityId: ou-ghi0-awsccccc
    

    Using getEntityPath

    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 getEntityPath(args: GetEntityPathArgs, opts?: InvokeOptions): Promise<GetEntityPathResult>
    function getEntityPathOutput(args: GetEntityPathOutputArgs, opts?: InvokeOptions): Output<GetEntityPathResult>
    def get_entity_path(entity_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEntityPathResult
    def get_entity_path_output(entity_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEntityPathResult]
    func GetEntityPath(ctx *Context, args *GetEntityPathArgs, opts ...InvokeOption) (*GetEntityPathResult, error)
    func GetEntityPathOutput(ctx *Context, args *GetEntityPathOutputArgs, opts ...InvokeOption) GetEntityPathResultOutput

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

    public static class GetEntityPath 
    {
        public static Task<GetEntityPathResult> InvokeAsync(GetEntityPathArgs args, InvokeOptions? opts = null)
        public static Output<GetEntityPathResult> Invoke(GetEntityPathInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntityPathResult> getEntityPath(GetEntityPathArgs args, InvokeOptions options)
    public static Output<GetEntityPathResult> getEntityPath(GetEntityPathArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:organizations/getEntityPath:getEntityPath
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EntityId string
    Entity ID. Must be an organizational unit (OU) or AWS account ID.
    EntityId string
    Entity ID. Must be an organizational unit (OU) or AWS account ID.
    entityId String
    Entity ID. Must be an organizational unit (OU) or AWS account ID.
    entityId string
    Entity ID. Must be an organizational unit (OU) or AWS account ID.
    entity_id str
    Entity ID. Must be an organizational unit (OU) or AWS account ID.
    entityId String
    Entity ID. Must be an organizational unit (OU) or AWS account ID.

    getEntityPath Result

    The following output properties are available:

    EntityId string
    EntityPath string
    Entity path.
    Id string
    The provider-assigned unique ID for this managed resource.
    EntityId string
    EntityPath string
    Entity path.
    Id string
    The provider-assigned unique ID for this managed resource.
    entityId String
    entityPath String
    Entity path.
    id String
    The provider-assigned unique ID for this managed resource.
    entityId string
    entityPath string
    Entity path.
    id string
    The provider-assigned unique ID for this managed resource.
    entity_id str
    entity_path str
    Entity path.
    id str
    The provider-assigned unique ID for this managed resource.
    entityId String
    entityPath String
    Entity path.
    id String
    The provider-assigned unique ID for this managed resource.

    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
    AWS v7.20.0 published on Thursday, Feb 19, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate