AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.glue.getCatalogTable

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.glue.getCatalogTable({
    name: "MyCatalogTable",
    databaseName: "MyCatalogDatabase",
});

import pulumi
import pulumi_aws as aws

example = aws.glue.get_catalog_table(name="MyCatalogTable",
    database_name="MyCatalogDatabase")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.LookupCatalogTable(ctx, &glue.LookupCatalogTableArgs{
			Name:         "MyCatalogTable",
			DatabaseName: "MyCatalogDatabase",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Glue.GetCatalogTable.Invoke(new()
    {
        Name = "MyCatalogTable",
        DatabaseName = "MyCatalogDatabase",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.GlueFunctions;
import com.pulumi.aws.glue.inputs.GetCatalogTableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = GlueFunctions.getCatalogTable(GetCatalogTableArgs.builder()
            .name("MyCatalogTable")
            .databaseName("MyCatalogDatabase")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:glue:getCatalogTable
      arguments:
        name: MyCatalogTable
        databaseName: MyCatalogDatabase

Using getCatalogTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCatalogTable(args: GetCatalogTableArgs, opts?: InvokeOptions): Promise<GetCatalogTableResult>
function getCatalogTableOutput(args: GetCatalogTableOutputArgs, opts?: InvokeOptions): Output<GetCatalogTableResult>

def get_catalog_table(catalog_id: Optional[str] = None,
                      database_name: Optional[str] = None,
                      name: Optional[str] = None,
                      query_as_of_time: Optional[str] = None,
                      transaction_id: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCatalogTableResult
def get_catalog_table_output(catalog_id: Optional[pulumi.Input[str]] = None,
                      database_name: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      query_as_of_time: Optional[pulumi.Input[str]] = None,
                      transaction_id: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCatalogTableResult]

func LookupCatalogTable(ctx *Context, args *LookupCatalogTableArgs, opts ...InvokeOption) (*LookupCatalogTableResult, error)
func LookupCatalogTableOutput(ctx *Context, args *LookupCatalogTableOutputArgs, opts ...InvokeOption) LookupCatalogTableResultOutput

> Note: This function is named LookupCatalogTable in the Go SDK.

public static class GetCatalogTable 
{
    public static Task<GetCatalogTableResult> InvokeAsync(GetCatalogTableArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogTableResult> Invoke(GetCatalogTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogTableResult> getCatalogTable(GetCatalogTableArgs args, InvokeOptions options)
public static Output<GetCatalogTableResult> getCatalogTable(GetCatalogTableArgs args, InvokeOptions options)

fn::invoke:
  function: aws:glue/getCatalogTable:getCatalogTable
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseName string: Name of the metadata database where the table metadata resides.
Name string: Name of the table.
CatalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
QueryAsOfTime string: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
TransactionId int: The transaction ID at which to read the table contents.

DatabaseName string: Name of the metadata database where the table metadata resides.
Name string: Name of the table.
CatalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
QueryAsOfTime string: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
TransactionId int: The transaction ID at which to read the table contents.

databaseName String: Name of the metadata database where the table metadata resides.
name String: Name of the table.
catalogId String: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
queryAsOfTime String: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
transactionId Integer: The transaction ID at which to read the table contents.

databaseName string: Name of the metadata database where the table metadata resides.
name string: Name of the table.
catalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
queryAsOfTime string: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
transactionId number: The transaction ID at which to read the table contents.

database_name str: Name of the metadata database where the table metadata resides.
name str: Name of the table.
catalog_id str: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
query_as_of_time str: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
transaction_id int: The transaction ID at which to read the table contents.

databaseName String: Name of the metadata database where the table metadata resides.
name String: Name of the table.
catalogId String: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
queryAsOfTime String: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with transaction_id. Specified in RFC 3339 format, e.g. 2006-01-02T15:04:05Z07:00.
transactionId Number: The transaction ID at which to read the table contents.

getCatalogTable Result

The following output properties are available:

Arn string: The ARN of the Glue Table.
CatalogId string: ID of the Data Catalog in which the table resides.
DatabaseName string: Name of the catalog database that contains the target table.
Description string: Description of the table.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the target table.
Owner string: Owner of the table.
Parameters Dictionary<string, string>: Map of initialization parameters for the SerDe, in key-value form.
PartitionIndices List<GetCatalogTablePartitionIndex>: Configuration block for a maximum of 3 partition indexes. See partition_index below.
PartitionKeys List<GetCatalogTablePartitionKey>: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
Retention int: Retention time for this table.
StorageDescriptors List<GetCatalogTableStorageDescriptor>: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
TableType string: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
TargetTables List<GetCatalogTableTargetTable>: Configuration block of a target table for resource linking. See target_table below.
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.
QueryAsOfTime string
TransactionId int

Arn string: The ARN of the Glue Table.
CatalogId string: ID of the Data Catalog in which the table resides.
DatabaseName string: Name of the catalog database that contains the target table.
Description string: Description of the table.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the target table.
Owner string: Owner of the table.
Parameters map[string]string: Map of initialization parameters for the SerDe, in key-value form.
PartitionIndices []GetCatalogTablePartitionIndex: Configuration block for a maximum of 3 partition indexes. See partition_index below.
PartitionKeys []GetCatalogTablePartitionKey: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
Retention int: Retention time for this table.
StorageDescriptors []GetCatalogTableStorageDescriptor: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
TableType string: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
TargetTables []GetCatalogTableTargetTable: Configuration block of a target table for resource linking. See target_table below.
ViewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
ViewOriginalText string: If the table is a view, the original text of the view; otherwise null.
QueryAsOfTime string
TransactionId int

arn String: The ARN of the Glue Table.
catalogId String: ID of the Data Catalog in which the table resides.
databaseName String: Name of the catalog database that contains the target table.
description String: Description of the table.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the target table.
owner String: Owner of the table.
parameters Map<String,String>: Map of initialization parameters for the SerDe, in key-value form.
partitionIndices List<GetCatalogTablePartitionIndex>: Configuration block for a maximum of 3 partition indexes. See partition_index below.
partitionKeys List<GetCatalogTablePartitionKey>: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
retention Integer: Retention time for this table.
storageDescriptors List<GetCatalogTableStorageDescriptor>: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
tableType String: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
targetTables List<GetCatalogTableTargetTable>: Configuration block of a target table for resource linking. See target_table below.
viewExpandedText String: If the table is a view, the expanded text of the view; otherwise null.
viewOriginalText String: If the table is a view, the original text of the view; otherwise null.
queryAsOfTime String
transactionId Integer

arn string: The ARN of the Glue Table.
catalogId string: ID of the Data Catalog in which the table resides.
databaseName string: Name of the catalog database that contains the target table.
description string: Description of the table.
id string: The provider-assigned unique ID for this managed resource.
name string: Name of the target table.
owner string: Owner of the table.
parameters {[key: string]: string}: Map of initialization parameters for the SerDe, in key-value form.
partitionIndices GetCatalogTablePartitionIndex[]: Configuration block for a maximum of 3 partition indexes. See partition_index below.
partitionKeys GetCatalogTablePartitionKey[]: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
retention number: Retention time for this table.
storageDescriptors GetCatalogTableStorageDescriptor[]: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
tableType string: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
targetTables GetCatalogTableTargetTable[]: Configuration block of a target table for resource linking. See target_table below.
viewExpandedText string: If the table is a view, the expanded text of the view; otherwise null.
viewOriginalText string: If the table is a view, the original text of the view; otherwise null.
queryAsOfTime string
transactionId number

arn str: The ARN of the Glue Table.
catalog_id str: ID of the Data Catalog in which the table resides.
database_name str: Name of the catalog database that contains the target table.
description str: Description of the table.
id str: The provider-assigned unique ID for this managed resource.
name str: Name of the target table.
owner str: Owner of the table.
parameters Mapping[str, str]: Map of initialization parameters for the SerDe, in key-value form.
partition_indices Sequence[GetCatalogTablePartitionIndex]: Configuration block for a maximum of 3 partition indexes. See partition_index below.
partition_keys Sequence[GetCatalogTablePartitionKey]: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
retention int: Retention time for this table.
storage_descriptors Sequence[GetCatalogTableStorageDescriptor]: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
table_type str: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
target_tables Sequence[GetCatalogTableTargetTable]: Configuration block of a target table for resource linking. See target_table below.
view_expanded_text str: If the table is a view, the expanded text of the view; otherwise null.
view_original_text str: If the table is a view, the original text of the view; otherwise null.
query_as_of_time str
transaction_id int

arn String: The ARN of the Glue Table.
catalogId String: ID of the Data Catalog in which the table resides.
databaseName String: Name of the catalog database that contains the target table.
description String: Description of the table.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the target table.
owner String: Owner of the table.
parameters Map<String>: Map of initialization parameters for the SerDe, in key-value form.
partitionIndices List<Property Map>: Configuration block for a maximum of 3 partition indexes. See partition_index below.
partitionKeys List<Property Map>: Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See partition_keys below.
retention Number: Retention time for this table.
storageDescriptors List<Property Map>: Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See storage_descriptor below.
tableType String: Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is empty.
targetTables List<Property Map>: Configuration block of a target table for resource linking. See target_table below.
viewExpandedText String: If the table is a view, the expanded text of the view; otherwise null.
viewOriginalText String: If the table is a view, the original text of the view; otherwise null.
queryAsOfTime String
transactionId Number

Supporting Types

GetCatalogTablePartitionIndex

IndexName string: Name of the partition index.
IndexStatus string
Keys List<string>: Keys for the partition index.

IndexName string: Name of the partition index.
IndexStatus string
Keys []string: Keys for the partition index.

indexName String: Name of the partition index.
indexStatus String
keys List<String>: Keys for the partition index.

indexName string: Name of the partition index.
indexStatus string
keys string[]: Keys for the partition index.

index_name str: Name of the partition index.
index_status str
keys Sequence[str]: Keys for the partition index.

indexName String: Name of the partition index.
indexStatus String
keys List<String>: Keys for the partition index.

GetCatalogTablePartitionKey

Comment string: Free-form text comment.
Name string: Name of the table.
Type string: Datatype of data in the Column.

Comment string: Free-form text comment.
Name string: Name of the table.
Type string: Datatype of data in the Column.

comment String: Free-form text comment.
name String: Name of the table.
type String: Datatype of data in the Column.

comment string: Free-form text comment.
name string: Name of the table.
type string: Datatype of data in the Column.

comment str: Free-form text comment.
name str: Name of the table.
type str: Datatype of data in the Column.

comment String: Free-form text comment.
name String: Name of the table.
type String: Datatype of data in the Column.

GetCatalogTableStorageDescriptor

AdditionalLocations List<string>: List of locations that point to the path where a Delta table is located
BucketColumns List<string>: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
Columns List<GetCatalogTableStorageDescriptorColumn>: Configuration block for columns in the table. See columns below.
Compressed bool: Whether the data in the table is compressed.
InputFormat string: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
Location string: 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.
NumberOfBuckets int: Is if the table contains any dimension columns.
OutputFormat string: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Parameters Dictionary<string, string>: Map of initialization parameters for the SerDe, in key-value form.
SchemaReferences List<GetCatalogTableStorageDescriptorSchemaReference>: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
SerDeInfos List<GetCatalogTableStorageDescriptorSerDeInfo>: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
SkewedInfos List<GetCatalogTableStorageDescriptorSkewedInfo>: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
SortColumns List<GetCatalogTableStorageDescriptorSortColumn>: Configuration block for the sort order of each bucket in the table. See sort_columns below.
StoredAsSubDirectories bool: Whether the table data is stored in subdirectories.

AdditionalLocations []string: List of locations that point to the path where a Delta table is located
BucketColumns []string: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
Columns []GetCatalogTableStorageDescriptorColumn: Configuration block for columns in the table. See columns below.
Compressed bool: Whether the data in the table is compressed.
InputFormat string: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
Location string: 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.
NumberOfBuckets int: Is if the table contains any dimension columns.
OutputFormat string: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Parameters map[string]string: Map of initialization parameters for the SerDe, in key-value form.
SchemaReferences []GetCatalogTableStorageDescriptorSchemaReference: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
SerDeInfos []GetCatalogTableStorageDescriptorSerDeInfo: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
SkewedInfos []GetCatalogTableStorageDescriptorSkewedInfo: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
SortColumns []GetCatalogTableStorageDescriptorSortColumn: Configuration block for the sort order of each bucket in the table. See sort_columns below.
StoredAsSubDirectories bool: Whether the table data is stored in subdirectories.

additionalLocations List<String>: List of locations that point to the path where a Delta table is located
bucketColumns List<String>: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns List<GetCatalogTableStorageDescriptorColumn>: Configuration block for columns in the table. See columns below.
compressed Boolean: Whether the data in the table is compressed.
inputFormat String: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location String: 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.
numberOfBuckets Integer: Is if the table contains any dimension columns.
outputFormat String: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters Map<String,String>: Map of initialization parameters for the SerDe, in key-value form.
schemaReferences List<GetCatalogTableStorageDescriptorSchemaReference>: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
serDeInfos List<GetCatalogTableStorageDescriptorSerDeInfo>: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
skewedInfos List<GetCatalogTableStorageDescriptorSkewedInfo>: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
sortColumns List<GetCatalogTableStorageDescriptorSortColumn>: Configuration block for the sort order of each bucket in the table. See sort_columns below.
storedAsSubDirectories Boolean: Whether the table data is stored in subdirectories.

additionalLocations string[]: List of locations that point to the path where a Delta table is located
bucketColumns string[]: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns GetCatalogTableStorageDescriptorColumn[]: Configuration block for columns in the table. See columns below.
compressed boolean: Whether the data in the table is compressed.
inputFormat string: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location string: 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.
numberOfBuckets number: Is if the table contains any dimension columns.
outputFormat string: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters {[key: string]: string}: Map of initialization parameters for the SerDe, in key-value form.
schemaReferences GetCatalogTableStorageDescriptorSchemaReference[]: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
serDeInfos GetCatalogTableStorageDescriptorSerDeInfo[]: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
skewedInfos GetCatalogTableStorageDescriptorSkewedInfo[]: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
sortColumns GetCatalogTableStorageDescriptorSortColumn[]: Configuration block for the sort order of each bucket in the table. See sort_columns below.
storedAsSubDirectories boolean: Whether the table data is stored in subdirectories.

additional_locations Sequence[str]: List of locations that point to the path where a Delta table is located
bucket_columns Sequence[str]: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns Sequence[GetCatalogTableStorageDescriptorColumn]: Configuration block for columns in the table. See columns below.
compressed bool: Whether the data in the table is compressed.
input_format str: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location str: 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.
number_of_buckets int: Is if the table contains any dimension columns.
output_format str: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters Mapping[str, str]: Map of initialization parameters for the SerDe, in key-value form.
schema_references Sequence[GetCatalogTableStorageDescriptorSchemaReference]: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
ser_de_infos Sequence[GetCatalogTableStorageDescriptorSerDeInfo]: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
skewed_infos Sequence[GetCatalogTableStorageDescriptorSkewedInfo]: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
sort_columns Sequence[GetCatalogTableStorageDescriptorSortColumn]: Configuration block for the sort order of each bucket in the table. See sort_columns below.
stored_as_sub_directories bool: Whether the table data is stored in subdirectories.

additionalLocations List<String>: List of locations that point to the path where a Delta table is located
bucketColumns List<String>: List of reducer grouping columns, clustering columns, and bucketing columns in the table.
columns List<Property Map>: Configuration block for columns in the table. See columns below.
compressed Boolean: Whether the data in the table is compressed.
inputFormat String: Input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
location String: 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.
numberOfBuckets Number: Is if the table contains any dimension columns.
outputFormat String: Output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
parameters Map<String>: Map of initialization parameters for the SerDe, in key-value form.
schemaReferences List<Property Map>: Object that references a schema stored in the AWS Glue Schema Registry. See schema_reference below.
serDeInfos List<Property Map>: Configuration block for serialization and deserialization ("SerDe") information. See ser_de_info below.
skewedInfos List<Property Map>: Configuration block with information about values that appear very frequently in a column (skewed values). See skewed_info below.
sortColumns List<Property Map>: Configuration block for the sort order of each bucket in the table. See sort_columns below.
storedAsSubDirectories Boolean: Whether the table data is stored in subdirectories.

GetCatalogTableStorageDescriptorColumn

Comment string: Free-form text comment.
Name string: Name of the table.
Parameters Dictionary<string, string>: Map of initialization parameters for the SerDe, in key-value form.
Type string: Datatype of data in the Column.

Comment string: Free-form text comment.
Name string: Name of the table.
Parameters map[string]string: Map of initialization parameters for the SerDe, in key-value form.
Type string: Datatype of data in the Column.

comment String: Free-form text comment.
name String: Name of the table.
parameters Map<String,String>: Map of initialization parameters for the SerDe, in key-value form.
type String: Datatype of data in the Column.

comment string: Free-form text comment.
name string: Name of the table.
parameters {[key: string]: string}: Map of initialization parameters for the SerDe, in key-value form.
type string: Datatype of data in the Column.

comment str: Free-form text comment.
name str: Name of the table.
parameters Mapping[str, str]: Map of initialization parameters for the SerDe, in key-value form.
type str: Datatype of data in the Column.

comment String: Free-form text comment.
name String: Name of the table.
parameters Map<String>: Map of initialization parameters for the SerDe, in key-value form.
type String: Datatype of data in the Column.

GetCatalogTableStorageDescriptorSchemaReference

SchemaIds List<GetCatalogTableStorageDescriptorSchemaReferenceSchemaId>: Configuration block that contains schema identity fields. See schema_id below.
SchemaVersionId string: Unique ID assigned to a version of the schema.
SchemaVersionNumber int: Version number of the schema.

SchemaIds []GetCatalogTableStorageDescriptorSchemaReferenceSchemaId: Configuration block that contains schema identity fields. See schema_id below.
SchemaVersionId string: Unique ID assigned to a version of the schema.
SchemaVersionNumber int: Version number of the schema.

schemaIds List<GetCatalogTableStorageDescriptorSchemaReferenceSchemaId>: Configuration block that contains schema identity fields. See schema_id below.
schemaVersionId String: Unique ID assigned to a version of the schema.
schemaVersionNumber Integer: Version number of the schema.

schemaIds GetCatalogTableStorageDescriptorSchemaReferenceSchemaId[]: Configuration block that contains schema identity fields. See schema_id below.
schemaVersionId string: Unique ID assigned to a version of the schema.
schemaVersionNumber number: Version number of the schema.

schema_ids Sequence[GetCatalogTableStorageDescriptorSchemaReferenceSchemaId]: Configuration block that contains schema identity fields. See schema_id below.
schema_version_id str: Unique ID assigned to a version of the schema.
schema_version_number int: Version number of the schema.

schemaIds List<Property Map>: Configuration block that contains schema identity fields. See schema_id below.
schemaVersionId String: Unique ID assigned to a version of the schema.
schemaVersionNumber Number: Version number of the schema.

GetCatalogTableStorageDescriptorSchemaReferenceSchemaId

RegistryName string: Name of the schema registry that contains the schema.
SchemaArn string: ARN of the schema.
SchemaName string: Name of the schema.

RegistryName string: Name of the schema registry that contains the schema.
SchemaArn string: ARN of the schema.
SchemaName string: Name of the schema.

registryName String: Name of the schema registry that contains the schema.
schemaArn String: ARN of the schema.
schemaName String: Name of the schema.

registryName string: Name of the schema registry that contains the schema.
schemaArn string: ARN of the schema.
schemaName string: Name of the schema.

registry_name str: Name of the schema registry that contains the schema.
schema_arn str: ARN of the schema.
schema_name str: Name of the schema.

registryName String: Name of the schema registry that contains the schema.
schemaArn String: ARN of the schema.
schemaName String: Name of the schema.

GetCatalogTableStorageDescriptorSerDeInfo

Name string: Name of the table.
Parameters Dictionary<string, string>: Map of initialization parameters for the SerDe, in key-value form.
SerializationLibrary string: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

Name string: Name of the table.
Parameters map[string]string: Map of initialization parameters for the SerDe, in key-value form.
SerializationLibrary string: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

name String: Name of the table.
parameters Map<String,String>: Map of initialization parameters for the SerDe, in key-value form.
serializationLibrary String: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

name string: Name of the table.
parameters {[key: string]: string}: Map of initialization parameters for the SerDe, in key-value form.
serializationLibrary string: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

name str: Name of the table.
parameters Mapping[str, str]: Map of initialization parameters for the SerDe, in key-value form.
serialization_library str: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

name String: Name of the table.
parameters Map<String>: Map of initialization parameters for the SerDe, in key-value form.
serializationLibrary String: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

GetCatalogTableStorageDescriptorSkewedInfo

SkewedColumnNames List<string>: List of names of columns that contain skewed values.
SkewedColumnValueLocationMaps Dictionary<string, string>: List of values that appear so frequently as to be considered skewed.
SkewedColumnValues List<string>: Map of skewed values to the columns that contain them.

SkewedColumnNames []string: List of names of columns that contain skewed values.
SkewedColumnValueLocationMaps map[string]string: List of values that appear so frequently as to be considered skewed.
SkewedColumnValues []string: Map of skewed values to the columns that contain them.

skewedColumnNames List<String>: List of names of columns that contain skewed values.
skewedColumnValueLocationMaps Map<String,String>: List of values that appear so frequently as to be considered skewed.
skewedColumnValues List<String>: Map of skewed values to the columns that contain them.

skewedColumnNames string[]: List of names of columns that contain skewed values.
skewedColumnValueLocationMaps {[key: string]: string}: List of values that appear so frequently as to be considered skewed.
skewedColumnValues string[]: Map of skewed values to the columns that contain them.

skewed_column_names Sequence[str]: List of names of columns that contain skewed values.
skewed_column_value_location_maps Mapping[str, str]: List of values that appear so frequently as to be considered skewed.
skewed_column_values Sequence[str]: Map of skewed values to the columns that contain them.

skewedColumnNames List<String>: List of names of columns that contain skewed values.
skewedColumnValueLocationMaps Map<String>: List of values that appear so frequently as to be considered skewed.
skewedColumnValues List<String>: Map of skewed values to the columns that contain them.

GetCatalogTableStorageDescriptorSortColumn

Column string: Name of the column.
SortOrder int: Whether the column is sorted in ascending (1) or descending order (0).

Column string: Name of the column.
SortOrder int: Whether the column is sorted in ascending (1) or descending order (0).

column String: Name of the column.
sortOrder Integer: Whether the column is sorted in ascending (1) or descending order (0).

column string: Name of the column.
sortOrder number: Whether the column is sorted in ascending (1) or descending order (0).

column str: Name of the column.
sort_order int: Whether the column is sorted in ascending (1) or descending order (0).

column String: Name of the column.
sortOrder Number: Whether the column is sorted in ascending (1) or descending order (0).

GetCatalogTableTargetTable

CatalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
DatabaseName string: Name of the metadata database where the table metadata resides.
Name string: Name of the table.
Region string: Region of the target table.

CatalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
DatabaseName string: Name of the metadata database where the table metadata resides.
Name string: Name of the table.
Region string: Region of the target table.

catalogId String: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
databaseName String: Name of the metadata database where the table metadata resides.
name String: Name of the table.
region String: Region of the target table.

catalogId string: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
databaseName string: Name of the metadata database where the table metadata resides.
name string: Name of the table.
region string: Region of the target table.

catalog_id str: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
database_name str: Name of the metadata database where the table metadata resides.
name str: Name of the table.
region str: Region of the target table.

catalogId String: ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID.
databaseName String: Name of the metadata database where the table metadata resides.
name String: Name of the table.
region String: Region of the target table.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.glue.getCatalogTable

On this page

On this page

Example Usage

Using getCatalogTable

getCatalogTable Result

Supporting Types

GetCatalogTablePartitionIndex

GetCatalogTablePartitionKey

GetCatalogTableStorageDescriptor

GetCatalogTableStorageDescriptorColumn

GetCatalogTableStorageDescriptorSchemaReference

GetCatalogTableStorageDescriptorSchemaReferenceSchemaId

GetCatalogTableStorageDescriptorSerDeInfo

GetCatalogTableStorageDescriptorSkewedInfo

GetCatalogTableStorageDescriptorSortColumn

GetCatalogTableTargetTable

Package Details

On this page

On this page