Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lakeformation ]

get-data-lake-settings

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-data-lake-settings
[--catalog-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DataLakeSettings -> (structure)

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

DataLakeAdmins -> (list)

A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

(structure)

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

DataLakePrincipalIdentifier -> (string)

An identifier for the AWS Lake Formation principal.

CreateDatabaseDefaultPermissions -> (list)

A structure representing a list of up to three principal permissions entries for default create database permissions.

(structure)

Permissions granted to a principal.

Principal -> (structure)

The principal who is granted permissions.

DataLakePrincipalIdentifier -> (string)

An identifier for the AWS Lake Formation principal.

Permissions -> (list)

The permissions that are granted to the principal.

(string)

CreateTableDefaultPermissions -> (list)

A structure representing a list of up to three principal permissions entries for default create table permissions.

(structure)

Permissions granted to a principal.

Principal -> (structure)

The principal who is granted permissions.

DataLakePrincipalIdentifier -> (string)

An identifier for the AWS Lake Formation principal.

Permissions -> (list)

The permissions that are granted to the principal.

(string)

TrustedResourceOwners -> (list)

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.

You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

(string)