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

Syntax

Get-GLUEUnfilteredTableMetadata
-CatalogId <String>
-AuditContext_AdditionalAuditContext <String>
-QuerySessionContext_AdditionalContext <Hashtable>
-AuditContext_AllColumnsRequested <Boolean>
-QuerySessionContext_ClusterId <String>
-DatabaseName <String>
-SupportedDialect_Dialect <ViewDialect>
-SupportedDialect_DialectVersion <String>
-Name <String>
-ParentResourceArn <String>
-Permission <String[]>
-QuerySessionContext_QueryAuthorizationId <String>
-QuerySessionContext_QueryId <String>
-QuerySessionContext_QueryStartTime <DateTime>
-ResourceRegion <String>
-AuditContext_RequestedColumn <String[]>
-RootResourceArn <String>
-SupportedPermissionType <String[]>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonGlueConfig>

Description

Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog. For IAM authorization, the public IAM action associated with this API is glue:GetTable.

Parameters

-AuditContext_AdditionalAuditContext <String>
A string containing the additional audit context information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuditContext_AllColumnsRequested <Boolean>
All columns request for audit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuditContext_RequestedColumn <String[]>
The requested columns for audit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuditContext_RequestedColumns
-CatalogId <String>
The catalog ID where the table resides.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
(Required) Specifies the name of a database that contains the table.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
(Required) Specifies the name of a table for which you are requesting metadata.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParentResourceArn <String>
The resource ARN of the view.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the CatalogId parameter. The -PassThru parameter is deprecated, use -Select '^CatalogId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Permission <String[]>
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPermissions
-QuerySessionContext_AdditionalContext <Hashtable>
An opaque string-string map passed by the query engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QuerySessionContext_ClusterId <String>
An identifier string for the consumer cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QuerySessionContext_QueryAuthorizationId <String>
A cryptographically generated query identifier generated by Glue or Lake Formation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QuerySessionContext_QueryId <String>
A unique identifier generated by the query engine for the query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QuerySessionContext_QueryStartTime <DateTime>
A timestamp provided by the query engine for when the query started.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceRegion <String>
Specified only if the base tables belong to a different Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RootResourceArn <String>
The resource ARN of the root view in a chain of nested views.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.GetUnfilteredTableMetadataResponse). Specifying the name of a property of type Amazon.Glue.Model.GetUnfilteredTableMetadataResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedDialect_Dialect <ViewDialect>
The dialect of the query engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedDialect_DialectVersion <String>
The version of the dialect of the query engine. For example, 3.0.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedPermissionType <String[]>
Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:
  • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
  • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
  • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
  • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupportedPermissionTypes

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

Amazon.Glue.Model.GetUnfilteredTableMetadataResponse
This cmdlet returns an Amazon.Glue.Model.GetUnfilteredTableMetadataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Resources
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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