Skip to content

/AWS1/CL_FCSDESCRDATASETRSP

DescribeDatasetResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_datasetarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the dataset.

iv_datasetname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the dataset.

iv_domain TYPE /AWS1/FCSDOMAIN /AWS1/FCSDOMAIN

The domain associated with the dataset.

iv_datasettype TYPE /AWS1/FCSDATASETTYPE /AWS1/FCSDATASETTYPE

The dataset type.

iv_datafrequency TYPE /AWS1/FCSFREQUENCY /AWS1/FCSFREQUENCY

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.

io_schema TYPE REF TO /AWS1/CL_FCSSCHEMA /AWS1/CL_FCSSCHEMA

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

io_encryptionconfig TYPE REF TO /AWS1/CL_FCSENCRYPTIONCONFIG /AWS1/CL_FCSENCRYPTIONCONFIG

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

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

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.

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the dataset was created.

iv_lastmodificationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

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.

Queryable Attributes

DatasetArn

The Amazon Resource Name (ARN) of the dataset.

Accessible with the following methods

Method Description
GET_DATASETARN() Getter for DATASETARN, with configurable default
ASK_DATASETARN() Getter for DATASETARN w/ exceptions if field has no value
HAS_DATASETARN() Determine if DATASETARN has a value

DatasetName

The name of the dataset.

Accessible with the following methods

Method Description
GET_DATASETNAME() Getter for DATASETNAME, with configurable default
ASK_DATASETNAME() Getter for DATASETNAME w/ exceptions if field has no value
HAS_DATASETNAME() Determine if DATASETNAME has a value

Domain

The domain associated with the dataset.

Accessible with the following methods

Method Description
GET_DOMAIN() Getter for DOMAIN, with configurable default
ASK_DOMAIN() Getter for DOMAIN w/ exceptions if field has no value
HAS_DOMAIN() Determine if DOMAIN has a value

DatasetType

The dataset type.

Accessible with the following methods

Method Description
GET_DATASETTYPE() Getter for DATASETTYPE, with configurable default
ASK_DATASETTYPE() Getter for DATASETTYPE w/ exceptions if field has no value
HAS_DATASETTYPE() Determine if DATASETTYPE has a value

DataFrequency

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.

Accessible with the following methods

Method Description
GET_DATAFREQUENCY() Getter for DATAFREQUENCY, with configurable default
ASK_DATAFREQUENCY() Getter for DATAFREQUENCY w/ exceptions if field has no value
HAS_DATAFREQUENCY() Determine if DATAFREQUENCY has a value

Schema

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

Accessible with the following methods

Method Description
GET_SCHEMA() Getter for SCHEMA

EncryptionConfig

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

Accessible with the following methods

Method Description
GET_ENCRYPTIONCONFIG() Getter for ENCRYPTIONCONFIG

Status

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

CreationTime

When the dataset was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

LastModificationTime

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.

Accessible with the following methods

Method Description
GET_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME, with configurable default
ASK_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME w/ exceptions if field has n
HAS_LASTMODIFICATIONTIME() Determine if LASTMODIFICATIONTIME has a value