GetDomainCommand

Gets an Amazon DataZone domain.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, GetDomainCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetDomainCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetDomainInput
  identifier: "STRING_VALUE", // required
};
const command = new GetDomainCommand(input);
const response = await client.send(command);
// { // GetDomainOutput
//   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", // required
//   arn: "STRING_VALUE",
//   kmsKeyIdentifier: "STRING_VALUE",
//   status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED", // required
//   portalUrl: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
//   tags: { // Tags
//     "<keys>": "STRING_VALUE",
//   },
//   domainVersion: "V1" || "V2",
//   serviceRole: "STRING_VALUE",
// };

GetDomainCommand Input

See GetDomainCommandInput for more details

Parameter
Type
Description
identifier
Required
string | undefined

The identifier of the specified Amazon DataZone domain.

GetDomainCommand Output

See GetDomainCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainExecutionRole
Required
string | undefined

The domain execution role with which the Amazon DataZone domain is created.

id
Required
string | undefined

The identifier of the specified Amazon DataZone domain.

status
Required
DomainStatus | undefined

The status of the specified Amazon DataZone domain.

arn
string | undefined

The ARN of the specified Amazon DataZone domain.

createdAt
Date | undefined

The timestamp of when the Amazon DataZone domain was created.

description
string | undefined

The description of the Amazon DataZone domain.

domainVersion
DomainVersion | undefined

The version of the domain.

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.

lastUpdatedAt
Date | undefined

The timestamp of when the Amazon DataZone domain was last updated.

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 in Amazon Datazone.

serviceRole
string | undefined

The service role of the domain.

singleSignOn
SingleSignOn | undefined

The single sing-on option of the specified Amazon DataZone domain.

tags
Record<string, string> | undefined

The tags specified for the Amazon DataZone domain.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform 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.