AWS.Tools.LakeFormation.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LakeFormation</name> </assembly> <members> <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 AWS 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 AWS 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.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 AWS 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 AWS 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 AWS Lake Formation. By default, it is the account ID of the caller.</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.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 AWS 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.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.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.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.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.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.GetLKFResourceCmdlet"> <summary> Retrieves the current data access role for the given resource registered in AWS 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.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.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 AWS 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 AWS 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 AWS Lake Formation. By default, it is the account ID of the caller.</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.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 AWS 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.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.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. AWS 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. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS 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.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.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 AWS 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.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 AWS 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 AWS 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.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 AWS 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 AWS 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 AWS Lake Formation. By default, it is the account ID of the caller.</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.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 AWS 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.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.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.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.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 AWS 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.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.UpdateLKFResourceCmdlet"> <summary> Updates the data access role used for vending access to the given (registered) resource in AWS 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 AWS 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.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.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 AWS Lake Formation environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_CreateDatabaseDefaultPermission"> <summary> <para> <para>A structure representing a list of up to three principal permissions entries for default create database permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_CreateTableDefaultPermission"> <summary> <para> <para>A structure representing a list of up to three principal permissions entries for default create table permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LKF.WriteLKFDataLakeSettingCmdlet.DataLakeSettings_DataLakeAdmin"> <summary> <para> <para>A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.</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 AWS 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> </members> </doc> |