Navigation

mongocli atlas datalake list

On this page

The datalake list command retrieves all the Data Lakes associated with the specified Atlas project. You can also retrieve all the Atlas Data Lakes through the Data Lake API or with the Atlas UI by selecting Data Lake from the left-side navigation.

Syntax

mongocli atlas datalake list|ls
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <id-of-project> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option Type Description Required?
--output, -o string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

no
--profile, -P string Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI. no
--projectId string Unique identifier of the project that contains the cluster to update. If omitted, uses the project ID in the profile or environment variable. no

Output

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.

The response JSON document contains an array of objects. Each object in the array describes one Data Lake associated with the project:

Name Type Description
cloudProviderConfig object Configuration information related to the cloud service where Atlas Data Lake source data is stored.
cloudProviderConfig.<provider> object

Name of the provider of the cloud service where Data Lake can access the S3 Bucket data stores.

Data Lake only supports AWS.

cloudProviderConfig.aws. iamAssumedRoleARN string

Amazon Resource Name (ARN) of the IAM Role that Data Lake assumes when accessing S3 Bucket data stores.

The IAM Role must support the following actions against each S3 bucket:

  • s3:GetObject
  • s3:ListBucket
  • s3:GetObjectVersion

For more information on S3 actions, see Actions, Resources, and Condition Keys for Amazon S3.

dataProcessRegion object

Cloud provider region to which Atlas Data Lake routes client connections for data processing.

If null, Atlas Data Lake routes client connections to the region nearest to the client based on DNS resolution.

dataProcessRegion.cloudProvider string

Name of the cloud service provider.

Atlas Data Lake only supports AWS.

dataProcessRegion.region string

Name of the region to which Atlas Data Lake routes client connections for data processing.

Atlas Data Lake only supports the following regions:

  • SYDNEY_AUS (ap-southeast-2)
  • FRANKFURT_DEU (eu-central-1)
  • DUBLIN_IRL (eu-west-1)
  • LONDON_GBR (eu-west-2)
  • VIRGINIA_USA (us-east-1)
  • OREGON_USA (us-west-2)
groupId string Unique identifier of the project.
hostnames array List of hostnames assigned to the Atlas Data Lake. Each string in the array is a hostname assigned to the Atlas Data Lake.
name string Name of the Atlas Data Lake.
state string

Current state of the Atlas Data Lake:

  • ACTIVE - The Data Lake is active and verified. You can query the data stores associated with the Atlas Data Lake.

  • UNVERIFIED - The Atlas Data Lake has an incomplete configuration or the provided credentials do not grant access to the data stores.

    For AWS specifically, the provided cloudProviderConfig.aws.iamAssumedRoleARN must grant access to the AWS S3 buckets associated with any data stores.

storage object Configuration details for each data store and its mapping to MongoDB database(s) and collection(s).
storage.databases object

Configuration details for mapping each data store to queryable databases and collections.

An empty object indicates that the Data Lake has no mapping configuration for any data store.

storage.stores array

Each object in the array represents a data store. Data Lake uses the storage.databases configuration details to map data in each data store to queryable databases and collections.

An empty object indicates that the Data Lake has no configured data stores.

Examples

The following example uses the mongocli atlas datalake list command to retrieve the list of Atlas Data Lakes in the specified project. It uses the default profile to access the project.

mongocli atlas datalake list --output json --projectId 5e2211c17a3e5a48f5497de3

The previous command prints the following fields in the specified format to the terminal. To learn more about these fields, see Output.

[
  {
    "cloudProviderConfig": {
       "aws": {
             "iamAssumedRoleARN": "arn:aws:iam::772401394250:role/my-dl-role"
             }
       },
       "dataProcessRegion": {},
       "groupId": "5e2211c17a3e5a48f5497de3",
       "hostnames": [
             "my-data-lake-r4xmn.c.query.mongodb.net"
       ],
       "name": "MyDataLake",
       "state": "ACTIVE",
       "storage": {
             "databases": [
           {
             "name": "data-lake-test",
             "collections": [
               {
                 "name": "data",
                 "dataSources": [
                   {
                     "storeName": "data-lake-test",
                     "path": "data.json"
                   }
             ]
           },
           {
             "name": "*",
             "dataSources": [
               {
                 "storeName": "data-lake-test",
                 "path": "{collectionName()}"
               }
             ]
           }
         ]
       }
     ],
     "stores": [
         {
           "name": "data-lake-test",
           "provider": "s3",
           "region": "US_WEST_2",
           "bucket": "data-lake-test",
           "delimiter": "/",
           "includeTags": false
         }
       ]
     }
   }
 ]