openapi: 3.2.0 info: version: '2017-03-31' x-release: v4 title: 'AWS Glue #X Amz Target=AWSGlue.GetPartitions 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.GetPartitions API' paths: /#X-Amz-Target=AWSGlue.GetPartitions: 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: GetPartitions description: Retrieves information about the partitions in a table. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPartitionsResponse' examples: GetPartitions200Example: summary: Default GetPartitions 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetPartitions480Example: summary: Default GetPartitions 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetPartitions481Example: summary: Default GetPartitions 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: OperationTimeoutException content: application/json: schema: $ref: '#/components/schemas/OperationTimeoutException' examples: GetPartitions482Example: summary: Default GetPartitions 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetPartitions483Example: summary: Default GetPartitions 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: GlueEncryptionException content: application/json: schema: $ref: '#/components/schemas/GlueEncryptionException' examples: GetPartitions484Example: summary: Default GetPartitions 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: InvalidStateException content: application/json: schema: $ref: '#/components/schemas/InvalidStateException' examples: GetPartitions485Example: summary: Default GetPartitions 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '486': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' examples: GetPartitions486Example: summary: Default GetPartitions 486 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '487': description: FederationSourceException content: application/json: schema: $ref: '#/components/schemas/FederationSourceException' examples: GetPartitions487Example: summary: Default GetPartitions 487 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '488': description: FederationSourceRetryableException content: application/json: schema: $ref: '#/components/schemas/FederationSourceRetryableException' examples: GetPartitions488Example: summary: Default GetPartitions 488 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetPartitionsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetPartitions summary: Amazon Glue Get Partitions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - 'AWS Glue #X Amz Target=AWSGlue.GetPartitions 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: {} ResourceNotReadyException: {} Partition: type: object properties: Values: allOf: - $ref: '#/components/schemas/ValueStringList' - description: The values of the partition. DatabaseName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the catalog database in which to create the partition. TableName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the database table in which to create the partition. CreationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time at which the partition was created. 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. CatalogId: allOf: - $ref: '#/components/schemas/CatalogIdString' - description: The ID of the Data Catalog in which the partition resides. description: Represents a slice of table data. 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. LocationString: type: string maxLength: 2056 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\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 (== 1), or in descending order (==0). description: Specifies the sort order of a sorted column. PageSize: type: integer minimum: 1 maximum: 1000 NonNegativeInteger: type: integer minimum: 0 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 GlueEncryptionException: {} ColumnValuesString: type: string IntegerFlag: type: integer minimum: 0 maximum: 1 InvalidStateException: {} 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 the SchemaVersionId 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 GetPartitionsRequest: type: object required: - DatabaseName - TableName title: GetPartitionsRequest 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 Amazon Web Services 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 partitions' table. Expression: allOf: - $ref: '#/components/schemas/PredicateString' - description: '

An expression that filters the partitions to be returned.

The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.

Operators: The following are the operators that you can use in the Expression API call:

=

Checks whether the values of the two operands are equal; if yes, then the condition becomes true.

Example: Assume ''variable a'' holds 10 and ''variable b'' holds 20.

(a = b) is not true.

< >

Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.

Example: (a < > b) is true.

>

Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.

Example: (a > b) is not true.

<

Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.

Example: (a < b) is true.

>=

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.

Example: (a >= b) is not true.

<=

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.

Example: (a <= b) is true.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

Logical operators.

Supported Partition Key Types: The following are the supported partition keys.

If an type is encountered that is not valid, an exception is thrown.

The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.

Sample API Call:

' 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. ExcludeColumnSchema: allOf: - $ref: '#/components/schemas/BooleanNullable' - description: When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data. TransactionId: allOf: - $ref: '#/components/schemas/TransactionIdString' - description: The transaction ID at which to read the partition contents. QueryAsOfTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId. Token: type: string PredicateString: type: string minLength: 0 maxLength: 2048 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' BooleanNullable: type: boolean Segment: type: object required: - SegmentNumber - TotalSegments properties: SegmentNumber: allOf: - $ref: '#/components/schemas/NonNegativeInteger' - description: The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3. TotalSegments: allOf: - $ref: '#/components/schemas/TotalSegmentsInteger' - description: The total number of segments. description: Defines a non-overlapping region of a table's partitions, allowing multiple requests to be run in parallel. CommentString: type: string minLength: 0 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' 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. TransactionIdString: type: string pattern: '[\p{L}\p{N}\p{P}]*' minLength: 1 maxLength: 255 TotalSegmentsInteger: type: integer minimum: 1 maximum: 10 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. Integer: type: integer LocationStringList: type: array items: $ref: '#/components/schemas/LocationString' PartitionList: type: array items: $ref: '#/components/schemas/Partition' 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' FederationSourceRetryableException: {} FormatString: type: string maxLength: 128 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' NameStringList: type: array items: $ref: '#/components/schemas/NameString' GetPartitionsResponse: type: object properties: Partitions: allOf: - $ref: '#/components/schemas/PartitionList' - description: A list of requested partitions. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: A continuation token, if the returned list of partitions does not include the last one. ParametersMap: type: object additionalProperties: $ref: '#/components/schemas/ParametersMapValue' FederationSourceException: {} ColumnList: type: array items: $ref: '#/components/schemas/Column' 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