DOCSP-11135: [mongocli] describe one Data Lake

Author: steveren

source/includes/atlas-datalake-output-fields.rst

@@ -37,21 +37,21 @@
          <https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html>`_.
 
      * - ``dataProcessRegion``
-       - Object
+       - object
        - Cloud provider region to which {+data-lake+} routes
          client connections for data processing.
 
          If ``null``, {+data-lake+} routes client connections to the
          region nearest to the client based on DNS resolution.
 
      * - ``dataProcessRegion.cloudProvider``
-       - String
+       - string
        - Name of the cloud service provider. 
 
          {+data-lake+} only supports ``AWS``.
 
      * - ``dataProcessRegion.region``
-       - String
+       - string
        - Name of the region to which {+data-lake+} routes client 
          connections for data processing.
 

source/reference/atlas/datalake-commands.txt

@@ -10,3 +10,4 @@ Atlas ``datalake`` Commands
    :titlesonly:
 
    List Data Lakes </reference/atlas/datalake-list>
+   Describe a Data Lake </reference/atlas/datalake-describe>

source/reference/atlas/datalake-describe.txt

@@ -0,0 +1,159 @@
+.. _mcli-atlas-datalake-describe-command:
+
+================================
+mongocli atlas datalake describe
+================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``datalake describe`` command retrieves the configuration for a 
+specified `Data Lake <https://docs.mongodb.com/datalake/>`__. You can also
+retrieve a {+data-lake-short+} configuration through the `Data Lake API
+<https://docs.mongodb.com/datalake/reference/api/dataLakes-get-one-tenant>`__
+or with the |service| UI by selecting :guilabel:`Data Lake` from the left-side
+navigation.
+
+.. _datalake-describe-syntax:
+
+Syntax 
+------
+
+.. code-block:: text
+   :copyable: false
+
+   mongocli atlas datalake describe
+        [ <data-lake-name> ]
+        [ --profile|-P <profile-name> ]
+        [ --projectId <id-of-project> ]
+
+.. include:: /includes/fact-command-line-help.rst
+
+.. _datalake-describe-options:
+
+Options 
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option
+     - Type
+     - Description
+     - Required?
+
+   * - ``<data-lake-name>``
+     - string
+     - Name of the {+data-lake+} for which to retrieve a configuration.
+     - yes
+
+   * - ``--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 :ref:`mcli-configure`.
+     - no
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project that contains the 
+       cluster to update. If omitted, uses the project ID in 
+       the profile or :ref:`environment variable <mcli-env-var>`.
+     - no
+
+.. _datalake-describe-output:
+
+Output 
+------
+
+The command prints the following fields in |json| format to the 
+terminal if the command succeeds. If the command returns 
+errors, see :ref:`Troubleshooting <mcli-troubleshooting>` for 
+recommended solutions.
+
+The response |json| document contains a single object describing one
+{+data-lake-short+} associated with the project:
+
+.. include:: /includes/atlas-datalake-output-fields.rst
+
+.. _datalake-describe-examples:
+
+Example
+-------
+
+The following example uses the ``mongocli atlas datalake describe`` command 
+to retrieve the configuration for a {+data-lake+} named ``myDataLake``. It 
+uses the {+default-profile+} to access the project.
+
+.. code-block:: text
+   :copyable: false
+
+   mongocli atlas datalake describe myDataLake --projectId 5e2211c17a3e5a48f5497de3
+
+The previous command prints the following fields in |json| format to 
+the terminal. To learn more about these fields, see 
+:ref:`cluster-list-output`.
+
+.. code-block:: json
+   :copyable: false
+
+     {
+       "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
+            }
+          ]
+        }
+      }
+    
+