libZSservicesZSamazonka-forecastZSamazonka-forecast
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Forecast.DescribeDataset

Description

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
Synopsis

Creating a Request

data DescribeDataset Source #

See: newDescribeDataset smart constructor.

Constructors

DescribeDataset' 

Fields

Instances

Instances details
Eq DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

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

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

Read DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

readsPrec :: Int -> ReadS DescribeDataset #

readList :: ReadS [DescribeDataset] #

readPrec :: ReadPrec DescribeDataset #

readListPrec :: ReadPrec [DescribeDataset] #

Show DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

showsPrec :: Int -> DescribeDataset -> ShowS #

show :: DescribeDataset -> String #

showList :: [DescribeDataset] -> ShowS #

Generic DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type Rep DescribeDataset :: Type -> Type #

Methods

from :: DescribeDataset -> Rep DescribeDataset x #

to :: Rep DescribeDataset x -> DescribeDataset #

NFData DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

rnf :: DescribeDataset -> () #

Hashable DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

hashWithSalt :: Int -> DescribeDataset -> Int #

hash :: DescribeDataset -> Int #

ToJSON DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

toJSON :: DescribeDataset -> Value #

toEncoding :: DescribeDataset -> Encoding #

toJSONList :: [DescribeDataset] -> Value #

toEncodingList :: [DescribeDataset] -> Encoding #

AWSRequest DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type AWSResponse DescribeDataset #

Methods

request :: DescribeDataset -> Request DescribeDataset #

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

ToHeaders DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

toHeaders :: DescribeDataset -> [Header] #

ToPath DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

toPath :: DescribeDataset -> ByteString #

ToQuery DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

toQuery :: DescribeDataset -> QueryString #

type Rep DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

type Rep DescribeDataset = D1 ('MetaData "DescribeDataset" "Amazonka.Forecast.DescribeDataset" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDataset Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

type AWSResponse DescribeDataset = DescribeDatasetResponse

newDescribeDataset Source #

Arguments

:: Text

$sel:datasetArn: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:

$sel:datasetArn:DescribeDataset', describeDataset_datasetArn - The Amazon Resource Name (ARN) of the dataset.

Request Lenses

describeDataset_datasetArn :: Lens' DescribeDataset Text Source #

The Amazon Resource Name (ARN) of the dataset.

Destructuring the Response

data DescribeDatasetResponse Source #

See: newDescribeDatasetResponse smart constructor.

Constructors

DescribeDatasetResponse' 

Fields

  • creationTime :: Maybe POSIX

    When the dataset was created.

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

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

  • domain :: Maybe Domain

    The domain associated with the dataset.

  • schema :: Maybe Schema

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

  • datasetType :: Maybe DatasetType

    The dataset type.

  • datasetName :: Maybe Text

    The name of 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

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

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

Read DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

readsPrec :: Int -> ReadS DescribeDatasetResponse #

readList :: ReadS [DescribeDatasetResponse] #

readPrec :: ReadPrec DescribeDatasetResponse #

readListPrec :: ReadPrec [DescribeDatasetResponse] #

Show DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

showsPrec :: Int -> DescribeDatasetResponse -> ShowS #

show :: DescribeDatasetResponse -> String #

showList :: [DescribeDatasetResponse] -> ShowS #

Generic DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Associated Types

type Rep DescribeDatasetResponse :: Type -> Type #

Methods

from :: DescribeDatasetResponse -> Rep DescribeDatasetResponse x #

to :: Rep DescribeDatasetResponse x -> DescribeDatasetResponse #

NFData DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

Methods

rnf :: DescribeDatasetResponse -> () #

type Rep DescribeDatasetResponse Source # 
Instance details

Defined in Amazonka.Forecast.DescribeDataset

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

newDescribeDatasetResponse Source #

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:

$sel:creationTime:DescribeDatasetResponse', describeDatasetResponse_creationTime - When the dataset was created.

$sel:status: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: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.

$sel:datasetArn:DescribeDataset', describeDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset.

$sel:domain:DescribeDatasetResponse', describeDatasetResponse_domain - The domain associated with the dataset.

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

$sel:datasetType:DescribeDatasetResponse', describeDatasetResponse_datasetType - The dataset type.

$sel:datasetName:DescribeDatasetResponse', describeDatasetResponse_datasetName - The name of 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.

$sel:lastModificationTime: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.

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

Response Lenses

describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

When the dataset was created.

describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text) Source #

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_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text) Source #

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

The Amazon Resource Name (ARN) of the dataset.

describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain) Source #

The domain associated with the dataset.

describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema) Source #

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

describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType) Source #

The dataset type.

describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The name of the dataset.

describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe EncryptionConfig) Source #

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

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_httpStatus :: Lens' DescribeDatasetResponse Int Source #

The response's http status code.