AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Glue CreateTableOptimizer API operation.

Syntax

New-GLUETableOptimizer
-CatalogId <String>
-IcebergConfiguration_CleanExpiredFile <Boolean>
-DatabaseName <String>
-IcebergConfiguration_DeleteFileThreshold <Int32>
-TableOptimizerConfiguration_Enabled <Boolean>
-VpcConfiguration_GlueConnectionName <String>
-IcebergConfiguration_Location <String>
-IcebergConfiguration_MinInputFile <Int32>
-IcebergConfiguration_NumberOfSnapshotsToRetain <Int32>
-IcebergConfiguration_OrphanFileRetentionPeriodInDay <Int32>
-TableOptimizerConfiguration_RoleArn <String>
-TableOptimizerConfiguration_OrphanFileDeletionConfiguration_IcebergConfiguration_RunRateInHours <Int32>
-TableOptimizerConfiguration_RetentionConfiguration_IcebergConfiguration_RunRateInHours <Int32>
-IcebergConfiguration_SnapshotRetentionPeriodInDay <Int32>
-IcebergConfiguration_Strategy <CompactionStrategy>
-TableName <String>
-Type <TableOptimizerType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonGlueConfig>

Description

Creates a new table optimizer for a specific function.

Parameters

-CatalogId <String>
The Catalog ID of the table.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The name of the database in the catalog in which the table resides.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IcebergConfiguration_CleanExpiredFile <Boolean>
If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_RetentionConfiguration_IcebergConfiguration_CleanExpiredFiles
-IcebergConfiguration_DeleteFileThreshold <Int32>
The minimum number of deletes that must be present in a data file to make it eligible for compaction. This parameter helps optimize compaction by focusing on files that contain a significant number of delete operations, which can improve query performance by removing deleted records. If an input is not provided, the default value 1 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_CompactionConfiguration_IcebergConfiguration_DeleteFileThreshold
-IcebergConfiguration_Location <String>
Specifies a directory in which to look for files (defaults to the table's location). You may choose a sub-directory rather than the top-level table location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_OrphanFileDeletionConfiguration_IcebergConfiguration_Location
-IcebergConfiguration_MinInputFile <Int32>
The minimum number of data files that must be present in a partition before compaction will actually compact files. This parameter helps control when compaction is triggered, preventing unnecessary compaction operations on partitions with few files. If an input is not provided, the default value 100 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_CompactionConfiguration_IcebergConfiguration_MinInputFiles
-IcebergConfiguration_NumberOfSnapshotsToRetain <Int32>
The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_RetentionConfiguration_IcebergConfiguration_NumberOfSnapshotsToRetain
-IcebergConfiguration_OrphanFileRetentionPeriodInDay <Int32>
The number of days that orphan files should be retained before file deletion. If an input is not provided, the default value 3 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_OrphanFileDeletionConfiguration_IcebergConfiguration_OrphanFileRetentionPeriodInDays
-IcebergConfiguration_SnapshotRetentionPeriodInDay <Int32>
The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_RetentionConfiguration_IcebergConfiguration_SnapshotRetentionPeriodInDays
-IcebergConfiguration_Strategy <CompactionStrategy>
The strategy to use for compaction. Valid values are:
  • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.
  • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.
  • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.
If an input is not provided, the default value 'binpack' will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_CompactionConfiguration_IcebergConfiguration_Strategy
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.CreateTableOptimizerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableName <String>
The name of the table.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableOptimizerConfiguration_Enabled <Boolean>
Whether table optimization is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableOptimizerConfiguration_OrphanFileDeletionConfiguration_IcebergConfiguration_RunRateInHours <Int32>
The interval in hours between orphan file deletion job runs. This parameter controls how frequently the orphan file deletion optimizer will run to clean up orphan files. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableOptimizerConfiguration_RetentionConfiguration_IcebergConfiguration_RunRateInHours <Int32>
The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableOptimizerConfiguration_RoleArn <String>
A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <TableOptimizerType>
The type of table optimizer.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfiguration_GlueConnectionName <String>
The name of the Glue connection used for the VPC for the table optimizer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableOptimizerConfiguration_VpcConfiguration_GlueConnectionName

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.Glue.Model.CreateTableOptimizerResponse
This cmdlet does not generate any output.The service response (type Amazon.Glue.Model.CreateTableOptimizerResponse) be returned by specifying '-Select *'.
Developer Resources
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z