Amazon Glue #X Amz Target=AWSGlue.UpdateTable API

openapi: 3.0.0
info:
  version: '2017-03-31'
  x-release: v4
  title: 'AWS Glue #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.UpdateTable API'
  description: <fullname>Glue</fullname> <p>Defines the public endpoint for the Glue service.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: glue
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/glue-2017-03-31.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: https://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSGlue.UpdateTable'
paths:
  /#X-Amz-Target=AWSGlue.UpdateTable:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: UpdateTable
      description: Updates a metadata table in the Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTableResponse'
              examples:
                UpdateTable200Example:
                  summary: Default UpdateTable 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                UpdateTable480Example:
                  summary: Default UpdateTable 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateTable481Example:
                  summary: Default UpdateTable 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateTable482Example:
                  summary: Default UpdateTable 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                UpdateTable483Example:
                  summary: Default UpdateTable 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '484':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
              examples:
                UpdateTable484Example:
                  summary: Default UpdateTable 484 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '485':
          description: ResourceNumberLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNumberLimitExceededException'
              examples:
                UpdateTable485Example:
                  summary: Default UpdateTable 485 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '486':
          description: GlueEncryptionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlueEncryptionException'
              examples:
                UpdateTable486Example:
                  summary: Default UpdateTable 486 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '487':
          description: ResourceNotReadyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotReadyException'
              examples:
                UpdateTable487Example:
                  summary: Default UpdateTable 487 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTableRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateTable
      summary: Amazon Glue Update Table
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSGlue.UpdateTable'
components:
  schemas:
    IntegerFlag:
      type: integer
      minimum: 0
      maximum: 1
    StorageDescriptor:
      type: object
      properties:
        Columns:
          allOf:
          - $ref: '#/components/schemas/ColumnList'
          - description: A list of the <code>Columns</code> in the table.
        Location:
          allOf:
          - $ref: '#/components/schemas/LocationString'
          - description: The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
        AdditionalLocations:
          allOf:
          - $ref: '#/components/schemas/LocationStringList'
          - description: A list of locations that point to the path where a Delta table is located.
        InputFormat:
          allOf:
          - $ref: '#/components/schemas/FormatString'
          - description: 'The input format: <code>SequenceFileInputFormat</code> (binary), or <code>TextInputFormat</code>, or a custom format.'
        OutputFormat:
          allOf:
          - $ref: '#/components/schemas/FormatString'
          - description: 'The output format: <code>SequenceFileOutputFormat</code> (binary), or <code>IgnoreKeyTextOutputFormat</code>, or a custom format.'
        Compressed:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' <code>True</code> if the data in the table is compressed, or <code>False</code> if not.'
        NumberOfBuckets:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Must be specified if the table contains any dimension columns.
        SerdeInfo:
          allOf:
          - $ref: '#/components/schemas/SerDeInfo'
          - description: The serialization/deserialization (SerDe) information.
        BucketColumns:
          allOf:
          - $ref: '#/components/schemas/NameStringList'
          - description: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
        SortColumns:
          allOf:
          - $ref: '#/components/schemas/OrderList'
          - description: A list specifying the sort order of each bucket in the table.
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParametersMap'
          - description: The user-supplied properties in key-value form.
        SkewedInfo:
          allOf:
          - $ref: '#/components/schemas/SkewedInfo'
          - description: The information about values that appear frequently in a column (skewed values).
        StoredAsSubDirectories:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' <code>True</code> if the table data is stored in subdirectories, or <code>False</code> if not.'
        SchemaReference:
          allOf:
          - $ref: '#/components/schemas/SchemaReference'
          - description: <p>An object that references a schema stored in the Glue Schema Registry.</p> <p>When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.</p>
      description: Describes the physical storage of table data.
    ColumnList:
      type: array
      items:
        $ref: '#/components/schemas/Column'
    LocationStringList:
      type: array
      items:
        $ref: '#/components/schemas/LocationString'
    InternalServiceException: {}
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    FormatString:
      type: string
      maxLength: 128
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    ColumnTypeString:
      type: string
      minLength: 0
      maxLength: 131072
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    Boolean:
      type: boolean
    LocationString:
      type: string
      maxLength: 2056
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    BooleanNullable:
      type: boolean
    ColumnValueStringList:
      type: array
      items:
        $ref: '#/components/schemas/ColumnValuesString'
    SchemaId:
      type: object
      properties:
        SchemaArn:
          allOf:
          - $ref: '#/components/schemas/GlueResourceArn'
          - description: The Amazon Resource Name (ARN) of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.
        SchemaName:
          allOf:
          - $ref: '#/components/schemas/SchemaRegistryNameString'
          - description: The name of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.
        RegistryName:
          allOf:
          - $ref: '#/components/schemas/SchemaRegistryNameString'
          - description: The name of the schema registry that contains the schema.
      description: The unique ID of the schema in the Glue schema registry.
    EntityNotFoundException: {}
    NameStringList:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    OperationTimeoutException: {}
    Column:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the <code>Column</code>.
        Type:
          allOf:
          - $ref: '#/components/schemas/ColumnTypeString'
          - description: The data type of the <code>Column</code>.
        Comment:
          allOf:
          - $ref: '#/components/schemas/CommentString'
          - description: A free-form text comment.
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParametersMap'
          - description: These key-value pairs define properties associated with the column.
      description: A column in a <code>Table</code>.
    ParametersMapValue:
      type: string
      maxLength: 512000
    CommentString:
      type: string
      minLength: 0
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    SkewedInfo:
      type: object
      properties:
        SkewedColumnNames:
          allOf:
          - $ref: '#/components/schemas/NameStringList'
          - description: A list of names of columns that contain skewed values.
        SkewedColumnValues:
          allOf:
          - $ref: '#/components/schemas/ColumnValueStringList'
          - description: A list of values that appear so frequently as to be considered skewed.
        SkewedColumnValueLocationMaps:
          allOf:
          - $ref: '#/components/schemas/LocationMap'
          - description: A mapping of skewed values to the columns that contain them.
      description: Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
    UpdateTableResponse:
      type: object
      properties: {}
    TableInput:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The table name. For Hive compatibility, this is folded to lowercase when it is stored.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: A description of the table.
        Owner:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
        LastAccessTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last time that the table was accessed.
        LastAnalyzedTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last time that column statistics were computed for this table.
        Retention:
          allOf:
          - $ref: '#/components/schemas/NonNegativeInteger'
          - description: The retention time for this table.
        StorageDescriptor:
          allOf:
          - $ref: '#/components/schemas/StorageDescriptor'
          - description: A storage descriptor containing information about the physical storage of this table.
        PartitionKeys:
          allOf:
          - $ref: '#/components/schemas/ColumnList'
          - description: '<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When you create a table used by Amazon Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>"PartitionKeys": []</code> </p>'
        ViewOriginalText:
          allOf:
          - $ref: '#/components/schemas/ViewTextString'
          - description: Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a <code>VIRTUAL_VIEW</code>, certain Athena configuration encoded in base64.
        ViewExpandedText:
          allOf:
          - $ref: '#/components/schemas/ViewTextString'
          - description: Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
        TableType:
          allOf:
          - $ref: '#/components/schemas/TableTypeString'
          - description: <p>The type of this table. Glue will create tables with the <code>EXTERNAL_TABLE</code> type. Other services, such as Athena, may create tables with additional table types. </p> <p>Glue related table types:</p> <dl> <dt>EXTERNAL_TABLE</dt> <dd> <p>Hive compatible attribute - indicates a non-Hive managed table.</p> </dd> <dt>GOVERNED</dt> <dd> <p>Used by Lake Formation. The Glue Data Catalog understands <code>GOVERNED</code>.</p> </dd> </dl>
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParametersMap'
          - description: These key-value pairs define properties associated with the table.
        TargetTable:
          allOf:
          - $ref: '#/components/schemas/TableIdentifier'
          - description: A <code>TableIdentifier</code> structure that describes a target table for resource linking.
      description: A structure used to define a table.
    SchemaVersionIdString:
      type: string
      pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
      minLength: 36
      maxLength: 36
    ConcurrentModificationException: {}
    CatalogIdString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    OrderList:
      type: array
      items:
        $ref: '#/components/schemas/Order'
    TableIdentifier:
      type: object
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog in which the table resides.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the catalog database that contains the target table.
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the target table.
      description: A structure that describes a target table for resource linking.
    SchemaRegistryNameString:
      type: string
      pattern: '[a-zA-Z0-9-_$#.]+'
      minLength: 1
      maxLength: 255
    SerDeInfo:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: Name of the SerDe.
        SerializationLibrary:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: Usually the class that implements the SerDe. An example is <code>org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe</code>.
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParametersMap'
          - description: These key-value pairs define initialization parameters for the SerDe.
      description: Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
    SchemaReference:
      type: object
      properties:
        SchemaId:
          allOf:
          - $ref: '#/components/schemas/SchemaId'
          - description: A structure that contains schema identity fields. Either this or the <code>SchemaVersionId</code> has to be provided.
        SchemaVersionId:
          allOf:
          - $ref: '#/components/schemas/SchemaVersionIdString'
          - description: The unique ID assigned to a version of the schema. Either this or the <code>SchemaId</code> has to be provided.
        SchemaVersionNumber:
          allOf:
          - $ref: '#/components/schemas/VersionLongNumber'
          - description: The version number of the schema.
      description: An object that references a schema stored in the Glue Schema Registry.
    UpdateTableRequest:
      type: object
      required:
      - DatabaseName
      - TableInput
      title: UpdateTableRequest
      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. '
    ColumnValuesString:
      type: string
    ParametersMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ParametersMapValue'
    GlueResourceArn:
      type: string
      pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
      minLength: 1
      maxLength: 10240
    TransactionIdString:
      type: string
      pattern: '[\p{L}\p{N}\p{P}]*'
      minLength: 1
      maxLength: 255
    GlueEncryptionException: {}
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    Order:
      type: object
      required:
      - Column
      - SortOrder
      properties:
        Column:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the column.
        SortOrder:
          allOf:
          - $ref: '#/components/schemas/IntegerFlag'
          - description: Indicates that the column is sorted in ascending order (<code>== 1</code>), or in descending order (<code>==0</code>).
      description: Specifies the sort order of a sorted column.
    Integer:
      type: integer
    Timestamp:
      type: string
      format: date-time
    ViewTextString:
      type: string
      maxLength: 409600
    VersionString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    LocationMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ColumnValuesString'
    ResourceNumberLimitExceededException: {}
    VersionLongNumber:
      type: integer
      minimum: 1
      maximum: 100000
    NonNegativeInteger:
      type: integer
      minimum: 0
    ResourceNotReadyException: {}
    TableTypeString:
      type: string
      maxLength: 255
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-hasEquivalentPaths: true