GetListingCommand

Suggest an Edit

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

Example Syntax

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

import { DataZoneClient, GetListingCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetListingCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetListingInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  listingRevision: "STRING_VALUE",
};
const command = new GetListingCommand(input);
const response = await client.send(command);
// { // GetListingOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   listingRevision: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   updatedBy: "STRING_VALUE",
//   item: { // ListingItem Union: only one key present
//     assetListing: { // AssetListing
//       assetId: "STRING_VALUE",
//       assetRevision: "STRING_VALUE",
//       assetType: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       forms: "STRING_VALUE",
//       latestTimeSeriesDataPointForms: [ // TimeSeriesDataPointSummaryFormOutputList
//         { // TimeSeriesDataPointSummaryFormOutput
//           formName: "STRING_VALUE", // required
//           typeIdentifier: "STRING_VALUE", // required
//           typeRevision: "STRING_VALUE",
//           timestamp: new Date("TIMESTAMP"), // required
//           contentSummary: "STRING_VALUE",
//           id: "STRING_VALUE",
//         },
//       ],
//       glossaryTerms: [ // DetailedGlossaryTerms
//         { // DetailedGlossaryTerm
//           name: "STRING_VALUE",
//           shortDescription: "STRING_VALUE",
//         },
//       ],
//       owningProjectId: "STRING_VALUE",
//     },
//     dataProductListing: { // DataProductListing
//       dataProductId: "STRING_VALUE",
//       dataProductRevision: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       forms: "STRING_VALUE",
//       glossaryTerms: [
//         {
//           name: "STRING_VALUE",
//           shortDescription: "STRING_VALUE",
//         },
//       ],
//       owningProjectId: "STRING_VALUE",
//       items: [ // ListingSummaries
//         { // ListingSummary
//           listingId: "STRING_VALUE",
//           listingRevision: "STRING_VALUE",
//           glossaryTerms: [
//             {
//               name: "STRING_VALUE",
//               shortDescription: "STRING_VALUE",
//             },
//           ],
//         },
//       ],
//     },
//   },
//   name: "STRING_VALUE",
//   description: "STRING_VALUE",
//   status: "CREATING" || "ACTIVE" || "INACTIVE",
// };

GetListingCommand Input

See GetListingCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain.

identifier
Required
string | undefined

The ID of the listing.

listingRevision
string | undefined

The revision of the listing.

GetListingCommand Output

See GetListingCommandOutput for details

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

The ID of the Amazon DataZone domain.

id
Required
string | undefined

The ID of the listing.

listingRevision
Required
string | undefined

The revision of a listing.

createdAt
Date | undefined

The timestamp of when the listing was created.

createdBy
string | undefined

The Amazon DataZone user who created the listing.

description
string | undefined

The description of the listing.

item
ListingItem | undefined

The details of a listing.

name
string | undefined

The name of the listing.

status
ListingStatus | undefined

The status of the listing.

updatedAt
Date | undefined

The timestamp of when the listing was updated.

updatedBy
string | undefined

The Amazon DataZone user who updated the listing.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

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.