Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas clusters sampleData describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

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.

Command Syntax
atlas clusters sampleData describe <id> [options]
Name
Type
Required
Description

id

string

true

Unique identifier of the sample data job.

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.

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.

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>
# Return the JSON-formatted details for the sample data load job:
atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json

Back

sampleData