AWS.Tools.LakeFormation.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LakeFormation</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet"> <summary> Attaches one or more LF-tags to an existing resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTag"> <summary> <para> <para>The LF-tags to attach to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Failures'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.AddLFTagsToResourceResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.AddLFTagsToResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.AddLKFLFTagsToResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet"> <summary> Lists all the data cell filters on a table.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.MaxResult"> <summary> <para> <para>The maximum size of the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is a continuation call.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataCellsFilters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListDataCellsFilterResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListDataCellsFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataCellsFilterListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataLakeSettingCmdlet"> <summary> Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataLakeSettingCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataLakeSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataLakeSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.GetDataLakeSettingsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetDataLakeSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFDataLakeSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet"> <summary> Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. <code>GetEffectivePermissionsForPath</code> will not return databases and tables if the catalog is encrypted.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to get permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve this list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Permissions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.GetEffectivePermissionsForPathResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetEffectivePermissionsForPathResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFEffectivePermissionsForPathCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagCmdlet"> <summary> Returns an LF-tag definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagCmdlet.TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagCmdlet.Select"> <summary> 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.LakeFormation.Model.GetLFTagResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetLFTagResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet"> <summary> Lists LF-tags that the requester has permission to view.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.ResourceShareType"> <summary> <para> <para>If resource share type is <code>ALL</code>, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is <code>FOREIGN</code>, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve this list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LFTags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListLFTagsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListLFTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFLFTagListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet"> <summary> Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER. <para> This operation returns only those permissions that have been explicitly granted. </para><para> For information about permissions, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>. </para><br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Principal_DataLakePrincipalIdentifier"> <summary> <para> <para>An identifier for the Lake Formation principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.IncludeRelated"> <summary> <para> <para>Indicates that related permissions should be included in the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.ResourceType"> <summary> <para> <para>Specifies a resource type to filter the permissions returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve this list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PrincipalResourcePermissions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListPermissionsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFPermissionListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStateCmdlet"> <summary> Returns the state of a query previously submitted. Clients are expected to poll <code>GetQueryState</code> to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to <code>StartQueryPlanning</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStateCmdlet.QueryId"> <summary> <para> <para>The ID of the plan query operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStateCmdlet.Select"> <summary> 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.LakeFormation.Model.GetQueryStateResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetQueryStateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStatisticCmdlet"> <summary> Retrieves statistics on the planning and execution of a query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStatisticCmdlet.QueryId"> <summary> <para> <para>The ID of the plan query operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStatisticCmdlet.Select"> <summary> 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.LakeFormation.Model.GetQueryStatisticsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetQueryStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFQueryStatisticCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceCmdlet"> <summary> Retrieves the current data access role for the given resource registered in Lake Formation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.DescribeResourceResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.DescribeResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet"> <summary> Returns the LF-tags applied to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.ShowAssignedLFTag"> <summary> <para> <para>Indicates whether to show the assigned LF-tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceLFTagCmdlet.Select"> <summary> 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.LakeFormation.Model.GetResourceLFTagsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetResourceLFTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet"> <summary> Lists the resources registered to be managed by the Data Catalog.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet.FilterConditionList"> <summary> <para> <para>Any applicable row-level and/or column-level filtering conditions for the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve these resources.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListResourcesResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFResourceListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet"> <summary> Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.CatalogId"> <summary> <para> <para>The catalog containing the governed table. Defaults to the caller’s account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.DatabaseName"> <summary> <para> <para>The database containing the governed table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.PartitionPredicate"> <summary> <para> <para>A predicate to filter the objects returned based on the partition keys defined in the governed table.</para><ul><li><para>The comparison operators supported are: =, >, <, >=, <=</para></li><li><para>The logical operators supported are: AND</para></li><li><para>The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.QueryAsOfTime"> <summary> <para> <para>The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with <code>TransactionId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.TableName"> <summary> <para> <para>The governed table for which to retrieve objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.TransactionId"> <summary> <para> <para>The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.MaxResult"> <summary> <para> <para>Specifies how many values to return in a page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.NextToken"> <summary> <para> <para>A continuation token if this is not the first call to retrieve these objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Objects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.GetTableObjectsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetTableObjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TableName parameter. The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableObjectCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet"> <summary> Returns the configuration of all storage optimizers associated with a specified table.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.CatalogId"> <summary> <para> <para>The Catalog ID of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.DatabaseName"> <summary> <para> <para>Name of the database where the table is present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.StorageOptimizerType"> <summary> <para> <para>The specific type of storage optimizers to list. The supported value is <code>compaction</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.TableName"> <summary> <para> <para>Name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.MaxResult"> <summary> <para> <para>The number of storage optimizers to return on each call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is a continuation call.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageOptimizerList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListTableStorageOptimizersResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListTableStorageOptimizersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TableName parameter. The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTableStorageOptimizerListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet"> <summary> This API is identical to <code>GetTemporaryTableCredentials</code> except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.AuditContext_AdditionalAuditContext"> <summary> <para> <para>The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.DurationSecond"> <summary> <para> <para>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.Permission"> <summary> <para> <para>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.SupportedPermissionType"> <summary> <para> <para>A list of supported permission types for the partition. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.TableArn"> <summary> <para> <para>The ARN of the partitions' table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.Partition_Value"> <summary> <para> <para>The list of partition values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.Select"> <summary> 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.LakeFormation.Model.GetTemporaryGluePartitionCredentialsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetTemporaryGluePartitionCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGluePartitionCredentialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TableArn parameter. The -PassThru parameter is deprecated, use -Select '^TableArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet"> <summary> Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.AuditContext_AdditionalAuditContext"> <summary> <para> <para>The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.DurationSecond"> <summary> <para> <para>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.Permission"> <summary> <para> <para>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.SupportedPermissionType"> <summary> <para> <para>A list of supported permission types for the table. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.TableArn"> <summary> <para> <para>The ARN identifying a table in the Data Catalog for the temporary credentials request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.Select"> <summary> 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.LakeFormation.Model.GetTemporaryGlueTableCredentialsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetTemporaryGlueTableCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTemporaryGlueTableCredentialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TableArn parameter. The -PassThru parameter is deprecated, use -Select '^TableArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionCmdlet"> <summary> Returns the details of a single transaction. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionCmdlet.TransactionId"> <summary> <para> <para>The transaction for which to return status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransactionDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.DescribeTransactionResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.DescribeTransactionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransactionId parameter. The -PassThru parameter is deprecated, use -Select '^TransactionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet"> <summary> Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned. <para> This operation can help you identify uncommitted transactions or to get information about transactions. </para><br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.CatalogId"> <summary> <para> <para>The catalog for which to list transactions. Defaults to the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.StatusFilter"> <summary> <para> <para> A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is <code>ALL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transactions to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.NextToken"> <summary> <para> <para>A continuation token if this is not the first call to retrieve transactions.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Transactions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.ListTransactionsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.ListTransactionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StatusFilter parameter. The -PassThru parameter is deprecated, use -Select '^StatusFilter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFTransactionListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet"> <summary> Retrieves the work units generated by the <code>StartQueryPlanning</code> operation.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.QueryId"> <summary> <para> <para>The ID of the plan query operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is a continuation call.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.PageSize"> <summary> <para> <para>The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.Select"> <summary> 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.LakeFormation.Model.GetWorkUnitsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetWorkUnitsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet"> <summary> Returns the work units resulting from the query. Work units can be executed in any order and in parallel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet.QueryId"> <summary> <para> <para>The ID of the plan query operation for which to get results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet.WorkUnitId"> <summary> <para> <para>The work unit ID for which to get results. Value generated by enumerating <code>WorkUnitIdMin</code> to <code>WorkUnitIdMax</code> (inclusive) from the <code>WorkUnitRange</code> in the output of <code>GetWorkUnits</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet.WorkUnitToken"> <summary> <para> <para>A work token used to query the execution service. Token output from <code>GetWorkUnits</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResultStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.GetWorkUnitResultsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.GetWorkUnitResultsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GetLKFWorkUnitResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet"> <summary> Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. <para> For information about permissions, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Principal_DataLakePrincipalIdentifier"> <summary> <para> <para>An identifier for the Lake Formation principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Permission"> <summary> <para> <para>The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.PermissionsWithGrantOption"> <summary> <para> <para>Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the <code>Privileges</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Select"> <summary> 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.LakeFormation.Model.GrantPermissionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Permission parameter. The -PassThru parameter is deprecated, use -Select '^Permission' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet"> <summary> Batch operation to grant permissions to the principal. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet.Entry"> <summary> <para> <para>A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Failures'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.BatchGrantPermissionsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.BatchGrantPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Entry parameter. The -PassThru parameter is deprecated, use -Select '^Entry' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.GrantLKFPermissionBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.InvokeLKFTransactionCmdlet"> <summary> Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted. <para> Write transactions that remain idle for a long period are automatically aborted unless explicitly extended. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.InvokeLKFTransactionCmdlet.TransactionId"> <summary> <para> <para>The transaction to extend.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.InvokeLKFTransactionCmdlet.Select"> <summary> 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.LakeFormation.Model.ExtendTransactionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.InvokeLKFTransactionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransactionId parameter. The -PassThru parameter is deprecated, use -Select '^TransactionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.InvokeLKFTransactionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet"> <summary> Creates a data cell filter to allow one to grant access to certain columns on certain rows. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.RowFilter_AllRowsWildcard"> <summary> <para> <para>A wildcard for all rows.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.TableData_ColumnName"> <summary> <para> <para>A list of column names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.TableData_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.RowFilter_FilterExpression"> <summary> <para> <para>A filter expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.TableData_Name"> <summary> <para> <para>The name given by the user to the data filter cell.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.TableData_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.TableData_TableName"> <summary> <para> <para>A table in the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.Select"> <summary> 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.LakeFormation.Model.CreateDataCellsFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFDataCellsFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet"> <summary> Creates an LF-tag with the specified name and values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.Select"> <summary> 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.LakeFormation.Model.CreateLFTagResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.NewLKFLFTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet"> <summary> Registers the resource as managed by the Data Catalog. <para> To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. </para><para> The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. </para><para><code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code></para><para> If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>: </para><para><code>arn:aws:iam::12345:role/my-data-access-role</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to register.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.RoleArn"> <summary> <para> <para>The identifier for the role that registers the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.UseServiceLinkedRole"> <summary> <para> <para>Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.</para><para>For more information, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.Select"> <summary> 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.LakeFormation.Model.RegisterResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RegisterLKFResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet"> <summary> Deletes a data cell filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.Name"> <summary> <para> <para>The name given by the user to the data filter cell.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.TableName"> <summary> <para> <para>A table in the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.Select"> <summary> 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.LakeFormation.Model.DeleteDataCellsFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFDataCellsFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet"> <summary> Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet.TagKey"> <summary> <para> <para>The key-name for the LF-tag to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet.Select"> <summary> 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.LakeFormation.Model.DeleteLFTagResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet"> <summary> Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in <code>tableWithColumns</code> to specify column input. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTag"> <summary> <para> <para>The LF-tags to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Failures'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.RemoveLFTagsFromResourceResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.RemoveLFTagsFromResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFLFTagsFromResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet"> <summary> For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels. <para> The Glue ETL library function <code>write_dynamic_frame.from_catalog()</code> includes an option to automatically call <code>DeleteObjectsOnCancel</code> before writes. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes">Rolling Back Amazon S3 Writes</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.CatalogId"> <summary> <para> <para>The Glue data catalog that contains the governed table. Defaults to the current account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.DatabaseName"> <summary> <para> <para>The database that contains the governed table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.Object"> <summary> <para> <para>A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.TableName"> <summary> <para> <para>The name of the governed table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.TransactionId"> <summary> <para> <para>ID of the transaction that the writes occur in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.Select"> <summary> 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.LakeFormation.Model.DeleteObjectsOnCancelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RemoveLKFObjectsOnCancelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet"> <summary> Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Resource_Catalog"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Database_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataLocation_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTag_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTagPolicy_CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Table_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.TableWithColumns_CatalogId"> <summary> <para> <para>The identifier for the Data Catalog. By default, it is the account ID of the caller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.TableWithColumns_ColumnName"> <summary> <para> <para>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataCellsFilter_DatabaseName"> <summary> <para> <para>A database in the Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Table_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.TableWithColumns_DatabaseName"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Principal_DataLakePrincipalIdentifier"> <summary> <para> <para>An identifier for the Lake Formation principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.ColumnWildcard_ExcludedColumnName"> <summary> <para> <para>Excludes column names. Any column with this name will be excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTagPolicy_Expression"> <summary> <para> <para>A list of LF-tag conditions that apply to the resource's LF-tag policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Database_Name"> <summary> <para> <para>The name of the database resource. Unique to the Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataCellsFilter_Name"> <summary> <para> <para>The name of the data cells filter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Table_Name"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.TableWithColumns_Name"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Permission"> <summary> <para> <para>The permissions revoked to the principal on the resource. For information about permissions, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.PermissionsWithGrantOption"> <summary> <para> <para>Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataLocation_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTagPolicy_ResourceType"> <summary> <para> <para>The resource type for which the LF-tag policy applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataCellsFilter_TableCatalogId"> <summary> <para> <para>The ID of the catalog to which the table belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.DataCellsFilter_TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Table_TableWildcard"> <summary> <para> <para>A wildcard object representing every table under a database.</para><para>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTag_TagKey"> <summary> <para> <para>The key-name for the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.LFTag_TagValue"> <summary> <para> <para>A list of possible values an attribute can take.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Select"> <summary> 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.LakeFormation.Model.RevokePermissionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Permission parameter. The -PassThru parameter is deprecated, use -Select '^Permission' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet"> <summary> Batch operation to revoke permissions from the principal. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet.Entry"> <summary> <para> <para>A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Failures'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.BatchRevokePermissionsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.BatchRevokePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Entry parameter. The -PassThru parameter is deprecated, use -Select '^Entry' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.RevokeLKFPermissionBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet"> <summary> This operation allows a search on <code>DATABASE</code> resources by <code>TagCondition</code>. This operation is used by admins who want to grant user permissions on certain <code>TagConditions</code>. Before making a grant, the admin can use <code>SearchDatabasesByTags</code> to find all resources where the given <code>TagConditions</code> are valid to verify whether the returned resources can be shared.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.Expression"> <summary> <para> <para>A list of conditions (<code>LFTag</code> structures) to search for in database resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve this list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatabaseList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.SearchDatabasesByLFTagsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.SearchDatabasesByLFTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFDatabasesByLFTagCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet"> <summary> This operation allows a search on <code>TABLE</code> resources by <code>LFTag</code>s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use <code>SearchTablesByLFTags</code> to find all resources where the given <code>LFTag</code>s are valid to verify whether the returned resources can be shared.<br/><br/>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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.Expression"> <summary> <para> <para>A list of conditions (<code>LFTag</code> structures) to search for in table resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.NextToken"> <summary> <para> <para>A continuation token, if this is not the first call to retrieve this list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TableList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.SearchTablesByLFTagsResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.SearchTablesByLFTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.SearchLKFTablesByLFTagCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet"> <summary> Submits a request to process a query statement. <para> This operation generates work units that can be retrieved with the <code>GetWorkUnits</code> operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryPlanningContext_CatalogId"> <summary> <para> <para>The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryPlanningContext_DatabaseName"> <summary> <para> <para>The database containing the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryPlanningContext_QueryAsOfTime"> <summary> <para> <para>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 <code>TransactionId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryPlanningContext_QueryParameter"> <summary> <para> <para>A map consisting of key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryString"> <summary> <para> <para>A PartiQL query statement used as an input to the planner service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.QueryPlanningContext_TransactionId"> <summary> <para> <para>The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.StartQueryPlanningResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.StartQueryPlanningResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryString parameter. The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFQueryPlanningCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.StartLKFTransactionCmdlet"> <summary> Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFTransactionCmdlet.TransactionType"> <summary> <para> <para>Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFTransactionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransactionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.StartTransactionResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.StartTransactionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFTransactionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransactionType parameter. The -PassThru parameter is deprecated, use -Select '^TransactionType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StartLKFTransactionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.StopLKFTransactionCmdlet"> <summary> Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StopLKFTransactionCmdlet.TransactionId"> <summary> <para> <para>The transaction to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StopLKFTransactionCmdlet.Select"> <summary> 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.LakeFormation.Model.CancelTransactionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StopLKFTransactionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransactionId parameter. The -PassThru parameter is deprecated, use -Select '^TransactionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.StopLKFTransactionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.UnregisterLKFResourceCmdlet"> <summary> Deregisters the resource as managed by the Data Catalog. <para> When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UnregisterLKFResourceCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to deregister.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UnregisterLKFResourceCmdlet.Select"> <summary> 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.LakeFormation.Model.DeregisterResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UnregisterLKFResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UnregisterLKFResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet"> <summary> Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.TagKey"> <summary> <para> <para>The key-name for the LF-tag for which to add or delete values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.TagValuesToAdd"> <summary> <para> <para>A list of LF-tag values to add from the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.TagValuesToDelete"> <summary> <para> <para>A list of LF-tag values to delete from the LF-tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.Select"> <summary> 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.LakeFormation.Model.UpdateLFTagResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFLFTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet"> <summary> Updates the data access role used for vending access to the given (registered) resource in Lake Formation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet.RoleArn"> <summary> <para> <para>The new role to use for the given resource registered in Lake Formation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet.Select"> <summary> 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.LakeFormation.Model.UpdateResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet"> <summary> Updates the manifest of Amazon S3 objects that make up the specified governed table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.CatalogId"> <summary> <para> <para>The catalog containing the governed table to update. Defaults to the caller’s account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.DatabaseName"> <summary> <para> <para>The database containing the governed table to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.TableName"> <summary> <para> <para>The governed table to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.TransactionId"> <summary> <para> <para>The transaction at which to do the write.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.WriteOperation"> <summary> <para> <para>A list of <code>WriteOperation</code> objects that define an object to add to or delete from the manifest for a governed table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.Select"> <summary> 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.LakeFormation.Model.UpdateTableObjectsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet"> <summary> Updates the configuration of the storage optimizers for a table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.CatalogId"> <summary> <para> <para>The Catalog ID of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.DatabaseName"> <summary> <para> <para>Name of the database where the table is present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.StorageOptimizerConfig"> <summary> <para> <para>Name of the table for which to enable the storage optimizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.TableName"> <summary> <para> <para>Name of the table for which to enable the storage optimizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Result'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.UpdateTableStorageOptimizerResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.UpdateTableStorageOptimizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.UpdateLKFTableStorageOptimizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet"> <summary> Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html">Granting Lake Formation Permissions</a>. <para> This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_AllowExternalDataFiltering"> <summary> <para> <para>Whether to allow Amazon EMR clusters to access data managed by Lake Formation. </para><para>If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.</para><para>If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.</para><para>For more information, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#emr-switch">(Optional) Allow Data Filtering on Amazon EMR</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_AuthorizedSessionTagValueList"> <summary> <para> <para>Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.CatalogId"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_CreateDatabaseDefaultPermission"> <summary> <para> <para>Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. You can override this default setting when you create a database.</para><para>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</para><para>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</para><para>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html">Changing the Default Security Settings for Your Data Lake</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_CreateTableDefaultPermission"> <summary> <para> <para>Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.</para><para>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</para><para>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</para><para>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html">Changing the Default Security Settings for Your Data Lake</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_DataLakeAdmin"> <summary> <para> <para>A list of Lake Formation principals. Supported principals are IAM users or IAM roles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_ExternalDataFilteringAllowList"> <summary> <para> <para>A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_TrustedResourceOwner"> <summary> <para> <para>A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log.</para><para>You may want to specify this property when you are in a high-trust boundary, such as the same team or company. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.Select"> <summary> 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.LakeFormation.Model.PutDataLakeSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LKF.WriteLKFTransactionCmdlet"> <summary> Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFTransactionCmdlet.TransactionId"> <summary> <para> <para>The transaction to commit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFTransactionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransactionStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.CommitTransactionResponse). Specifying the name of a property of type Amazon.LakeFormation.Model.CommitTransactionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFTransactionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransactionId parameter. The -PassThru parameter is deprecated, use -Select '^TransactionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFTransactionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |