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

UpdateDomain

Updates a Amazon DataZone domain.

Request Syntax


PUT /v2/domains/identifier?clientToken=clientToken HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "domainExecutionRole": "string",
   "name": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

clientToken

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

identifier

The ID of the AWS domain that is to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description to be updated as part of the UpdateDomain action.

Type: String

Required: No

domainExecutionRole

The domain execution role to be updated as part of the UpdateDomain action.

Type: String

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

Required: No

name

The name to be updated as part of the UpdateDomain action.

Type: String

Required: No

serviceRole

The service role of the domain.

Type: String

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

Required: No

singleSignOn

The single sign-on option to be updated as part of the UpdateDomain action.

Type: SingleSignOn object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainExecutionRole": "string",
   "id": "string",
   "lastUpdatedAt": number,
   "name": "string",
   "rootDomainUnitId": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "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.

description

The description to be updated as part of the UpdateDomain action.

Type: String

domainExecutionRole

The domain execution role to be updated as part of the UpdateDomain action.

Type: String

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

id

The identifier of the Amazon DataZone domain.

Type: String

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

lastUpdatedAt

Specifies the timestamp of when the domain was last updated.

Type: Timestamp

name

The name to be updated as part of the UpdateDomain action.

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

The service role of the domain.

Type: String

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

singleSignOn

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

Type: SingleSignOn object

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