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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

When the dataset was created.

Returns:

  • (Time) —

    When the dataset was created.

#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) —

    The frequency of data collection.

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the dataset.

#dataset_name ⇒ String

The name of the dataset.

Returns:

  • (String) —

    The name of the dataset.

#dataset_type ⇒ String

The dataset type.

Possible values:

  • TARGET_TIME_SERIES
  • RELATED_TIME_SERIES
  • ITEM_METADATA

Returns:

  • (String) —

    The dataset type.

#domain ⇒ String

The domain associated with the dataset.

Possible values:

  • RETAIL
  • CUSTOM
  • INVENTORY_PLANNING
  • EC2_CAPACITY
  • WORK_FORCE
  • WEB_TRAFFIC
  • METRICS

Returns:

  • (String) —

    The domain associated with the dataset.

#encryption_config ⇒ Types::EncryptionConfig

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

Returns:

  • (Types::EncryptionConfig) —

    The AWS Key Management Service (KMS) key and the AWS 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. 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.

Returns:

  • (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. Each SchemaAttribute specifies the name and data type of a field.

Returns:

  • (Types::Schema) —

    An array of SchemaAttribute objects that specify the dataset fields.

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

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

Returns:

  • (String) —

    The status of the dataset.