Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetUnfilteredPartitionMetadata

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.

For IAM authorization, the public IAM action associated with this API is glue:GetPartition.

Request Syntax


{
   "AuditContext": { 
      "AdditionalAuditContext": "string",
      "AllColumnsRequested": boolean,
      "RequestedColumns": [ "string" ]
   },
   "CatalogId": "string",
   "DatabaseName": "string",
   "PartitionValues": [ "string" ],
   "QuerySessionContext": { 
      "AdditionalContext": { 
         "string" : "string" 
      },
      "ClusterId": "string",
      "QueryAuthorizationId": "string",
      "QueryId": "string",
      "QueryStartTime": number
   },
   "Region": "string",
   "SupportedPermissionTypes": [ "string" ],
   "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 Lake Formation audit context information.

Type: AuditContext object

Required: No

CatalogId

The catalog ID where the partition resides.

Type: String

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

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

Required: Yes

DatabaseName

(Required) Specifies the name of a database that contains the partition.

Type: String

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

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

Required: Yes

PartitionValues

(Required) A list of partition key values.

Type: Array of strings

Length Constraints: Maximum length of 1024.

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.

Type: QuerySessionContext object

Required: No

Region

Specified only if the base tables belong to a different AWS Region.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

SupportedPermissionTypes

(Required) A list of supported permission types.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 255 items.

Valid Values: COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION

Required: Yes

TableName

(Required) Specifies the name of a table that contains the partition.

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


{
   "AuthorizedColumns": [ "string" ],
   "IsRegisteredWithLakeFormation": boolean,
   "Partition": { 
      "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" ]
   }
}

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.

AuthorizedColumns

A list of column names that the user has been granted access to.

Type: Array of strings

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

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

IsRegisteredWithLakeFormation

A Boolean value that indicates whether the partition location is registered with Lake Formation.

Type: Boolean

Partition

A Partition object containing the partition metadata.

Type: Partition object

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

FederationSourceException

A federation source failed.

HTTP Status Code: 400

FederationSourceRetryableException

A federation source failed, but the operation may be retried.

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

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

PermissionTypeMismatchException

The operation timed out.

HTTP Status Code: 400