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 Lake Formation ListLakeFormationOptIns API operation.

Syntax

Get-LKFLakeFormationOptInList
-Resource_Catalog <CatalogResource>
-Database_CatalogId <String>
-DataLocation_CatalogId <String>
-LFTag_CatalogId <String>
-LFTagExpression_CatalogId <String>
-LFTagPolicy_CatalogId <String>
-Table_CatalogId <String>
-TableWithColumns_CatalogId <String>
-TableWithColumns_ColumnName <String[]>
-DataCellsFilter_DatabaseName <String>
-Table_DatabaseName <String>
-TableWithColumns_DatabaseName <String>
-Principal_DataLakePrincipalIdentifier <String>
-ColumnWildcard_ExcludedColumnName <String[]>
-LFTagPolicy_Expression <LFTag[]>
-LFTagPolicy_ExpressionName <String>
-Database_Name <String>
-DataCellsFilter_Name <String>
-LFTagExpression_Name <String>
-Table_Name <String>
-TableWithColumns_Name <String>
-DataLocation_ResourceArn <String>
-LFTagPolicy_ResourceType <ResourceType>
-DataCellsFilter_TableCatalogId <String>
-DataCellsFilter_TableName <String>
-Table_TableWildcard <TableWildcard>
-LFTag_TagKey <String>
-LFTag_TagValue <String[]>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonLakeFormationConfig>

Description

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-ClientConfig <AmazonLakeFormationConfig>
Amazon.PowerShell.Cmdlets.LKF.AmazonLakeFormationClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ColumnWildcard_ExcludedColumnName <String[]>
Excludes column names. Any column with this name will be excluded.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_TableWithColumns_ColumnWildcard_ExcludedColumnNames
-Database_CatalogId <String>
The identifier for the Data Catalog. By default, it is the account ID of the caller.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Database_CatalogId
-Database_Name <String>
The name of the database resource. Unique to the Data Catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Database_Name
-DataCellsFilter_DatabaseName <String>
A database in the Glue Data Catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataCellsFilter_DatabaseName
-DataCellsFilter_Name <String>
The name of the data cells filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataCellsFilter_Name
-DataCellsFilter_TableCatalogId <String>
The ID of the catalog to which the table belongs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataCellsFilter_TableCatalogId
-DataCellsFilter_TableName <String>
The name of the table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataCellsFilter_TableName
-DataLocation_CatalogId <String>
The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataLocation_CatalogId
-DataLocation_ResourceArn <String>
The Amazon Resource Name (ARN) that uniquely identifies the data location resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_DataLocation_ResourceArn
-LFTag_CatalogId <String>
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTag_CatalogId
-LFTag_TagKey <String>
The key-name for the LF-tag.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTag_TagKey
-LFTag_TagValue <String[]>
A list of possible values an attribute can take.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTag_TagValues
-LFTagExpression_CatalogId <String>
The identifier for the Data Catalog. By default, the account ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagExpression_CatalogId
-LFTagExpression_Name <String>
The name of the LF-Tag expression to grant permissions on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagExpression_Name
-LFTagPolicy_CatalogId <String>
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagPolicy_CatalogId
-LFTagPolicy_Expression <LFTag[]>
A list of LF-tag conditions or a saved expression that apply to the resource's LF-tag policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagPolicy_Expression
-LFTagPolicy_ExpressionName <String>
If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagPolicy_ExpressionName
-LFTagPolicy_ResourceType <ResourceType>
The resource type for which the LF-tag policy applies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_LFTagPolicy_ResourceType
-MaxResult <Int32>
The maximum number of results to return.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-NextToken <String>
A continuation token, if this is not the first call to retrieve this list.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Principal_DataLakePrincipalIdentifier <String>
An identifier for the Lake Formation principal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Resource_Catalog <CatalogResource>
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'LakeFormationOptInsInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListLakeFormationOptInsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListLakeFormationOptInsResponse 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)
-Table_CatalogId <String>
The identifier for the Data Catalog. By default, it is the account ID of the caller.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Table_CatalogId
-Table_DatabaseName <String>
The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Table_DatabaseName
-Table_Name <String>
The name of the table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Table_Name
-Table_TableWildcard <TableWildcard>
A wildcard object representing every table under a database.At least one of TableResource$Name or TableResource$TableWildcard is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_Table_TableWildcard
-TableWithColumns_CatalogId <String>
The identifier for the Data Catalog. By default, it is the account ID of the caller.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_TableWithColumns_CatalogId
-TableWithColumns_ColumnName <String[]>
The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_TableWithColumns_ColumnNames
-TableWithColumns_DatabaseName <String>
The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_TableWithColumns_DatabaseName
-TableWithColumns_Name <String>
The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResource_TableWithColumns_Name

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.LakeFormation.Model.LakeFormationOptInsInfo or Amazon.LakeFormation.Model.ListLakeFormationOptInsResponse
This cmdlet returns a collection of Amazon.LakeFormation.Model.LakeFormationOptInsInfo objects. The service call response (type Amazon.LakeFormation.Model.ListLakeFormationOptInsResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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