You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ForecastService::Types::CreateDatasetImportJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass CreateDatasetImportJobRequest data as a hash:

{
  dataset_import_job_name: "Name", # required
  dataset_arn: "Arn", # required
  data_source: { # required
    s3_config: { # required
      path: "S3Path", # required
      role_arn: "Arn", # required
      kms_key_arn: "KMSKeyArn",
    },
  },
  timestamp_format: "TimestampFormat",
}

Instance Attribute Summary collapse

Instance Attribute Details

#data_sourceTypes::DataSource

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.

Returns:



209
210
211
212
213
214
215
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 209

class CreateDatasetImportJobRequest < Struct.new(
  :dataset_import_job_name,
  :dataset_arn,
  :data_source,
  :timestamp_format)
  include Aws::Structure
end

#dataset_arnString

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

Returns:

  • (String)


209
210
211
212
213
214
215
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 209

class CreateDatasetImportJobRequest < Struct.new(
  :dataset_import_job_name,
  :dataset_arn,
  :data_source,
  :timestamp_format)
  include Aws::Structure
end

#dataset_import_job_nameString

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.

Returns:

  • (String)


209
210
211
212
213
214
215
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 209

class CreateDatasetImportJobRequest < Struct.new(
  :dataset_import_job_name,
  :dataset_arn,
  :data_source,
  :timestamp_format)
  include Aws::Structure
end

#timestamp_formatString

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

Returns:

  • (String)


209
210
211
212
213
214
215
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 209

class CreateDatasetImportJobRequest < Struct.new(
  :dataset_import_job_name,
  :dataset_arn,
  :data_source,
  :timestamp_format)
  include Aws::Structure
end