Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Forecast.DescribeForecastExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

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

Synopsis

Creating a Request

data DescribeForecastExportJob Source #

See: newDescribeForecastExportJob smart constructor.

Constructors

DescribeForecastExportJob'
Fields forecastExportJobArn :: Text The Amazon Resource Name (ARN) of the forecast export job.

Instances

Instances details

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

newDescribeForecastExportJob Source #

Arguments

:: Text	`$sel:forecastExportJobArn:DescribeForecastExportJob'`
-> DescribeForecastExportJob

Create a value of DescribeForecastExportJob 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:forecastExportJobArn:DescribeForecastExportJob', describeForecastExportJob_forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.

Request Lenses

describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text Source #

The Amazon Resource Name (ARN) of the forecast export job.

Destructuring the Response

data DescribeForecastExportJobResponse Source #

See: newDescribeForecastExportJobResponse smart constructor.

Constructors

DescribeForecastExportJobResponse'

Fields

creationTime :: Maybe POSIX
When the forecast export job was created.
status :: Maybe Text
The status of the forecast export job. States include:
- ```
ACTIVE
```
- CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
- CREATE_STOPPING, CREATE_STOPPED
- DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.
destination :: Maybe DataDestination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
forecastExportJobArn :: Maybe Text
The ARN of the forecast export job.
forecastArn :: Maybe Text
The Amazon Resource Name (ARN) of the exported forecast.
forecastExportJobName :: Maybe Text
The name of the forecast export job.
message :: Maybe Text
If an error occurred, an informational message about the error.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob Methods (==) :: DescribeForecastExportJobResponse -> DescribeForecastExportJobResponse -> Bool # (/=) :: DescribeForecastExportJobResponse -> DescribeForecastExportJobResponse -> Bool #
Read DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob Methods readsPrec :: Int -> ReadS DescribeForecastExportJobResponse # readList :: ReadS [DescribeForecastExportJobResponse] # readPrec :: ReadPrec DescribeForecastExportJobResponse # readListPrec :: ReadPrec [DescribeForecastExportJobResponse] #
Show DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob Methods showsPrec :: Int -> DescribeForecastExportJobResponse -> ShowS # show :: DescribeForecastExportJobResponse -> String # showList :: [DescribeForecastExportJobResponse] -> ShowS #
Generic DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob Associated Types type Rep DescribeForecastExportJobResponse :: Type -> Type # Methods from :: DescribeForecastExportJobResponse -> Rep DescribeForecastExportJobResponse x # to :: Rep DescribeForecastExportJobResponse x -> DescribeForecastExportJobResponse #
NFData DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob Methods rnf :: DescribeForecastExportJobResponse -> () #
type Rep DescribeForecastExportJobResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecastExportJob type Rep DescribeForecastExportJobResponse = D1 ('MetaData "DescribeForecastExportJobResponse" "Amazonka.Forecast.DescribeForecastExportJob" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeForecastExportJobResponse'" '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 "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataDestination)) :: S1 ('MetaSel ('Just "forecastExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "forecastExportJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeForecastExportJobResponse Source #

Arguments

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

Create a value of DescribeForecastExportJobResponse 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:DescribeForecastExportJobResponse', describeForecastExportJobResponse_creationTime - When the forecast export job was created.

$sel:status:DescribeForecastExportJobResponse', describeForecastExportJobResponse_status - The status of the forecast export job. States include:

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

$sel:destination:DescribeForecastExportJobResponse', describeForecastExportJobResponse_destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

$sel:forecastExportJobArn:DescribeForecastExportJob', describeForecastExportJobResponse_forecastExportJobArn - The ARN of the forecast export job.

$sel:forecastArn:DescribeForecastExportJobResponse', describeForecastExportJobResponse_forecastArn - The Amazon Resource Name (ARN) of the exported forecast.

$sel:forecastExportJobName:DescribeForecastExportJobResponse', describeForecastExportJobResponse_forecastExportJobName - The name of the forecast export job.

$sel:message:DescribeForecastExportJobResponse', describeForecastExportJobResponse_message - If an error occurred, an informational message about the error.

$sel:lastModificationTime:DescribeForecastExportJobResponse', describeForecastExportJobResponse_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.

$sel:httpStatus:DescribeForecastExportJobResponse', describeForecastExportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime) Source #

When the forecast export job was created.

describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #

The status of the forecast export job. States include:

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination) Source #

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #

The ARN of the forecast export job.

describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the exported forecast.

describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #

The name of the forecast export job.

describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #

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

describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (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.

describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int Source #

The response's http status code.