Amazon Glue · Schema

GetUnfilteredPartitionsMetadataRequest

GetUnfilteredPartitionsMetadataRequest schema from Amazon Glue API

AnalyticsData CatalogData IntegrationData PipelineETLServerless

Properties

Name Type Description
CatalogId object
DatabaseName object
TableName object
Expression object
AuditContext object
SupportedPermissionTypes object
NextToken object
Segment object
MaxResults object
View JSON Schema on GitHub

JSON Schema

glue-get-unfiltered-partitions-metadata-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-get-unfiltered-partitions-metadata-request-schema.json",
  "title": "GetUnfilteredPartitionsMetadataRequest",
  "description": "GetUnfilteredPartitionsMetadataRequest schema from Amazon Glue API",
  "type": "object",
  "properties": {
    "CatalogId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CatalogIdString"
        },
        {
          "description": "The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default. "
        }
      ]
    },
    "DatabaseName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the catalog database where the partitions reside."
        }
      ]
    },
    "TableName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the table that contains the partition."
        }
      ]
    },
    "Expression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PredicateString"
        },
        {
          "description": "<p>An expression that filters the partitions to be returned.</p> <p>The expression uses SQL syntax similar to the SQL <code>WHERE</code> filter clause. The SQL statement parser <a href=\"http://jsqlparser.sourceforge.net/home.php\">JSQLParser</a> parses the expression. </p> <p> <i>Operators</i>: The following are the operators that you can use in the <code>Expression</code> API call:</p> <dl> <dt>=</dt> <dd> <p>Checks whether the values of the two operands are equal; if yes, then the condition becomes true.</p> <p>Example: Assume 'variable a' holds 10 and 'variable b' holds 20. </p> <p>(a = b) is not true.</p> </dd> <dt>&lt; &gt;</dt> <dd> <p>Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.</p> <p>Example: (a &lt; &gt; b) is true.</p> </dd> <dt>&gt;</dt> <dd> <p>Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a &gt; b) is not true.</p> </dd> <dt>&lt;</dt> <dd> <p>Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a &lt; b) is true.</p> </dd> <dt>&gt;=</dt> <dd> <p>Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a &gt;= b) is not true.</p> </dd> <dt>&lt;=</dt> <dd> <p>Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a &lt;= b) is true.</p> </dd> <dt>AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL</dt> <dd> <p>Logical operators.</p> </dd> </dl> <p> <i>Supported Partition Key Types</i>: The following are the supported partition keys.</p> <ul> <li> <p> <code>string</code> </p> </li> <li> <p> <code>date</code> </p> </li> <li> <p> <code>timestamp</code> </p> </li> <li> <p> <code>int</code> </p> </li> <li> <p> <code>bigint</code> </p> </li> <li> <p> <code>long</code> </p> </li> <li> <p> <code>tinyint</code> </p> </li> <li> <p> <code>smallint</code> </p> </li> <li> <p> <code>decimal</code> </p> </li> </ul> <p>If an type is encountered that is not valid, an exception is thrown. </p>"
        }
      ]
    },
    "AuditContext": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuditContext"
        },
        {
          "description": "A structure containing Lake Formation audit context information."
        }
      ]
    },
    "SupportedPermissionTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PermissionTypeList"
        },
        {
          "description": "A list of supported permission types. "
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Token"
        },
        {
          "description": "A continuation token, if this is not the first call to retrieve these partitions."
        }
      ]
    },
    "Segment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Segment"
        },
        {
          "description": "The segment of the table's partitions to scan in this request."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": "The maximum number of partitions to return in a single response."
        }
      ]
    }
  },
  "required": [
    "CatalogId",
    "DatabaseName",
    "TableName",
    "SupportedPermissionTypes"
  ]
}