- 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 the details for the specified sample data load job.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas clusters sampleData describe <id> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | true | Unique identifier of the sample data job. |
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 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 CLUSTER NAME STATE <Id> <ClusterName> <State>
Examples
# Return the JSON-formatted details for the sample data load job: atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json