Get AWS Cloud Account Status
Lists status messages of the specified AWS cloud account.
- application/json
Request Body
- accountId string required
AWS Account ID
- accountType string required
Possible values: [
organization
,account
]Cloud Account Type
- defaultAccountGroupId string
Applicable only for accountType: organization.
This is the Default Account Group ID for the AWS organization and its member accounts.
- enabled boolean
Cloud Account Status. Whether or not the account is enabled
features object[]
Features to be enabled and/ or disabled. To get a list of all the supported features, call Fetch Supported Features endpoint
Array [name stringFeature name obtained from Fetch Supported Features endpoint
state stringPossible values: [
enabled
,disabled
]Feature state. Whether to be enabled or disabled
]- groupIds string[]
Account Group Ids for this account
hierarchySelection object[]
Applicable only for accountType: organization.
Include/Exclude a list of AWS Organization Units (OU), AWS accounts, and AWS Organizations to onboard under this organization.
Array [displayName stringDisplay name
nodeType stringPossible values: [
ORG
,FOLDER
,PROJECT
,SUBSCRIPTION
,MANAGEMENT_GROUP
,TENANT
,ACCOUNT
,OU
]Member account Node type. Supported values based on cloud_type are given below.
-
ORG, OU, or ACCOUNT - cloud_type: aws
-
ORG, FOLDER, or PROJECT - cloud_type: gcp
-
SUBSCRIPTION, MANAGEMENT_GROUP, or TENANT - cloud_type: azure
resourceId stringResource ID.
Note you must escape any double quotes in the resource ID with a backslash
selectionType stringPossible values: [
ALL
,INCLUDE
,EXCLUDE
]Organization Member accounts Selection type
]- name string required
Name to be used for the account on the Prisma Cloud platform (must be unique)
- roleArn string required
AWS Role ARN
- 200
- 400
- 412
- 500
successful operation
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
- Array [
- id string
- name string
- status string
statusMessage object
message stringstaticMessage boolean- ]
[
{
"id": "string",
"name": "string",
"status": "string",
"statusMessage": {
"message": "string",
"staticMessage": true
}
}
]
bad_request
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