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

GetDomain

Gets an Amazon DataZone domain.

Request Syntax


GET /v2/domains/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

identifier

The identifier of the specified Amazon DataZone domain.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": number,
   "description": "string",
   "domainExecutionRole": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "lastUpdatedAt": number,
   "name": "string",
   "portalUrl": "string",
   "rootDomainUnitId": "string",
   "singleSignOn": { 
      "type": "string",
      "userAssignment": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

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

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

arn

The ARN of the specified Amazon DataZone domain.

Type: String

createdAt

The timestamp of when the Amazon DataZone domain was created.

Type: Timestamp

description

The description of the Amazon DataZone domain.

Type: String

domainExecutionRole

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

Type: String

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

id

The identifier of the specified 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}$

lastUpdatedAt

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

Type: Timestamp

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

Type: String

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

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

singleSignOn

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

Type: SingleSignOn object

status

The status of the specified 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

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