Docs Home → Atlas Command Line Interface
atlas backups exports jobs watch
On this page
Watch for the specified export job to complete.
This command checks the export job's status periodically until it reaches a completed, cancelled or failed status. Once the export reaches the expected status, the command prints "Export completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. You can interrupt the command's polling at any time with CTRL-C. To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
Syntax
atlas backups exports jobs watch <bucketId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
bucketId | string | true | Unique string that identifies the AWS S3 bucket to which you export your snapshots. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. |
-h, --help | false | help for watch | |
-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 | Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: atlas backup restore watch 507f1f77bcf86cd799439011 --clusterName Cluster0