UpdateDomainCommand

Updates a Amazon DataZone domain.

Example Syntax

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

import { DataZoneClient, UpdateDomainCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateDomainCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateDomainInput
  identifier: "STRING_VALUE", // required
  description: "STRING_VALUE",
  singleSignOn: { // SingleSignOn
    type: "IAM_IDC" || "DISABLED",
    userAssignment: "AUTOMATIC" || "MANUAL",
    idcInstanceArn: "STRING_VALUE",
  },
  domainExecutionRole: "STRING_VALUE",
  serviceRole: "STRING_VALUE",
  name: "STRING_VALUE",
  clientToken: "STRING_VALUE",
};
const command = new UpdateDomainCommand(input);
const response = await client.send(command);
// { // UpdateDomainOutput
//   id: "STRING_VALUE", // required
//   rootDomainUnitId: "STRING_VALUE",
//   description: "STRING_VALUE",
//   singleSignOn: { // SingleSignOn
//     type: "IAM_IDC" || "DISABLED",
//     userAssignment: "AUTOMATIC" || "MANUAL",
//     idcInstanceArn: "STRING_VALUE",
//   },
//   domainExecutionRole: "STRING_VALUE",
//   serviceRole: "STRING_VALUE",
//   name: "STRING_VALUE",
//   lastUpdatedAt: new Date("TIMESTAMP"),
// };

UpdateDomainCommand Input

See UpdateDomainCommandInput for more details

Parameter
Type
Description
identifier
Required
string | undefined

The ID of the Amazon Web Services domain that is to be updated.

clientToken
string | undefined

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

description
string | undefined

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

domainExecutionRole
string | undefined

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

name
string | undefined

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

serviceRole
string | undefined

The service role of the domain.

singleSignOn
SingleSignOn | undefined

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

UpdateDomainCommand Output

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

The identifier of the Amazon DataZone domain.

description
string | undefined

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

domainExecutionRole
string | undefined

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

lastUpdatedAt
Date | undefined

Specifies the timestamp of when the domain was last updated.

name
string | undefined

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

rootDomainUnitId
string | undefined

The ID of the root domain unit.

serviceRole
string | undefined

The service role of the domain.

singleSignOn
SingleSignOn | undefined

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

Throws

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.