Request Syntax Request Parameters Response Elements Errors See Also

PutDataLakeSettings

Sets the list of data lake administrators who have admin privileges on all resources managed by AWS Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.

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.

Request Syntax


{
   "CatalogId": "string",
   "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" ]
   }
}

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

DataLakeSettings

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

Type: DataLakeSettings object

Required: Yes

Response Elements

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

Errors

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

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400