Docs Home → MongoDB Command Line Interface
mongocli atlas privateEndpoints onlineArchive aws describe
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Return a specific Data Lake private endpoint for your project.
To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
Syntax
Command Syntax
mongocli atlas privateEndpoints onlineArchive aws describe <privateEndpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
privateEndpointId | string | true | Unique 22-character alphanumeric string that identifies the private endpoint. |
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 | Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID ENDPOINT PROVIDER TYPE COMMENT <EndpointId> <Provider> <Type> <Comment>
Examples
# This example uses the profile named "myprofile" for accessing Atlas. mongocli atlas privateEndpoint dataLake aws describe vpce-abcdefg0123456789 -P myprofile