AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

search-assets

Description

Searches for assets in Glue Data Catalog using full-text search, filters, sorting, and aggregations. Returns matching assets with relevance-ranked results.

See also: AWS API Documentation

search-assets 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-assets
[--search-text <value>]
[--sort <value>]
[--filter-clause <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--search-text (string)

The text to search for. At least one of searchText or filterClause must be provided.

--sort (structure)

The sort criteria for the search results.

Attribute -> (string)

The attribute to sort by.

Order -> (string)

The sort order. Valid values are ASCENDING and DESCENDING .

Shorthand Syntax:

Attribute=string,Order=string

JSON Syntax:

{
  "Attribute": "string",
  "Order": "ASCENDING"|"DESCENDING"
}

--filter-clause (tagged union structure)

The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AndAllFilters, OrAnyFilters, AttributeFilter, MapFilter.

AndAllFilters -> (list)

A list of filter clauses that must all match (logical AND).

(tagged union structure)

A filter clause that supports nested boolean logic. Exactly one of andAllFilters , orAnyFilters , attributeFilter , or mapFilter must be specified.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AndAllFilters, OrAnyFilters, AttributeFilter, MapFilter.

AndAllFilters -> (list)

A list of filter clauses that must all match (logical AND).

( … recursive … )

OrAnyFilters -> (list)

A list of filter clauses where at least one must match (logical OR).

( … recursive … )

AttributeFilter -> (structure)

A filter on a single attribute value.

Attribute -> (string)

The attribute name to filter on.

Operator -> (string)

The comparison operator. Valid values are equals , greaterThan , greaterThanOrEquals , lessThan , lessThanOrEquals , and notExists .

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

LongValue -> (long)

A long integer filter value.

MapFilter -> (structure)

A filter on a map attribute’s key-value pair.

Attribute -> (string)

The map attribute name to filter on.

Key -> (string)

The key within the map attribute to filter on.

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

OrAnyFilters -> (list)

A list of filter clauses where at least one must match (logical OR).

(tagged union structure)

A filter clause that supports nested boolean logic. Exactly one of andAllFilters , orAnyFilters , attributeFilter , or mapFilter must be specified.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AndAllFilters, OrAnyFilters, AttributeFilter, MapFilter.

AndAllFilters -> (list)

A list of filter clauses that must all match (logical AND).

( … recursive … )

OrAnyFilters -> (list)

A list of filter clauses where at least one must match (logical OR).

( … recursive … )

AttributeFilter -> (structure)

A filter on a single attribute value.

Attribute -> (string)

The attribute name to filter on.

Operator -> (string)

The comparison operator. Valid values are equals , greaterThan , greaterThanOrEquals , lessThan , lessThanOrEquals , and notExists .

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

LongValue -> (long)

A long integer filter value.

MapFilter -> (structure)

A filter on a map attribute’s key-value pair.

Attribute -> (string)

The map attribute name to filter on.

Key -> (string)

The key within the map attribute to filter on.

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

AttributeFilter -> (structure)

A filter on a single attribute value.

Attribute -> (string)

The attribute name to filter on.

Operator -> (string)

The comparison operator. Valid values are equals , greaterThan , greaterThanOrEquals , lessThan , lessThanOrEquals , and notExists .

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

LongValue -> (long)

A long integer filter value.

MapFilter -> (structure)

A filter on a map attribute’s key-value pair.

Attribute -> (string)

The map attribute name to filter on.

Key -> (string)

The key within the map attribute to filter on.

Value -> (tagged union structure)

The value to compare against.

Note

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

StringValue -> (string)

A string filter value.

JSON Syntax:

{
  "AndAllFilters": [
    {
      "AndAllFilters": [
        { ... recursive ... }
        ...
      ],
      "OrAnyFilters": [
        { ... recursive ... }
        ...
      ],
      "AttributeFilter": {
        "Attribute": "string",
        "Operator": "equals"|"greaterThan"|"greaterThanOrEquals"|"lessThan"|"lessThanOrEquals"|"notExists",
        "Value": {
          "StringValue": "string",
          "LongValue": long
        }
      },
      "MapFilter": {
        "Attribute": "string",
        "Key": "string",
        "Value": {
          "StringValue": "string"
        }
      }
    }
    ...
  ],
  "OrAnyFilters": [
    {
      "AndAllFilters": [
        { ... recursive ... }
        ...
      ],
      "OrAnyFilters": [
        { ... recursive ... }
        ...
      ],
      "AttributeFilter": {
        "Attribute": "string",
        "Operator": "equals"|"greaterThan"|"greaterThanOrEquals"|"lessThan"|"lessThanOrEquals"|"notExists",
        "Value": {
          "StringValue": "string",
          "LongValue": long
        }
      },
      "MapFilter": {
        "Attribute": "string",
        "Key": "string",
        "Value": {
          "StringValue": "string"
        }
      }
    }
    ...
  ],
  "AttributeFilter": {
    "Attribute": "string",
    "Operator": "equals"|"greaterThan"|"greaterThanOrEquals"|"lessThan"|"lessThanOrEquals"|"notExists",
    "Value": {
      "StringValue": "string",
      "LongValue": long
    }
  },
  "MapFilter": {
    "Attribute": "string",
    "Key": "string",
    "Value": {
      "StringValue": "string"
    }
  }
}

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Items -> (list)

The list of assets matching the search criteria.

(structure)

A single search result item representing a matched asset.

Id -> (string)

The unique identifier of the matched asset.

AssetName -> (string)

The name of the matched asset.

AssetDescription -> (string)

The description of the matched asset.

UpdatedAt -> (timestamp)

The timestamp at which the matched asset was last updated.

AssetTypeId -> (string)

The identifier of the asset type for the matched asset.

NextToken -> (string)

A continuation token, present if the current segment is not the last.