Docs Home → Atlas Command Line Interface
atlas dataLakes describe
On this page
Return the details for the specified federated database instance.
To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
Syntax
atlas dataLakes describe <name> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
name | string | true | Name of the federated database instance to retrieve. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Return the details for the federated database instance named myFDI in the project with the ID 5e2211c17a3e5a48f5497de3: atlas dataLakes describe myFDI --projectId 5e2211c17a3e5a48f5497de3 --output json