mongocli atlas privateEndpoints aws describe
mongocli atlas commands are now deprecated and will be removed in a future release. To enjoy the same capabilities and the latest features, use the new, dedicated CLI for Atlas users. To learn more, see Migrate to the Atlas CLI.Return the details for the specified AWS private endpoints 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 describe <privateEndpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
privateEndpointId | string | true | Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. |
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. To see full output, use the -o json option. |
--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 SERVICE STATUS ERROR <Id> <EndpointServiceName> <Status> <ErrorMessage>
Examples
# Return the JSON-formatted details for the AWS private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: mongocli atlas privateEndpoints aws describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json