AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lookoutvision ]

create-dataset

Description

Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training or a test dataset from a valid dataset source (DatasetSource ).

If you want a single dataset project, specify train for the value of DatasetType .

To have a project with separate training and test datasets, call CreateDataset twice. On the first call, specify train for the value of DatasetType . On the second call, specify test for the value of DatasetType .

This operation requires permissions to perform the lookoutvision:CreateDataset operation.

See also: AWS API Documentation

Synopsis

  create-dataset
--project-name <value>
--dataset-type <value>
[--dataset-source <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--project-name (string)

The name of the project in which you want to create a dataset.

--dataset-type (string)

The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

--dataset-source (structure)

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

If you don't specify DatasetSource , an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries .

If you specify a value for DataSource , the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset .

GroundTruthManifest -> (structure)

Location information for the manifest file.

S3Object -> (structure)

The S3 bucket location for the manifest file.

Bucket -> (string)

The Amazon S3 bucket that contains the manifest.

Key -> (string)

The name and location of the manifest file withiin the bucket.

VersionId -> (string)

The version ID of the bucket.

Shorthand Syntax:

GroundTruthManifest={S3Object={Bucket=string,Key=string,VersionId=string}}

JSON Syntax:

{
  "GroundTruthManifest": {
    "S3Object": {
      "Bucket": "string",
      "Key": "string",
      "VersionId": "string"
    }
  }
}

--client-token (string)

ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateDataset . In this case, safely retry your call to CreateDataset by using the same ClientToken parameter value.

If you don't supply a value for ClientToken , the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateDataset . An idempotency token is active for 8 hours.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

DatasetMetadata -> (structure)

Information about the dataset.

DatasetType -> (string)

The type of the dataset.

CreationTimestamp -> (timestamp)

The Unix timestamp for the date and time that the dataset was created.

Status -> (string)

The status for the dataset.

StatusMessage -> (string)

The status message for the dataset.