List Ancestors (AWS)

For AWS only. Lists the ancestors of the given member accounts and organizational units (OUs) for the specified cloud account ID. A successful response returns an array of accounts and/or OUs each of which is mapped to an array of ancestor resource IDs.

Path Parameters

account_id string required

Account ID

application/json

Request Body required

Cloud Account JSON

accountId string required

AWS Account ID

accountType string required

Possible values: [organization]

Cloud Account Type

enabled boolean

Cloud Account Status. Whether or not the account is enabled

name string

Name

resourceIds string[] required

Array of resource IDs (account IDs and/or OU IDs)

roleArn string required

AWS Role ARN

Responses

• 200
• 400
• 404
• 412
• 500

---

success

application/json; charset=UTF-8

Schema

Example (from schema)

---

Schema

• Array [
ancestors object[]
List of ancestors
Array [
displayName string
Display name
hasChild boolean
Possible values: [true, false]
Has Child
id string
Node ID
parent string
Parent
type string
Possible values: [ORG, FOLDER, PROJECT, SUBSCRIPTION, MANAGEMENT_GROUP, TENANT, ACCOUNT, OU]
Node type
]
resourceId string

Resource ID

responseCode int32

Response code

status string

Status

• ]

[
  {
    "ancestors": [
      {
        "displayName": "string",
        "hasChild": true,
        "id": "string",
        "parent": "string",
        "type": "ORG"
      }
    ],
    "resourceId": "string",
    "responseCode": 0,
    "status": "string"
  }
]

bad_request / unauthorized_access

invalid_account_id_format

external_id_empty_or_not_generated. To generate CFT and externalId call Generate and Download the AWS CFT Template endpoint or Generate the AWS CFT Template Link Endpoint

internal_error

Loading...