Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

get-unfiltered-partitions-metadata

Description

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 .

See also: AWS API Documentation

Synopsis

  get-unfiltered-partitions-metadata
--catalog-id <value>
--database-name <value>
--table-name <value>
[--expression <value>]
[--audit-context <value>]
--supported-permission-types <value>
[--next-token <value>]
[--segment <value>]
[--max-results <value>]
[--query-session-context <value>]
[--resource-region <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--catalog-id (string)

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

--database-name (string)

The name of the catalog database where the partitions reside.

--table-name (string)

The name of the table that contains the partition.

--expression (string)

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.

--audit-context (structure)

A structure containing Lake Formation audit context information.

AdditionalAuditContext -> (string)

A string containing the additional audit context information.

RequestedColumns -> (list)

The requested columns for audit.

(string)

AllColumnsRequested -> (boolean)

All columns request for audit.

Shorthand Syntax:

AdditionalAuditContext=string,RequestedColumns=string,string,AllColumnsRequested=boolean

JSON Syntax:

{
  "AdditionalAuditContext": "string",
  "RequestedColumns": ["string", ...],
  "AllColumnsRequested": true|false
}

--supported-permission-types (list)

A list of supported permission types.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  COLUMN_PERMISSION
  CELL_FILTER_PERMISSION
  NESTED_PERMISSION
  NESTED_CELL_PERMISSION

--next-token (string)

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

--segment (structure)

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

SegmentNumber -> (integer)

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 -> (integer)

The total number of segments.

Shorthand Syntax:

SegmentNumber=integer,TotalSegments=integer

JSON Syntax:

{
  "SegmentNumber": integer,
  "TotalSegments": integer
}

--max-results (integer)

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

--query-session-context (structure)

A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

QueryId -> (string)

A unique identifier generated by the query engine for the query.

QueryStartTime -> (timestamp)

A timestamp provided by the query engine for when the query started.

ClusterId -> (string)

An identifier string for the consumer cluster.

QueryAuthorizationId -> (string)

A cryptographically generated query identifier generated by Glue or Lake Formation.

AdditionalContext -> (map)

An opaque string-string map passed by the query engine.

key -> (string)

value -> (string)

Shorthand Syntax:

QueryId=string,QueryStartTime=timestamp,ClusterId=string,QueryAuthorizationId=string,AdditionalContext={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "QueryId": "string",
  "QueryStartTime": timestamp,
  "ClusterId": "string",
  "QueryAuthorizationId": "string",
  "AdditionalContext": {"string": "string"
    ...}
}

--resource-region (string)

Specified only if the base tables belong to a different Amazon Web Services Region.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

UnfilteredPartitions -> (list)

A list of requested partitions.

(structure)

A partition that contains unfiltered metadata.

Partition -> (structure)

The partition object.

Values -> (list)

The values of the partition.

(string)

DatabaseName -> (string)

The name of the catalog database in which to create the partition.

TableName -> (string)

The name of the database table in which to create the partition.

CreationTime -> (timestamp)

The time at which the partition was created.

LastAccessTime -> (timestamp)

The last time at which the partition was accessed.

StorageDescriptor -> (structure)

Provides information about the physical location where the partition is stored.

Columns -> (list)

A list of the Columns in the table.

(structure)

A column in a Table .

Name -> (string)

The name of the Column .

Type -> (string)

The data type of the Column .

Comment -> (string)

A free-form text comment.

Parameters -> (map)

These key-value pairs define properties associated with the column.

key -> (string)

value -> (string)

Location -> (string)

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 -> (list)

A list of locations that point to the path where a Delta table is located.

(string)

InputFormat -> (string)

The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

OutputFormat -> (string)

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

Compressed -> (boolean)

True if the data in the table is compressed, or False if not.

NumberOfBuckets -> (integer)

Must be specified if the table contains any dimension columns.

SerdeInfo -> (structure)

The serialization/deserialization (SerDe) information.

Name -> (string)

Name of the SerDe.

SerializationLibrary -> (string)

Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

Parameters -> (map)

These key-value pairs define initialization parameters for the SerDe.

key -> (string)

value -> (string)

BucketColumns -> (list)

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

(string)

SortColumns -> (list)

A list specifying the sort order of each bucket in the table.

(structure)

Specifies the sort order of a sorted column.

Column -> (string)

The name of the column.

SortOrder -> (integer)

Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).

Parameters -> (map)

The user-supplied properties in key-value form.

key -> (string)

value -> (string)

SkewedInfo -> (structure)

The information about values that appear frequently in a column (skewed values).

SkewedColumnNames -> (list)

A list of names of columns that contain skewed values.

(string)

SkewedColumnValues -> (list)

A list of values that appear so frequently as to be considered skewed.

(string)

SkewedColumnValueLocationMaps -> (map)

A mapping of skewed values to the columns that contain them.

key -> (string)

value -> (string)

StoredAsSubDirectories -> (boolean)

True if the table data is stored in subdirectories, or False if not.

SchemaReference -> (structure)

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.

SchemaId -> (structure)

A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

SchemaArn -> (string)

The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaName -> (string)

The name of the schema. One of SchemaArn or SchemaName has to be provided.

RegistryName -> (string)

The name of the schema registry that contains the schema.

SchemaVersionId -> (string)

The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

SchemaVersionNumber -> (long)

The version number of the schema.

Parameters -> (map)

These key-value pairs define partition parameters.

key -> (string)

value -> (string)

LastAnalyzedTime -> (timestamp)

The last time at which column statistics were computed for this partition.

CatalogId -> (string)

The ID of the Data Catalog in which the partition resides.

AuthorizedColumns -> (list)

The list of columns the user has permissions to access.

(string)

IsRegisteredWithLakeFormation -> (boolean)

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

NextToken -> (string)

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