[ aws . datazone ]

search

Description

Searches for assets in Amazon DataZone.

See also: AWS API Documentation

search 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
[--additional-attributes <value>]
--domain-identifier <value>
[--filters <value>]
[--owning-project-identifier <value>]
[--search-in <value>]
--search-scope <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 action.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  FORMS
  TIME_SERIES_DATA_POINT_FORMS

--domain-identifier (string)

The identifier of the Amazon DataZone domain.

--filters (tagged union structure)

Specifies the search filters.

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

--owning-project-identifier (string)

The identifier of the owning project specified for the search.

--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-scope (string)

The scope of the search.

Possible values:

• ASSET
• GLOSSARY
• GLOSSARY_TERM

--search-text (string)

Specifies the text for which to search.

--sort (structure)

Specifies the way in which the search results are to be sorted.

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.

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

(tagged union structure)

The details of the search results.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: assetItem, dataProductItem, glossaryItem, glossaryTermItem.

assetItem -> (structure)

The asset item included in the search results.

additionalAttributes -> (structure)

The additional attributes of a Amazon DataZone inventory asset.

formsOutput -> (list)

The forms included in the additional attributes of an inventory asset.

(structure)

The details of a metadata form.

content -> (string)

The content of the metadata form.

formName -> (string)

The name of the metadata form.

typeName -> (string)

The name of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

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

readOnlyFormsOutput -> (list)

The read-only forms included in the additional attributes of an inventory asset.

(structure)

The details of a metadata form.

content -> (string)

The content of the metadata form.

formName -> (string)

The name of the metadata form.

typeName -> (string)

The name of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

createdAt -> (timestamp)

The timestamp of when the Amazon DataZone inventory asset was created.

createdBy -> (string)

The Amazon DataZone user who created the inventory asset.

description -> (string)

The description of an Amazon DataZone inventory asset.

domainId -> (string)

The identifier of the Amazon DataZone domain in which the inventory asset exists.

externalIdentifier -> (string)

The external identifier of the Amazon DataZone inventory asset.

firstRevisionCreatedAt -> (timestamp)

The timestamp of when the first revision of the inventory asset was created.

firstRevisionCreatedBy -> (string)

The Amazon DataZone user who created the first revision of the inventory asset.

glossaryTerms -> (list)

The glossary terms attached to the Amazon DataZone inventory asset.

(string)

identifier -> (string)

the identifier of the Amazon DataZone inventory asset.

name -> (string)

The name of the Amazon DataZone inventory asset.

owningProjectId -> (string)

The identifier of the Amazon DataZone project that owns the inventory asset.

typeIdentifier -> (string)

The identifier of the asset type of the specified Amazon DataZone inventory asset.

typeRevision -> (string)

The revision of the inventory asset type.

dataProductItem -> (structure)

The data product item included in the search results.

createdAt -> (timestamp)

createdBy -> (string)

dataProductItems -> (list)

(structure)

domainId -> (string)

itemId -> (string)

description -> (string)

domainId -> (string)

glossaryTerms -> (list)

(string)

id -> (string)

name -> (string)

owningProjectId -> (string)

updatedAt -> (timestamp)

updatedBy -> (string)

glossaryItem -> (structure)

The glossary item included in the search results.

createdAt -> (timestamp)

The timestamp of when the glossary was created.

createdBy -> (string)

The Amazon DataZone user who created the glossary.

description -> (string)

The business glossary description.

domainId -> (string)

The identifier of the Amazon DataZone domain in which the business glossary exists.

id -> (string)

The identifier of the glossary.

name -> (string)

The name of the glossary.

owningProjectId -> (string)

The identifier of the project that owns the business glosary.

status -> (string)

The business glossary status.

updatedAt -> (timestamp)

The timestamp of when the business glossary was updated.

updatedBy -> (string)

The Amazon DataZone user who updated the business glossary.

glossaryTermItem -> (structure)

The glossary term item included in the search results.

createdAt -> (timestamp)

The timestamp of when a business glossary term was created.

createdBy -> (string)

The Amazon DataZone user who created the business glossary.

domainId -> (string)

The identifier of the Amazon DataZone domain in which the business glossary exists.

glossaryId -> (string)

The identifier of the business glossary to which the term belongs.

id -> (string)

The identifier of the business glossary term.

longDescription -> (string)

The long description of the business glossary term.

name -> (string)

The name of the business glossary term.

shortDescription -> (string)

The short description of the business glossary term.

status -> (string)

The status of the business glossary term.

termRelations -> (structure)

The relations of the business glossary term.

classifies -> (list)

The classifies of the term relations.

(string)

isA -> (list)

The isA property of the term relations.

(string)

updatedAt -> (timestamp)

The timestamp of when a business glossary term was updated.

updatedBy -> (string)

The Amazon DataZone user who updated the business glossary term.

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 Search to list the next set of results.

totalMatchCount -> (integer)

Total number of search results.