Amazon Glue · Schema

SearchTablesRequest

SearchTablesRequest schema from Amazon Glue API

AnalyticsData CatalogData IntegrationData PipelineETLServerless

Properties

Name Type Description
CatalogId object
NextToken object
Filters object
SearchText object
SortCriteria object
MaxResults object
ResourceShareType object
View JSON Schema on GitHub

JSON Schema

glue-search-tables-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue/refs/heads/main/json-schema/glue-search-tables-request-schema.json",
  "title": "SearchTablesRequest",
  "description": "SearchTablesRequest schema from Amazon Glue API",
  "type": "object",
  "properties": {
    "CatalogId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CatalogIdString"
        },
        {
          "description": "A unique identifier, consisting of <code> <i>account_id</i> </code>."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Token"
        },
        {
          "description": "A continuation token, included if this is a continuation call."
        }
      ]
    },
    "Filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SearchPropertyPredicates"
        },
        {
          "description": "<p>A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.</p> <p>The <code>Comparator</code> member of the <code>PropertyPredicate</code> struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when <code>Key=Name</code>, a fuzzy match algorithm is used. The <code>Key</code> field (for example, the value of the <code>Name</code> field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the <code>Value</code> member of <code>PropertyPredicate</code>. For example, if <code>Key=Name</code> and <code>Value=link</code>, tables named <code>customer-link</code> and <code>xx-link-yy</code> are returned, but <code>xxlinkyy</code> is not returned.</p>"
        }
      ]
    },
    "SearchText": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ValueString"
        },
        {
          "description": "<p>A string used for a text search.</p> <p>Specifying a value in quotes filters based on an exact match to the value.</p>"
        }
      ]
    },
    "SortCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortCriteria"
        },
        {
          "description": "A list of criteria for sorting the results by a field name, in an ascending or descending order."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": "The maximum number of tables to return in a single response."
        }
      ]
    },
    "ResourceShareType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceShareType"
        },
        {
          "description": "<p>Allows you to specify that you want to search the tables shared with your account. The allowable values are <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FOREIGN</code>, will search the tables shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will search the tables shared with your account, as well as the tables in yor local account. </p> </li> </ul>"
        }
      ]
    }
  }
}