- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Return one snapshot export bucket.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas backups exports buckets describe [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--bucketId | string | true | Unique identifier that Atlas assigns to the bucket. |
-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 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. |
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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID BUCKET NAME CLOUD PROVIDER IAM ROLE ID <Id> <BucketName> <CloudProvider> <IamRoleId>
Examples
# Return the details for the continuous backup export bucket with the ID dbdb00ca12345678f901a234: atlas backup exports buckets describe dbdb00ca12345678f901a234