- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateDomainCommand
Creates an Amazon DataZone domain.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, CreateDomainCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateDomainCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateDomainInput
name: "STRING_VALUE", // required
description: "STRING_VALUE",
singleSignOn: { // SingleSignOn
type: "IAM_IDC" || "DISABLED",
userAssignment: "AUTOMATIC" || "MANUAL",
idcInstanceArn: "STRING_VALUE",
},
domainExecutionRole: "STRING_VALUE", // required
kmsKeyIdentifier: "STRING_VALUE",
tags: { // Tags
"<keys>": "STRING_VALUE",
},
domainVersion: "V1" || "V2",
serviceRole: "STRING_VALUE",
clientToken: "STRING_VALUE",
};
const command = new CreateDomainCommand(input);
const response = await client.send(command);
// { // CreateDomainOutput
// id: "STRING_VALUE", // required
// rootDomainUnitId: "STRING_VALUE",
// name: "STRING_VALUE",
// description: "STRING_VALUE",
// singleSignOn: { // SingleSignOn
// type: "IAM_IDC" || "DISABLED",
// userAssignment: "AUTOMATIC" || "MANUAL",
// idcInstanceArn: "STRING_VALUE",
// },
// domainExecutionRole: "STRING_VALUE",
// arn: "STRING_VALUE",
// kmsKeyIdentifier: "STRING_VALUE",
// status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED",
// portalUrl: "STRING_VALUE",
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// domainVersion: "V1" || "V2",
// serviceRole: "STRING_VALUE",
// };
CreateDomainCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
domainExecutionRoleRequired | string | undefined | The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain. |
nameRequired | string | undefined | The name of the Amazon DataZone domain. |
clientToken | string | undefined | A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. |
description | string | undefined | The description of the Amazon DataZone domain. |
domainVersion | DomainVersion | undefined | The version of the domain that is created. |
kmsKeyIdentifier | string | undefined | The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. |
serviceRole | string | undefined | The service role of the domain that is created. |
singleSignOn | SingleSignOn | undefined | The single-sign on configuration of the Amazon DataZone domain. |
tags | Record<string, string> | undefined | The tags specified for the Amazon DataZone domain. |
CreateDomainCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
idRequired | string | undefined | The identifier of the Amazon DataZone domain. |
arn | string | undefined | The ARN of the Amazon DataZone domain. |
description | string | undefined | The description of the Amazon DataZone domain. |
domainExecutionRole | string | undefined | The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain. |
domainVersion | DomainVersion | undefined | The version of the domain that is created. |
kmsKeyIdentifier | string | undefined | The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. |
name | string | undefined | The name of the Amazon DataZone domain. |
portalUrl | string | undefined | The URL of the data portal for this Amazon DataZone domain. |
rootDomainUnitId | string | undefined | The ID of the root domain unit. |
serviceRole | string | undefined | Te service role of the domain that is created. |
singleSignOn | SingleSignOn | undefined | The single-sign on configuration of the Amazon DataZone domain. |
status | DomainStatus | undefined | The status of the Amazon DataZone domain. |
tags | Record<string, string> | undefined | The tags specified for the Amazon DataZone domain. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient access to perform this action. |
| ConflictException | client | There is a conflict while performing this action. |
| InternalServerException | server | The request has failed because of an unknown error, exception or failure. |
| ResourceNotFoundException | client | The specified resource cannot be found. |
| ServiceQuotaExceededException | client | The request has exceeded the specified service quota. |
| ThrottlingException | client | The request was denied due to request throttling. |
| ValidationException | client | The input fails to satisfy the constraints specified by the Amazon Web Services service. |
| UnauthorizedException | client | You do not have permission to perform this action. |
| DataZoneServiceException | Base exception class for all service exceptions from DataZone service. |