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

Class: Aws::ForecastService::Types::DescribeDatasetResponse

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

When the dataset was created.

Returns:

  • (Time)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#data_frequencyString

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#dataset_arnString

The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#dataset_nameString

The name of the dataset.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#dataset_typeString

The dataset type.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#domainString

The dataset domain.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#encryption_configTypes::EncryptionConfig

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#last_modification_timeTime

When the dataset is created, LastModificationTime is the same as CreationTime. After a CreateDatasetImportJob operation is called, LastModificationTime is when the import job finished or failed. While data is being imported to the dataset, LastModificationTime is the current query time.

Returns:

  • (Time)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#schemaTypes::Schema

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

Returns:



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#statusString

The status of the dataset. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation. During this time, the status reflects the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

The Status of the dataset must be ACTIVE before you can import training data.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1187

class DescribeDatasetResponse < Struct.new(
  :dataset_arn,
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config,
  :status,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end