openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.UpdatePartition API'
description: 'Glue
Defines the public endpoint for the Glue service.'
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: 'AWS Glue #X Amz Target=AWSGlue.UpdatePartition API'
paths:
/#X-Amz-Target=AWSGlue.UpdatePartition:
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: UpdatePartition
description: Updates a partition.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePartitionResponse'
examples:
UpdatePartition200Example:
summary: Default UpdatePartition 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
UpdatePartition480Example:
summary: Default UpdatePartition 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdatePartition481Example:
summary: Default UpdatePartition 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdatePartition482Example:
summary: Default UpdatePartition 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
UpdatePartition483Example:
summary: Default UpdatePartition 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
UpdatePartition484Example:
summary: Default UpdatePartition 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePartitionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.UpdatePartition
summary: Amazon Glue Update Partition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.UpdatePartition API'
components:
schemas:
ValueStringList:
type: array
items:
$ref: '#/components/schemas/ValueString'
InvalidInputException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
EntityNotFoundException: {}
ColumnTypeString:
type: string
minLength: 0
maxLength: 131072
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
InternalServiceException: {}
SchemaId:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema. One of SchemaArn or SchemaName 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.
UpdatePartitionRequest:
type: object
required:
- DatabaseName
- TableName
- PartitionValueList
- PartitionInput
title: UpdatePartitionRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the partition to be updated 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 in question resides.
TableName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table in which the partition to be updated is located.
PartitionValueList:
allOf:
- $ref: '#/components/schemas/BoundedPartitionValueList'
- description: List of partition key values that define the partition to update.
PartitionInput:
allOf:
- $ref: '#/components/schemas/PartitionInput'
- description:
The new partition object to update the partition to.
The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
== 1), or in descending order (==0).
description: Specifies the sort order of a sorted column.
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
OrderList:
type: array
items:
$ref: '#/components/schemas/Order'
ValueString:
type: string
maxLength: 1024
UpdatePartitionResponse:
type: object
properties: {}
GlueEncryptionException: {}
ColumnValuesString:
type: string
IntegerFlag:
type: integer
minimum: 0
maximum: 1
StorageDescriptor:
type: object
properties:
Columns:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: A list of the Columns 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: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.'
OutputFormat:
allOf:
- $ref: '#/components/schemas/FormatString'
- description: 'The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.'
Compressed:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the data in the table is compressed, or False 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: ' True if the table data is stored in subdirectories, or False if not.'
SchemaReference:
allOf:
- $ref: '#/components/schemas/SchemaReference'
- description: An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
description: Describes the physical storage of table data. Timestamp: type: string format: date-time SchemaReference: type: object properties: SchemaId: allOf: - $ref: '#/components/schemas/SchemaId' - description: A structure that contains schema identity fields. Either this or theSchemaVersionId 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 SchemaId 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.
ParametersMapValue:
type: string
maxLength: 512000
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.
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
CommentString:
type: string
minLength: 0
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
Integer:
type: integer
Column:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Column.
Type:
allOf:
- $ref: '#/components/schemas/ColumnTypeString'
- description: The data type of the Column.
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 Table.
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 org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
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.
LocationStringList:
type: array
items:
$ref: '#/components/schemas/LocationString'
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
ColumnValueStringList:
type: array
items:
$ref: '#/components/schemas/ColumnValuesString'
CatalogIdString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
Boolean:
type: boolean
OperationTimeoutException: {}
LocationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ColumnValuesString'
FormatString:
type: string
maxLength: 128
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
NameStringList:
type: array
items:
$ref: '#/components/schemas/NameString'
PartitionInput:
type: object
properties:
Values:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
LastAccessTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time at which the partition was accessed. StorageDescriptor: allOf: - $ref: '#/components/schemas/StorageDescriptor' - description: Provides information about the physical location where the partition is stored. Parameters: allOf: - $ref: '#/components/schemas/ParametersMap' - description: These key-value pairs define partition parameters. LastAnalyzedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time at which column statistics were computed for this partition. description: The structure used to create and update a partition. ParametersMap: type: object additionalProperties: $ref: '#/components/schemas/ParametersMapValue' ColumnList: type: array items: $ref: '#/components/schemas/Column' BoundedPartitionValueList: type: array items: $ref: '#/components/schemas/ValueString' minItems: 0 maxItems: 100 parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm 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-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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