Menu
AWS Glue
Web API Reference (API Version 2017-03-31)

GetPartitions

Retrieves information about the partitions in a table.

Request Syntax

{ "CatalogId": "string", "DatabaseName": "string", "Expression": "string", "MaxResults": number, "NextToken": "string", "Segment": { "SegmentNumber": number, "TotalSegments": number }, "TableName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

DatabaseName

The name of the catalog database where the partitions reside.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Expression

An expression filtering the partitions to be returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

MaxResults

The maximum number of partitions to return in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A continuation token, if this is not the first call to retrieve these partitions.

Type: String

Required: No

Segment

The segment of the table's partitions to scan in this request.

Type: Segment object

Required: No

TableName

The name of the partitions' table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax

{ "NextToken": "string", "Partitions": [ { "CreationTime": number, "DatabaseName": "string", "LastAccessTime": number, "LastAnalyzedTime": number, "Parameters": { "string" : "string" }, "StorageDescriptor": { "BucketColumns": [ "string" ], "Columns": [ { "Comment": "string", "Name": "string", "Type": "string" } ], "Compressed": boolean, "InputFormat": "string", "Location": "string", "NumberOfBuckets": number, "OutputFormat": "string", "Parameters": { "string" : "string" }, "SerdeInfo": { "Name": "string", "Parameters": { "string" : "string" }, "SerializationLibrary": "string" }, "SkewedInfo": { "SkewedColumnNames": [ "string" ], "SkewedColumnValueLocationMaps": { "string" : "string" }, "SkewedColumnValues": [ "string" ] }, "SortColumns": [ { "Column": "string", "SortOrder": number } ], "StoredAsSubDirectories": boolean }, "TableName": "string", "Values": [ "string" ] } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A continuation token, if the returned list of partitions does not does not include the last one.

Type: String

Partitions

A list of requested partitions.

Type: Array of Partition objects

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: