GetDataLakeSettings - Lake Formation

GetDataLakeSettings

Retrieves the list of the data lake administrators of a AWS Lake Formation-managed data lake.

Request Syntax

{ "CatalogId": "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.

CatalogId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Response Syntax

{ "DataLakeSettings": { "AllowExternalDataFiltering": boolean, "AllowFullTableExternalDataAccess": boolean, "AuthorizedSessionTagValueList": [ "string" ], "CreateDatabaseDefaultPermissions": [ { "Permissions": [ "string" ], "Principal": { "DataLakePrincipalIdentifier": "string" } } ], "CreateTableDefaultPermissions": [ { "Permissions": [ "string" ], "Principal": { "DataLakePrincipalIdentifier": "string" } } ], "DataLakeAdmins": [ { "DataLakePrincipalIdentifier": "string" } ], "ExternalDataFilteringAllowList": [ { "DataLakePrincipalIdentifier": "string" } ], "Parameters": { "string" : "string" }, "ReadOnlyAdmins": [ { "DataLakePrincipalIdentifier": "string" } ], "TrustedResourceOwners": [ "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.

DataLakeSettings

A structure representing a list of Lake Formation principals designated as data lake administrators.

Type: DataLakeSettings object

Errors

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

EntityNotFoundException

A specified entity does not exist.

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

See Also

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