Docs Home → MongoDB Command Line Interface
mongocli atlas privateEndpoints aws interfaces 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 the details for the specified AWS private endpoint interface 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 aws interfaces describe <interfaceEndpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
interfaceEndpointId | string | true | Unique string that identifies the AWS private endpoint interface in AWS. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--endpointServiceId | string | true | Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. |
-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 STATUS ERROR <InterfaceEndpointID> <AWSConnectionStatus> <ErrorMessage>
Examples
# Return the JSON-formatted details of the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: mongocli atlas privateEndpoints aws interfaces describe vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2