Skip to content

UpdateTableRequest

Source code in docs_src/capo_glue/types/update_table_request.py
class UpdateTableRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.</p>"""
    database_name: "capo_glue.types.name_string.NameString"
    """<p>The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.</p>"""
    name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The unique identifier for the table within the specified database that will be created in the Glue Data Catalog.</p>"""
    table_input: NotRequired["capo_glue.types.table_input.TableInput"]
    """<p>An updated <code>TableInput</code> object to define the metadata table in the catalog.</p>"""
    skip_archive: NotRequired["capo_glue.types.boolean_nullable.BooleanNullable"]
    """<p>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.</p>"""
    transaction_id: NotRequired[
        "capo_glue.types.transaction_id_string.TransactionIdString"
    ]
    """<p>The transaction ID at which to update the table contents. </p>"""
    version_id: NotRequired["capo_glue.types.version_string.VersionString"]
    """<p>The version ID at which to update the table contents. </p>"""
    view_update_action: NotRequired[
        "capo_glue.types.view_update_action.ViewUpdateAction"
    ]
    """<p>The operation to be performed when updating the view.</p>"""
    force: "capo_glue.types.boolean.Boolean"
    """<p>A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.</p>"""
    update_open_table_format_input: NotRequired[
        "capo_glue.types.update_open_table_format_input.UpdateOpenTableFormatInput"
    ]
    """<p>Input parameters for updating open table format tables in GlueData Catalog, serving as a wrapper for format-specific update operations such as Apache Iceberg.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

database_name instance-attribute

database_name: NameString

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

force instance-attribute

force: Boolean

A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.

name instance-attribute

name: NotRequired[NameString]

The unique identifier for the table within the specified database that will be created in the Glue Data Catalog.

skip_archive instance-attribute

skip_archive: NotRequired[BooleanNullable]

By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.

table_input instance-attribute

table_input: NotRequired[TableInput]

An updated TableInput object to define the metadata table in the catalog.

transaction_id instance-attribute

transaction_id: NotRequired[TransactionIdString]

The transaction ID at which to update the table contents.

update_open_table_format_input instance-attribute

update_open_table_format_input: NotRequired[UpdateOpenTableFormatInput]

Input parameters for updating open table format tables in GlueData Catalog, serving as a wrapper for format-specific update operations such as Apache Iceberg.

version_id instance-attribute

version_id: NotRequired[VersionString]

The version ID at which to update the table contents.

view_update_action instance-attribute

view_update_action: NotRequired[ViewUpdateAction]

The operation to be performed when updating the view.