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 UpdateCatalog API operation.

Syntax

Update-GLUECatalog
-CatalogId <String>
-CatalogInput_AllowFullTableExternalDataAccess <AllowFullTableExternalDataAccessEnum>
-TargetRedshiftCatalog_CatalogArn <String>
-DataLakeAccessProperties_CatalogType <String>
-IcebergOptimizationProperties_Compaction <Hashtable>
-FederatedCatalog_ConnectionName <String>
-FederatedCatalog_ConnectionType <String>
-CatalogInput_CreateDatabaseDefaultPermission <PrincipalPermissions[]>
-CatalogInput_CreateTableDefaultPermission <PrincipalPermissions[]>
-CatalogProperties_CustomProperty <Hashtable>
-DataLakeAccessProperties_DataLakeAccess <Boolean>
-DataLakeAccessProperties_DataTransferRole <String>
-CatalogInput_Description <String>
-FederatedCatalog_Identifier <String>
-DataLakeAccessProperties_KmsKey <String>
-IcebergOptimizationProperties_OrphanFileDeletion <Hashtable>
-CatalogInput_Parameter <Hashtable>
-IcebergOptimizationProperties_Retention <Hashtable>
-IcebergOptimizationProperties_RoleArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonGlueConfig>

Description

Updates an existing catalog's properties in the Glue Data Catalog.

Parameters

-CatalogId <String>
The ID of the catalog.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CatalogInput_AllowFullTableExternalDataAccess <AllowFullTableExternalDataAccessEnum>
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CatalogInput_CreateDatabaseDefaultPermission <PrincipalPermissions[]>
An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CreateDatabaseDefaultPermissions
-CatalogInput_CreateTableDefaultPermission <PrincipalPermissions[]>
An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CreateTableDefaultPermissions
-CatalogInput_Description <String>
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CatalogInput_Parameter <Hashtable>
A map array of key-value pairs that define the parameters and properties of the catalog. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_Parameters
-CatalogProperties_CustomProperty <Hashtable>
Additional key-value properties for the catalog, such as column statistics optimizations. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_CustomProperties
-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataLakeAccessProperties_CatalogType <String>
Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_DataLakeAccessProperties_CatalogType
-DataLakeAccessProperties_DataLakeAccess <Boolean>
Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_DataLakeAccessProperties_DataLakeAccess
-DataLakeAccessProperties_DataTransferRole <String>
A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_DataLakeAccessProperties_DataTransferRole
-DataLakeAccessProperties_KmsKey <String>
An encryption key that will be used for the staging bucket that will be created along with the catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_DataLakeAccessProperties_KmsKey
-FederatedCatalog_ConnectionName <String>
The name of the connection to an external data source, for example a Redshift-federated catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_FederatedCatalog_ConnectionName
-FederatedCatalog_ConnectionType <String>
The type of connection used to access the federated catalog, specifying the protocol or method for connection to the external data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_FederatedCatalog_ConnectionType
-FederatedCatalog_Identifier <String>
A unique identifier for the federated catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_FederatedCatalog_Identifier
-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)
-IcebergOptimizationProperties_Compaction <Hashtable>
A map of key-value pairs that specify configuration parameters for Iceberg table compaction operations, which optimize the layout of data files to improve query performance. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_IcebergOptimizationProperties_Compaction
-IcebergOptimizationProperties_OrphanFileDeletion <Hashtable>
A map of key-value pairs that specify configuration parameters for Iceberg orphan file deletion operations, which identify and remove files that are no longer referenced by the table metadata. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_IcebergOptimizationProperties_OrphanFileDeletion
-IcebergOptimizationProperties_Retention <Hashtable>
A map of key-value pairs that specify configuration parameters for Iceberg table retention operations, which manage the lifecycle of table snapshots to control storage costs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_IcebergOptimizationProperties_Retention
-IcebergOptimizationProperties_RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that will be assumed to perform Iceberg table optimization operations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_CatalogProperties_IcebergOptimizationProperties_RoleArn
-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.UpdateCatalogResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetRedshiftCatalog_CatalogArn <String>
The Amazon Resource Name (ARN) of the catalog resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCatalogInput_TargetRedshiftCatalog_CatalogArn

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.UpdateCatalogResponse
This cmdlet does not generate any output.The service response (type Amazon.Glue.Model.UpdateCatalogResponse) 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