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

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::DescribeDatasetResponse

Includes:

Structure

Defined in:

lib/aws-sdk-forecastservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the dataset was created.

• #data_frequency ⇒ String

  The frequency of data collection.

• #dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset.

• #dataset_name ⇒ String

  The name of the dataset.

• #dataset_type ⇒ String

  The dataset type.

• #domain ⇒ String

  The domain associated with the dataset.

• #encryption_config ⇒ Types::EncryptionConfig

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

• #last_modification_time ⇒ Time

  When you create a dataset, ‘LastModificationTime` is the same as `CreationTime`.

• #schema ⇒ Types::Schema

  An array of ‘SchemaAttribute` objects that specify the dataset fields.

• #status ⇒ String

  The status of the dataset.

Instance Attribute Details

#creation_time ⇒ Time

When the dataset was created.

Returns:

• (Time)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#data_frequency ⇒ String

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)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#dataset_name ⇒ String

The name of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#dataset_type ⇒ String

The dataset type.

Returns:

• (String)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#domain ⇒ String

The domain associated with the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#encryption_config ⇒ Types::EncryptionConfig

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

Returns:

• (Types::EncryptionConfig)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#last_modification_time ⇒ Time

When you create a dataset, ‘LastModificationTime` is the same as `CreationTime`. While data is being imported to the dataset, `LastModificationTime` is the current time of the `DescribeDataset` call. After a [CreateDatasetImportJob] operation has finished, `LastModificationTime` is when the import job completed or failed.

[1]: docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html

Returns:

• (Time)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#schema ⇒ Types::Schema

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

Returns:

• (Types::Schema)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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

#status ⇒ String

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 and reflect 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`.

<note markdown=“1”> The ‘Status` of the dataset must be `ACTIVE` before you can import training data.

</note>

[1]: docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html

Returns:

• (String)

# File 'lib/aws-sdk-forecastservice/types.rb', line 2723

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