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

CreateListingChangeSet

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

Request Syntax


POST /v2/domains/domainIdentifier/listings/change-set HTTP/1.1
Content-type: application/json

{
   "action": "string",
   "clientToken": "string",
   "entityIdentifier": "string",
   "entityRevision": "string",
   "entityType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

action

Specifies whether to publish or unpublish a listing.

Type: String

Valid Values: PUBLISH | UNPUBLISH

Required: Yes

clientToken

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

Type: String

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

Pattern: ^[\x21-\x7E]+$

Required: No

entityIdentifier

The ID of the asset.

Type: String

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

Required: Yes

entityRevision

The revision of an asset.

Type: String

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

Required: No

entityType

The type of an entity.

Type: String

Valid Values: ASSET | DATA_PRODUCT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "listingId": "string",
   "listingRevision": "string",
   "status": "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.

listingId

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

Type: String

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

listingRevision

The revision of a listing.

Type: String

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

status

Specifies the status of the listing.

Type: String

Valid Values: CREATING | ACTIVE | INACTIVE

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