Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

atlas privateEndpoints aws list

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Return all AWS private endpoints for your project.

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas privateEndpoints aws list [options]
Name
Type
Required
Description
-h, --help
false
help for list
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the 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.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
# Return a JSON-formatted list of all AWS private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas privateEndpoints aws list --projectId 5e2211c17a3e5a48f5497de3 --output json
← atlas privateEndpoints aws interfaces describe