Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDomain

Creates an Amazon DataZone domain.

Request Syntax


POST /v2/domains HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "domainExecutionRole": "string",
   "domainVersion": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "type": "string",
      "userAssignment": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Type: String

Required: No

description

The description of the Amazon DataZone domain.

Type: String

Required: No

domainExecutionRole

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Required: Yes

domainVersion

The version of the domain that is created.

Type: String

Valid Values: V1 | V2

Required: No

kmsKeyIdentifier

The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Required: No

name

The name of the Amazon DataZone domain.

Type: String

Required: Yes

serviceRole

The service role of the domain that is created.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Required: No

singleSignOn

The single-sign on configuration of the Amazon DataZone domain.

Type: SingleSignOn object

Required: No

tags

The tags specified for the Amazon DataZone domain.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^[\w \.:/=+@-]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[\w \.:/=+@-]*$

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "description": "string",
   "domainExecutionRole": "string",
   "domainVersion": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "portalUrl": "string",
   "rootDomainUnitId": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "type": "string",
      "userAssignment": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn

The ARN of the Amazon DataZone domain.

Type: String

description

The description of the Amazon DataZone domain.

Type: String

domainExecutionRole

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

domainVersion

The version of the domain that is created.

Type: String

Valid Values: V1 | V2

id

The identifier of the Amazon DataZone domain.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

kmsKeyIdentifier

The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

name

The name of the Amazon DataZone domain.

Type: String

portalUrl

The URL of the data portal for this Amazon DataZone domain.

Type: String

rootDomainUnitId

The ID of the root domain unit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-z0-9_\-]+$

serviceRole

Te service role of the domain that is created.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

singleSignOn

The single-sign on configuration of the Amazon DataZone domain.

Type: SingleSignOn object

status

The status of the Amazon DataZone domain.

Type: String

tags

The tags specified for the Amazon DataZone domain.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^[\w \.:/=+@-]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[\w \.:/=+@-]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400