[ aws . datazone ]

search-listings

Description

Searches listings (records of an asset at a given time) in Amazon DataZone.

See also: AWS API Documentation

search-listings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: items

Synopsis

  search-listings
[--additional-attributes <value>]
--domain-identifier <value>
[--filters <value>]
[--search-in <value>]
[--search-text <value>]
[--sort <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--additional-attributes (list)

Specifies additional attributes for the search.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  FORMS
  TIME_SERIES_DATA_POINT_FORMS

--domain-identifier (string)

The identifier of the domain in which to search listings.

--filters (tagged union structure)

Specifies the filters for the search of listings.

Note

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

and -> (list)

The ‘and’ search filter clause in Amazon DataZone.

(tagged union structure)

A search filter clause in Amazon DataZone.

Note

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

and -> (list)

The ‘and’ search filter clause in Amazon DataZone.

( … recursive … )

filter -> (structure)

A search filter in Amazon DataZone.

attribute -> (string)

A search filter attribute in Amazon DataZone.

value -> (string)

A search filter value in Amazon DataZone.

or -> (list)

The ‘or’ search filter clause in Amazon DataZone.

( … recursive … )

filter -> (structure)

A search filter in Amazon DataZone.

attribute -> (string)

A search filter attribute in Amazon DataZone.

value -> (string)

A search filter value in Amazon DataZone.

or -> (list)

The ‘or’ search filter clause in Amazon DataZone.

(tagged union structure)

A search filter clause in Amazon DataZone.

Note

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

and -> (list)

The ‘and’ search filter clause in Amazon DataZone.

( … recursive … )

filter -> (structure)

A search filter in Amazon DataZone.

attribute -> (string)

A search filter attribute in Amazon DataZone.

value -> (string)

A search filter value in Amazon DataZone.

or -> (list)

The ‘or’ search filter clause in Amazon DataZone.

( … recursive … )

JSON Syntax:

{
  "and": [
    {
      "and": [
        { ... recursive ... }
        ...
      ],
      "filter": {
        "attribute": "string",
        "value": "string"
      },
      "or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ],
  "filter": {
    "attribute": "string",
    "value": "string"
  },
  "or": [
    {
      "and": [
        { ... recursive ... }
        ...
      ],
      "filter": {
        "attribute": "string",
        "value": "string"
      },
      "or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ]
}

--search-in (list)

The details of the search.

(structure)

The details of the search.

attribute -> (string)

The search attribute.

Shorthand Syntax:

attribute=string ...

JSON Syntax:

[
  {
    "attribute": "string"
  }
  ...
]

--search-text (string)

Specifies the text for which to search.

--sort (structure)

Specifies the way for sorting the search results.

attribute -> (string)

The attribute detail of the way to sort search results.

order -> (string)

The order detail of the wya to sort search results.

Shorthand Syntax:

attribute=string,order=string

JSON Syntax:

{
  "attribute": "string",
  "order": "ASCENDING"|"DESCENDING"
}

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. 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
• 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

items -> (list)

The results of the SearchListings action.

(tagged union structure)

The details of the results of the SearchListings action.

Note

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

assetListing -> (structure)

The asset listing included in the results of the SearchListings action.

additionalAttributes -> (structure)

The additional attributes of an asset published in an Amazon DataZone catalog.

forms -> (string)

The metadata forms that form additional attributes of the metadata 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.

createdAt -> (timestamp)

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

description -> (string)

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

entityId -> (string)

The identifier of the inventory asset.

entityRevision -> (string)

The revision of the inventory asset.

entityType -> (string)

The type of the inventory asset.

glossaryTerms -> (list)

Glossary terms attached to the inventory asset.

(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.

listingCreatedBy -> (string)

The Amazon DataZone user who created the listing.

listingId -> (string)

The identifier of the listing (asset published in Amazon DataZone catalog).

listingRevision -> (string)

The revision of the listing (asset published in Amazon DataZone catalog).

listingUpdatedBy -> (string)

The Amazon DataZone user who updated the listing.

name -> (string)

The name of the inventory asset.

owningProjectId -> (string)

The identifier of the project that owns the inventory asset.

dataProductListing -> (structure)

The data product listing.

additionalAttributes -> (structure)

The additional attributes of the asset of the data product.

forms -> (string)

The metadata forms of the asset of the data product.

createdAt -> (timestamp)

The timestamp at which the asset of the data product listing was created.

description -> (string)

The description of the asset of the asset of the data product.

entityId -> (string)

The entity ID of the asset of the asset of the data product.

entityRevision -> (string)

The revision of the asset of the asset of the data product.

glossaryTerms -> (list)

The glossary terms of the asset of the asset 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.

items -> (list)

The data of the asset of the data product.

(structure)

The results of the data product summary.

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.

listingId -> (string)

The ID of the data product listing.

listingRevision -> (string)

The revision of the data product listing.

listingCreatedBy -> (string)

The timestamp at which the listing was created.

listingId -> (string)

The ID of the listing.

listingRevision -> (string)

The revision of the listing.

listingUpdatedBy -> (string)

The user who updated the listing.

name -> (string)

The name of the asset of the data product.

owningProjectId -> (string)

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

nextToken -> (string)

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

totalMatchCount -> (integer)

Total number of search results.