Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.DescribeDatasetImportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

```
CreationTime
```
```
LastModificationTime
```
```
DataSize
```
```
FieldStatistics
```
```
Status
```
Message - If an error occurred, information about the error.

Synopsis

Creating a Request

data DescribeDatasetImportJob Source #

See: newDescribeDatasetImportJob smart constructor.

Constructors

DescribeDatasetImportJob'
Fields datasetImportJobArn :: Text The Amazon Resource Name (ARN) of the dataset import job.

Instances

Instances details

ToJSON DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods toJSON :: DescribeDatasetImportJob -> Value # toEncoding :: DescribeDatasetImportJob -> Encoding # toJSONList :: [DescribeDatasetImportJob] -> Value # toEncodingList :: [DescribeDatasetImportJob] -> Encoding #
ToHeaders DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods toHeaders :: DescribeDatasetImportJob -> [Header] #
ToPath DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods toPath :: DescribeDatasetImportJob -> ByteString #
ToQuery DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods toQuery :: DescribeDatasetImportJob -> QueryString #
AWSRequest DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Associated Types type AWSResponse DescribeDatasetImportJob # Methods request :: (Service -> Service) -> DescribeDatasetImportJob -> Request DescribeDatasetImportJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDatasetImportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDatasetImportJob))) #
Generic DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Associated Types type Rep DescribeDatasetImportJob :: Type -> Type # Methods from :: DescribeDatasetImportJob -> Rep DescribeDatasetImportJob x # to :: Rep DescribeDatasetImportJob x -> DescribeDatasetImportJob #
Read DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods readsPrec :: Int -> ReadS DescribeDatasetImportJob # readList :: ReadS [DescribeDatasetImportJob] # readPrec :: ReadPrec DescribeDatasetImportJob # readListPrec :: ReadPrec [DescribeDatasetImportJob] #
Show DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods showsPrec :: Int -> DescribeDatasetImportJob -> ShowS # show :: DescribeDatasetImportJob -> String # showList :: [DescribeDatasetImportJob] -> ShowS #
NFData DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods rnf :: DescribeDatasetImportJob -> () #
Eq DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods (==) :: DescribeDatasetImportJob -> DescribeDatasetImportJob -> Bool # (/=) :: DescribeDatasetImportJob -> DescribeDatasetImportJob -> Bool #
Hashable DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods hashWithSalt :: Int -> DescribeDatasetImportJob -> Int # hash :: DescribeDatasetImportJob -> Int #
type AWSResponse DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob type AWSResponse DescribeDatasetImportJob = DescribeDatasetImportJobResponse
type Rep DescribeDatasetImportJob Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob type Rep DescribeDatasetImportJob = D1 ('MetaData "DescribeDatasetImportJob" "Amazonka.Forecast.DescribeDatasetImportJob" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeDatasetImportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetImportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDatasetImportJob Source #

Arguments

:: Text	`DescribeDatasetImportJob`
-> DescribeDatasetImportJob

Create a value of DescribeDatasetImportJob 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:

DescribeDatasetImportJob, describeDatasetImportJob_datasetImportJobArn - The Amazon Resource Name (ARN) of the dataset import job.

Request Lenses

describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text Source #

The Amazon Resource Name (ARN) of the dataset import job.

Destructuring the Response

data DescribeDatasetImportJobResponse Source #

See: newDescribeDatasetImportJobResponse smart constructor.

Constructors

DescribeDatasetImportJobResponse'

Fields

creationTime :: Maybe POSIX
When the dataset import job was created.
dataSize :: Maybe Double
The size of the dataset in gigabytes (GB) after the import job has finished.
dataSource :: Maybe DataSource
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.
datasetArn :: Maybe Text
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
datasetImportJobArn :: Maybe Text
The ARN of the dataset import job.
datasetImportJobName :: Maybe Text
The name of the dataset import job.
estimatedTimeRemainingInMinutes :: Maybe Integer
The estimated time remaining in minutes for the dataset import job to complete.
fieldStatistics :: Maybe (HashMap Text Statistics)
Statistical information about each field in the input data.
format :: Maybe Text
The format of the imported data, CSV or PARQUET.
geolocationFormat :: Maybe Text
The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".
lastModificationTime :: Maybe POSIX
The last time the resource was modified. The timestamp depends on the status of the job:
- CREATE_PENDING - The CreationTime.
- CREATE_IN_PROGRESS - The current timestamp.
- CREATE_STOPPING - The current timestamp.
- CREATE_STOPPED - When the job stopped.
- ACTIVE or CREATE_FAILED - When the job finished or failed.
message :: Maybe Text
If an error occurred, an informational message about the error.
status :: Maybe Text
The status of the dataset import job. States include:
- ```
ACTIVE
```
- CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
- DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
- CREATE_STOPPING, CREATE_STOPPED
timeZone :: Maybe Text
The single time zone applied to every item in the dataset
timestampFormat :: Maybe Text
The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported
- "yyyy-MM-dd"
  For the following data frequencies: Y, M, W, and D
- "yyyy-MM-dd HH:mm:ss"
  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
useGeolocationForTimeZone :: Maybe Bool
Whether TimeZone is automatically derived from the geolocation attribute.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Associated Types type Rep DescribeDatasetImportJobResponse :: Type -> Type # Methods from :: DescribeDatasetImportJobResponse -> Rep DescribeDatasetImportJobResponse x # to :: Rep DescribeDatasetImportJobResponse x -> DescribeDatasetImportJobResponse #
Read DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods readsPrec :: Int -> ReadS DescribeDatasetImportJobResponse # readList :: ReadS [DescribeDatasetImportJobResponse] # readPrec :: ReadPrec DescribeDatasetImportJobResponse # readListPrec :: ReadPrec [DescribeDatasetImportJobResponse] #
Show DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods showsPrec :: Int -> DescribeDatasetImportJobResponse -> ShowS # show :: DescribeDatasetImportJobResponse -> String # showList :: [DescribeDatasetImportJobResponse] -> ShowS #
NFData DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods rnf :: DescribeDatasetImportJobResponse -> () #
Eq DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob Methods (==) :: DescribeDatasetImportJobResponse -> DescribeDatasetImportJobResponse -> Bool # (/=) :: DescribeDatasetImportJobResponse -> DescribeDatasetImportJobResponse -> Bool #
type Rep DescribeDatasetImportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeDatasetImportJob type Rep DescribeDatasetImportJobResponse = D1 ('MetaData "DescribeDatasetImportJobResponse" "Amazonka.Forecast.DescribeDatasetImportJob" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeDatasetImportJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSource)) :: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "datasetImportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "datasetImportJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "fieldStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Statistics)))))) :: (((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "geolocationFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timeZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "timestampFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "useGeolocationForTimeZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeDatasetImportJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDatasetImportJobResponse'`
-> DescribeDatasetImportJobResponse

Create a value of DescribeDatasetImportJobResponse 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:

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_creationTime - When the dataset import job was created.

$sel:dataSize:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_dataSize - The size of the dataset in gigabytes (GB) after the import job has finished.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_dataSource - The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

DescribeDatasetImportJob, describeDatasetImportJobResponse_datasetImportJobArn - The ARN of the dataset import job.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_datasetImportJobName - The name of the dataset import job.

$sel:estimatedTimeRemainingInMinutes:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the dataset import job to complete.

$sel:fieldStatistics:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_fieldStatistics - Statistical information about each field in the input data.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_format - The format of the imported data, CSV or PARQUET.

$sel:geolocationFormat:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_geolocationFormat - The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

CREATE_PENDING - The CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
CREATE_STOPPING - The current timestamp.
CREATE_STOPPED - When the job stopped.
ACTIVE or CREATE_FAILED - When the job finished or failed.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_message - If an error occurred, an informational message about the error.

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_status - The status of the dataset import job. States include:

```
ACTIVE
```
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

$sel:timeZone:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_timeZone - The single time zone applied to every item in the dataset

DescribeDatasetImportJobResponse, describeDatasetImportJobResponse_timestampFormat - The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

$sel:useGeolocationForTimeZone:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_useGeolocationForTimeZone - Whether TimeZone is automatically derived from the geolocation attribute.

$sel:httpStatus:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeDatasetImportJobResponse_creationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime) Source #

When the dataset import job was created.

describeDatasetImportJobResponse_dataSize :: Lens' DescribeDatasetImportJobResponse (Maybe Double) Source #

The size of the dataset in gigabytes (GB) after the import job has finished.

describeDatasetImportJobResponse_dataSource :: Lens' DescribeDatasetImportJobResponse (Maybe DataSource) Source #

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

describeDatasetImportJobResponse_datasetArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

describeDatasetImportJobResponse_datasetImportJobArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The ARN of the dataset import job.

describeDatasetImportJobResponse_datasetImportJobName :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The name of the dataset import job.

describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeDatasetImportJobResponse (Maybe Integer) Source #

The estimated time remaining in minutes for the dataset import job to complete.

describeDatasetImportJobResponse_fieldStatistics :: Lens' DescribeDatasetImportJobResponse (Maybe (HashMap Text Statistics)) Source #

Statistical information about each field in the input data.

describeDatasetImportJobResponse_format :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The format of the imported data, CSV or PARQUET.

describeDatasetImportJobResponse_geolocationFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

describeDatasetImportJobResponse_lastModificationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime) Source #

The last time the resource was modified. The timestamp depends on the status of the job:

CREATE_PENDING - The CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
CREATE_STOPPING - The current timestamp.
CREATE_STOPPED - When the job stopped.
ACTIVE or CREATE_FAILED - When the job finished or failed.

describeDatasetImportJobResponse_message :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

If an error occurred, an informational message about the error.

describeDatasetImportJobResponse_status :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The status of the dataset import job. States include:

```
ACTIVE
```
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

describeDatasetImportJobResponse_timeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The single time zone applied to every item in the dataset

describeDatasetImportJobResponse_timestampFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

describeDatasetImportJobResponse_useGeolocationForTimeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Bool) Source #

Whether TimeZone is automatically derived from the geolocation attribute.

describeDatasetImportJobResponse_httpStatus :: Lens' DescribeDatasetImportJobResponse Int Source #

The response's http status code.