Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . forecast ]

create-dataset-import-job

Description

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles .

Two properties of the training data are optionally specified:

  • The delimiter that separates the data fields. The default delimiter is a comma (,), which is the only supported delimiter in this release.
  • The format of timestamps. If the format is not specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

When Amazon Forecast uploads your training data, it verifies that the data was collected at the DataFrequency specified when the target dataset was created. For more information, see CreateDataset and howitworks-datasets-groups . Amazon Forecast also verifies the delimiter and timestamp format.

You can use the ListDatasetImportJobs operation to get a list of all your dataset import jobs, filtered by specified criteria.

To get a list of all your dataset import jobs, filtered by the specified criteria, use the ListDatasetGroups operation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-dataset-import-job
--dataset-import-job-name <value>
--dataset-arn <value>
--data-source <value>
[--timestamp-format <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--dataset-import-job-name (string)

The name for the dataset import job. It is recommended to include the current timestamp in the name to guard against getting a ResourceAlreadyExistsException exception, for example, 20190721DatasetImport .

--dataset-arn (string)

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

--data-source (structure)

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

Shorthand Syntax:

S3Config={Path=string,RoleArn=string,KMSKeyArn=string}

JSON Syntax:

{
  "S3Config": {
    "Path": "string",
    "RoleArn": "string",
    "KMSKeyArn": "string"
  }
}

--timestamp-format (string)

The format of timestamps in the dataset. Two formats are supported, dependent on the DataFrequency specified when the dataset was created.

  • "yyyy-MM-dd" For data frequencies: Y, M, W, and D
  • "yyyy-MM-dd HH:mm:ss" For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

--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.

See 'aws help' for descriptions of global parameters.

Output

DatasetImportJobArn -> (string)

The Amazon Resource Name (ARN) of the dataset import job.