get-listing¶
Synopsis¶
get-listing
--domain-identifier <value>
--identifier <value>
[--listing-revision <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
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.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.
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.