ListLakeFormationOptIns - Lake Formation

ListLakeFormationOptIns

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

Request Syntax

{ "MaxResults": number, "NextToken": "string", "Principal": { "DataLakePrincipalIdentifier": "string" }, "Resource": { "Catalog": { }, "Database": { "CatalogId": "string", "Name": "string" }, "DataCellsFilter": { "DatabaseName": "string", "Name": "string", "TableCatalogId": "string", "TableName": "string" }, "DataLocation": { "CatalogId": "string", "ResourceArn": "string" }, "LFTag": { "CatalogId": "string", "TagKey": "string", "TagValues": [ "string" ] }, "LFTagPolicy": { "CatalogId": "string", "Expression": [ { "TagKey": "string", "TagValues": [ "string" ] } ], "ResourceType": "string" }, "Table": { "CatalogId": "string", "DatabaseName": "string", "Name": "string", "TableWildcard": { } }, "TableWithColumns": { "CatalogId": "string", "ColumnNames": [ "string" ], "ColumnWildcard": { "ExcludedColumnNames": [ "string" ] }, "DatabaseName": "string", "Name": "string" } } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A continuation token, if this is not the first call to retrieve this list.

Type: String

Required: No

Principal

The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.

Type: DataLakePrincipal object

Required: No

Resource

A structure for the resource.

Type: Resource object

Required: No

Response Syntax

{ "LakeFormationOptInsInfoList": [ { "LastModified": number, "LastUpdatedBy": "string", "Principal": { "DataLakePrincipalIdentifier": "string" }, "Resource": { "Catalog": { }, "Database": { "CatalogId": "string", "Name": "string" }, "DataCellsFilter": { "DatabaseName": "string", "Name": "string", "TableCatalogId": "string", "TableName": "string" }, "DataLocation": { "CatalogId": "string", "ResourceArn": "string" }, "LFTag": { "CatalogId": "string", "TagKey": "string", "TagValues": [ "string" ] }, "LFTagPolicy": { "CatalogId": "string", "Expression": [ { "TagKey": "string", "TagValues": [ "string" ] } ], "ResourceType": "string" }, "Table": { "CatalogId": "string", "DatabaseName": "string", "Name": "string", "TableWildcard": { } }, "TableWithColumns": { "CatalogId": "string", "ColumnNames": [ "string" ], "ColumnWildcard": { "ExcludedColumnNames": [ "string" ] }, "DatabaseName": "string", "Name": "string" } } } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LakeFormationOptInsInfoList

A list of principal-resource pairs that have Lake Formation permissins enforced.

Type: Array of LakeFormationOptInsInfo objects

NextToken

A continuation token, if this is not the first call to retrieve this list.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: