BatchGetPartition
Retrieves partitions in a batch request.
Request Syntax
{
"AuditContext": {
"AdditionalAuditContext": "string",
"AllColumnsRequested": boolean,
"RequestedColumns": [ "string" ]
},
"CatalogId": "string",
"DatabaseName": "string",
"PartitionsToGet": [
{
"Values": [ "string" ]
}
],
"QuerySessionContext": {
"AdditionalContext": {
"string" : "string"
},
"ClusterId": "string",
"QueryAuthorizationId": "string",
"QueryId": "string",
"QueryStartTime": 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.
- AuditContext
-
A structure containing the Lake Formation audit context.
Type: AuditContext object
Required: No
- 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
- PartitionsToGet
-
A list of partition values identifying the partitions to retrieve.
Type: Array of PartitionValueList objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Required: Yes
- QuerySessionContext
-
A structure used as a protocol between query engines and Lake Formation or AWS Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
For more information about how to utilize QuerySessionContext, see Lake Formation workflow for application integration API operations in the developer guide.
Type: QuerySessionContext 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
{
"Partitions": [
{
"CatalogId": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastAccessTime": number,
"LastAnalyzedTime": number,
"Parameters": {
"string" : "string"
},
"StorageDescriptor": {
"AdditionalLocations": [ "string" ],
"BucketColumns": [ "string" ],
"Columns": [
{
"Comment": "string",
"Name": "string",
"Parameters": {
"string" : "string"
},
"Type": "string"
}
],
"Compressed": boolean,
"InputFormat": "string",
"Location": "string",
"NumberOfBuckets": number,
"OutputFormat": "string",
"Parameters": {
"string" : "string"
},
"SchemaReference": {
"SchemaId": {
"RegistryName": "string",
"SchemaArn": "string",
"SchemaName": "string"
},
"SchemaVersionId": "string",
"SchemaVersionNumber": number
},
"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" ]
}
],
"UnprocessedKeys": [
{
"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.
- Partitions
-
A list of the requested partitions.
Type: Array of Partition objects
- UnprocessedKeys
-
A list of the partition values in the request for which partitions were not returned.
Type: Array of PartitionValueList objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- EntityNotFoundException
-
A specified entity does not exist
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- FederationSourceException
-
A federation source failed.
- FederationSourceErrorCode
-
The error code of the problem.
- Message
-
The message describing the problem.
HTTP Status Code: 400
- FederationSourceRetryableException
-
A federation source failed, but the operation may be retried.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- GlueEncryptionException
-
An encryption operation failed.
- Message
-
The message describing the problem.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
- Message
-
A message describing the problem.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- InvalidStateException
-
An error that indicates your data is in an invalid state.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
- Message
-
A message describing the problem.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: