CreateListingChangeSetCommand

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

Example Syntax

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

import { DataZoneClient, CreateListingChangeSetCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateListingChangeSetCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateListingChangeSetInput
  domainIdentifier: "STRING_VALUE", // required
  entityIdentifier: "STRING_VALUE", // required
  entityType: "ASSET" || "DATA_PRODUCT", // required
  entityRevision: "STRING_VALUE",
  action: "PUBLISH" || "UNPUBLISH", // required
  clientToken: "STRING_VALUE",
};
const command = new CreateListingChangeSetCommand(input);
const response = await client.send(command);
// { // CreateListingChangeSetOutput
//   listingId: "STRING_VALUE", // required
//   listingRevision: "STRING_VALUE", // required
//   status: "CREATING" || "ACTIVE" || "INACTIVE", // required
// };

CreateListingChangeSetCommand Input

Parameter
Type
Description
action
Required
ChangeAction | undefined

Specifies whether to publish or unpublish a listing.

domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain.

entityIdentifier
Required
string | undefined

The ID of the asset.

entityType
Required
EntityType | undefined

The type of an entity.

clientToken
string | undefined

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

entityRevision
string | undefined

The revision of an asset.

CreateListingChangeSetCommand Output

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

The ID of the listing (a record of an asset at a given time).

listingRevision
Required
string | undefined

The revision of a listing.

status
Required
ListingStatus | undefined

Specifies the status of the listing.

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.