Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetUnfilteredPartitionsMetadata

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

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

Request Syntax


{
   "AuditContext": { 
      "AdditionalAuditContext": "string",
      "AllColumnsRequested": boolean,
      "RequestedColumns": [ "string" ]
   },
   "CatalogId": "string",
   "DatabaseName": "string",
   "Expression": "string",
   "MaxResults": number,
   "NextToken": "string",
   "QuerySessionContext": { 
      "AdditionalContext": { 
         "string" : "string" 
      },
      "ClusterId": "string",
      "QueryAuthorizationId": "string",
      "QueryId": "string",
      "QueryStartTime": number
   },
   "Region": "string",
   "Segment": { 
      "SegmentNumber": number,
      "TotalSegments": number
   },
   "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 ID of the Data Catalog where the partitions in question reside. If none is provided, 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: Yes

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 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.

string
date
timestamp
int
bigint
long
tinyint
smallint
decimal

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

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

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

Segment

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

Type: Segment object

Required: No

SupportedPermissionTypes

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

The name of the 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


{
   "NextToken": "string",
   "UnfilteredPartitions": [ 
      { 
         "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.

NextToken

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

Type: String

UnfilteredPartitions

A list of requested partitions.

Type: Array of UnfilteredPartition 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

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