Amazon Glue · JSON Structure

Glue Update Table Request Structure

UpdateTableRequest schema from Amazon Glue API

Type: object Properties: 6 Required: 2
AnalyticsData CatalogData IntegrationData PipelineETLServerless

UpdateTableRequest is a JSON Structure definition published by Amazon Glue, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CatalogId DatabaseName TableInput SkipArchive TransactionId VersionId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue/refs/heads/main/json-structure/glue-update-table-request-structure.json",
  "name": "UpdateTableRequest",
  "description": "UpdateTableRequest schema from Amazon Glue API",
  "type": "object",
  "properties": {
    "CatalogId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CatalogIdString"
        },
        {
          "description": "The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default."
        }
      ]
    },
    "DatabaseName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase."
        }
      ]
    },
    "TableInput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TableInput"
        },
        {
          "description": "An updated <code>TableInput</code> object to define the metadata table in the catalog."
        }
      ]
    },
    "SkipArchive": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanNullable"
        },
        {
          "description": "By default, <code>UpdateTable</code> always creates an archived version of the table before updating it. However, if <code>skipArchive</code> is set to true, <code>UpdateTable</code> does not create the archived version."
        }
      ]
    },
    "TransactionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TransactionIdString"
        },
        {
          "description": "The transaction ID at which to update the table contents. "
        }
      ]
    },
    "VersionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionString"
        },
        {
          "description": "The version ID at which to update the table contents. "
        }
      ]
    }
  },
  "required": [
    "DatabaseName",
    "TableInput"
  ]
}