AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

get-listing

Description

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.

See also: AWS API Documentation

Synopsis

  get-listing
--domain-identifier <value>
--identifier <value>
[--listing-revision <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain-identifier (string)

The ID of the Amazon DataZone domain.

--identifier (string)

The ID of the listing.

--listing-revision (string)

The revision of the listing.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

createdAt -> (timestamp)

The timestamp of when the listing was created.

createdBy -> (string)

The Amazon DataZone user who created the listing.

description -> (string)

The description of the listing.

domainId -> (string)

The ID of the Amazon DataZone domain.

id -> (string)

The ID of the listing.

item -> (tagged union structure)

The details of a listing.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: assetListing, dataProductListing.

assetListing -> (structure)

An asset published in an Amazon DataZone catalog.

assetId -> (string)

The identifier of an asset published in an Amazon DataZone catalog.

assetRevision -> (string)

The revision of an asset published in an Amazon DataZone catalog.

assetType -> (string)

The type of an asset published in an Amazon DataZone catalog.

createdAt -> (timestamp)

The timestamp of when an asset published in an Amazon DataZone catalog was created.

forms -> (string)

The metadata forms attached to an asset published in an Amazon DataZone catalog.

glossaryTerms -> (list)

The glossary terms attached to an asset published in an Amazon DataZone catalog.

(structure)

Details of a glossary term attached to the inventory asset.

name -> (string)

The name of a glossary term attached to the inventory asset.

shortDescription -> (string)

The shoft description of a glossary term attached to the inventory asset.

latestTimeSeriesDataPointForms -> (list)

The latest time series data points forms included in the additional attributes of an asset.

(structure)

The summary of the time series data points form.

contentSummary -> (string)

The content of the summary of the time series data points form.

formName -> (string)

The name of the time series data points summary form.

id -> (string)

The ID of the time series data points summary form.

timestamp -> (timestamp)

The timestamp of the time series data points summary form.

typeIdentifier -> (string)

The type ID of the time series data points summary form.

typeRevision -> (string)

The type revision of the time series data points summary form.

owningProjectId -> (string)

The identifier of the project where an asset published in an Amazon DataZone catalog exists.

dataProductListing -> (structure)

The data product listing.

createdAt -> (timestamp)

The timestamp at which the data product listing was created.

dataProductId -> (string)

The ID of the data product listing.

dataProductRevision -> (string)

The revision of the data product listing.

forms -> (string)

The metadata forms of the data product listing.

glossaryTerms -> (list)

The glossary terms of the data product listing.

(structure)

Details of a glossary term attached to the inventory asset.

name -> (string)

The name of a glossary term attached to the inventory asset.

shortDescription -> (string)

The shoft description of a glossary term attached to the inventory asset.

items -> (list)

The data assets of the data product listing.

(structure)

The summary of the listing of the data product.

glossaryTerms -> (list)

The glossary terms of the data product.

(structure)

Details of a glossary term attached to the inventory asset.

name -> (string)

The name of a glossary term attached to the inventory asset.

shortDescription -> (string)

The shoft description of a glossary term attached to the inventory asset.

listingId -> (string)

The ID of the data product listing.

listingRevision -> (string)

The revision of the data product listing.

owningProjectId -> (string)

The ID of the owning project of the data product listing.

listingRevision -> (string)

The revision of a listing.

name -> (string)

The name of the listing.

status -> (string)

The status of the listing.

updatedAt -> (timestamp)

The timestamp of when the listing was updated.

updatedBy -> (string)

The Amazon DataZone user who updated the listing.