Amazonka.Forecast.DescribeDataset

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

• CreationTime

• LastModificationTime

• Status

Creating a Request

data DescribeDataset

See: newDescribeDataset smart constructor.

Constructors

DescribeDataset'

Fields

• datasetArn :: Text

  The Amazon Resource Name (ARN) of the dataset.

Instances

ToJSON DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

toJSON :: DescribeDataset -> Value

toEncoding :: DescribeDataset -> Encoding

toJSONList :: [DescribeDataset] -> Value

toEncodingList :: [DescribeDataset] -> Encoding

ToHeaders DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

toHeaders :: DescribeDataset -> [Header]

ToPath DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

toPath :: DescribeDataset -> ByteString

ToQuery DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

toQuery :: DescribeDataset -> QueryString

AWSRequest DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type AWSResponse DescribeDataset

Methods

request :: (Service -> Service) -> DescribeDataset -> Request DescribeDataset

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataset)))

Generic DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type Rep DescribeDataset :: Type -> Type

Methods

from :: DescribeDataset -> Rep DescribeDataset x

to :: Rep DescribeDataset x -> DescribeDataset

Read DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

readsPrec :: Int -> ReadS DescribeDataset

readList :: ReadS [DescribeDataset]

readPrec :: ReadPrec DescribeDataset

readListPrec :: ReadPrec [DescribeDataset]

Show DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

showsPrec :: Int -> DescribeDataset -> ShowS

show :: DescribeDataset -> String

showList :: [DescribeDataset] -> ShowS

NFData DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

rnf :: DescribeDataset -> ()

Eq DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

(==) :: DescribeDataset -> DescribeDataset -> Bool

(/=) :: DescribeDataset -> DescribeDataset -> Bool

Hashable DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

Methods

hashWithSalt :: Int -> DescribeDataset -> Int

hash :: DescribeDataset -> Int

type AWSResponse DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

type AWSResponse DescribeDataset = DescribeDatasetResponse

type Rep DescribeDataset

Defined in Amazonka.Forecast.DescribeDataset

type Rep DescribeDataset = D1 ('MetaData "DescribeDataset" "Amazonka.Forecast.DescribeDataset" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDataset

Arguments

:: Text

DescribeDataset

-> DescribeDataset

Create a value of DescribeDataset with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDataset, describeDataset_datasetArn - The Amazon Resource Name (ARN) of the dataset.

Request Lenses

describeDataset_datasetArn :: Lens' DescribeDataset Text

The Amazon Resource Name (ARN) of the dataset.

Destructuring the Response

data DescribeDatasetResponse

See: newDescribeDatasetResponse smart constructor.

Constructors

DescribeDatasetResponse'

Fields

• creationTime :: Maybe POSIX

  When the dataset was created.

• dataFrequency :: Maybe Text

  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.

• datasetArn :: Maybe Text

  The Amazon Resource Name (ARN) of the dataset.

• datasetName :: Maybe Text

  The name of the dataset.

• datasetType :: Maybe DatasetType

  The dataset type.

• domain :: Maybe Domain

  The domain associated with the dataset.

• encryptionConfig :: Maybe 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.

• lastModificationTime :: Maybe POSIX

  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.

• schema :: Maybe Schema

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

• status :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type Rep DescribeDatasetResponse :: Type -> Type

Methods

from :: DescribeDatasetResponse -> Rep DescribeDatasetResponse x

to :: Rep DescribeDatasetResponse x -> DescribeDatasetResponse

Read DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

Methods

readsPrec :: Int -> ReadS DescribeDatasetResponse

readList :: ReadS [DescribeDatasetResponse]

readPrec :: ReadPrec DescribeDatasetResponse

readListPrec :: ReadPrec [DescribeDatasetResponse]

Show DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

Methods

showsPrec :: Int -> DescribeDatasetResponse -> ShowS

show :: DescribeDatasetResponse -> String

showList :: [DescribeDatasetResponse] -> ShowS

NFData DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

Methods

rnf :: DescribeDatasetResponse -> ()

Eq DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

Methods

(==) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool

(/=) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool

type Rep DescribeDatasetResponse

Defined in Amazonka.Forecast.DescribeDataset

type Rep DescribeDatasetResponse = D1 ('MetaData "DescribeDatasetResponse" "Amazonka.Forecast.DescribeDataset" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeDatasetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "dataFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetType))))) :*: ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :*: (S1 ('MetaSel ('Just "encryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfig)) :*: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schema)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeDatasetResponse

Arguments

:: Int

$sel:httpStatus:DescribeDatasetResponse'

-> DescribeDatasetResponse

Create a value of DescribeDatasetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDatasetResponse, describeDatasetResponse_creationTime - When the dataset was created.

$sel:dataFrequency:DescribeDatasetResponse', describeDatasetResponse_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.

DescribeDataset, describeDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset.

DescribeDatasetResponse, describeDatasetResponse_datasetName - The name of the dataset.

DescribeDatasetResponse, describeDatasetResponse_datasetType - The dataset type.

DescribeDatasetResponse, describeDatasetResponse_domain - The domain associated with the dataset.

$sel:encryptionConfig:DescribeDatasetResponse', describeDatasetResponse_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.

DescribeDatasetResponse, describeDatasetResponse_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.

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

DescribeDatasetResponse, describeDatasetResponse_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.

$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.

Response Lenses

describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)

When the dataset was created.

describeDatasetResponse_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text)

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.

describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the dataset.

describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text)

The name of the dataset.

describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType)

The dataset type.

describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain)

The domain associated with the dataset.

describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe 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.

describeDatasetResponse_lastModificationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)

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.

describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema)

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

describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text)

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.

describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int

The response's http status code.