Create an AWS Organization
Select
Create an organization.
Only one organization can be created for each organization present in AWS.
- application/json
Request Body
- displayName string
credential object required
Credential to be used to be access AWS Organization
credentialType AWSOrganizationCredentialType requiredPossible values: [
CREDENTIALS_MANAGER_CREDENTIAL
,AWS_STS_ASSUME_ROLE
,AWS_IAM_ROLE
]Type of credential to be used to access AWS Organization
credentialId int32ID of the saved credential. Applicable only if credentialType is CREDENTIALS_MANAGER_CREDENTIAL.
awsIamRoleArn stringARN of the IAM Role to assume. Applicable only if credentialType is AWS_ASSUME_ROLE.
awsExternalId stringExternal ID to use when assuming IAM Role. Applicable only if credentialType is AWS_ASSUME_ROLE.
- accessNodes object[] required
List of servers and server groups to use to access the organization
tagContents object
Details of tags that define the contents of the organization. If the field is left empty, all visible accounts will be treated as organization's content.
tagType AWSOrganizationTagContentTypePossible values: [
ORGANIZATIONAL_UNIT_TAG
,ACCOUNT_TAG
]Type of the content tags
tags object[]
key stringTag key content to match
value stringTag value content to match
accountDiscoveryDetails object
Particulars required to create hypervisors corresponding to accounts in the organization
roleNameWithPath stringName of IAM role to assume to access accounts in the organization
backupServiceAccountId stringId of the account that hosts the Commvault backup infrastructure
accountAccessNodes object[]List of servers and server groups to use to access the onboarded accounts
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- id int32
- name string
{
"id": 0,
"name": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorType AWSOrganizationErrorType
Possible values: [
UNKNOWN
,INVALID_REQUEST
,ACCESS_NODE_COMMUNICATION_FAILED
,SERVICE_ENDPOINT_NOT_REACHABLE
,CREDENTIAL_INVALID
,NOT_ENOUGH_PERMISSIONS
,ALL_ACCOUNTS_FAILED_DISCOVERY
]Type of AWS Organization specific error that occured
- errorMessage string
{
"errorType": "UNKNOWN",
"errorMessage": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}