Amazonka.Forecast.DescribeWhatIfForecastExport

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties:

• CreationTime

• LastModificationTime

• Message - If an error occurred, information about the error.

• Status

Creating a Request

data DescribeWhatIfForecastExport

See: newDescribeWhatIfForecastExport smart constructor.

Constructors

DescribeWhatIfForecastExport'

Fields

• whatIfForecastExportArn :: Text

  The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

Instances

ToJSON DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

toJSON :: DescribeWhatIfForecastExport -> Value

toEncoding :: DescribeWhatIfForecastExport -> Encoding

toJSONList :: [DescribeWhatIfForecastExport] -> Value

toEncodingList :: [DescribeWhatIfForecastExport] -> Encoding

ToHeaders DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

toHeaders :: DescribeWhatIfForecastExport -> [Header]

ToPath DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

toPath :: DescribeWhatIfForecastExport -> ByteString

ToQuery DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

toQuery :: DescribeWhatIfForecastExport -> QueryString

AWSRequest DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Associated Types

type AWSResponse DescribeWhatIfForecastExport

Methods

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

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

Generic DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Associated Types

type Rep DescribeWhatIfForecastExport :: Type -> Type

Methods

from :: DescribeWhatIfForecastExport -> Rep DescribeWhatIfForecastExport x

to :: Rep DescribeWhatIfForecastExport x -> DescribeWhatIfForecastExport

Read DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

readsPrec :: Int -> ReadS DescribeWhatIfForecastExport

readList :: ReadS [DescribeWhatIfForecastExport]

readPrec :: ReadPrec DescribeWhatIfForecastExport

readListPrec :: ReadPrec [DescribeWhatIfForecastExport]

Show DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

showsPrec :: Int -> DescribeWhatIfForecastExport -> ShowS

show :: DescribeWhatIfForecastExport -> String

showList :: [DescribeWhatIfForecastExport] -> ShowS

NFData DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

rnf :: DescribeWhatIfForecastExport -> ()

Eq DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

(==) :: DescribeWhatIfForecastExport -> DescribeWhatIfForecastExport -> Bool

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

Hashable DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

hashWithSalt :: Int -> DescribeWhatIfForecastExport -> Int

hash :: DescribeWhatIfForecastExport -> Int

type AWSResponse DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

type AWSResponse DescribeWhatIfForecastExport = DescribeWhatIfForecastExportResponse

type Rep DescribeWhatIfForecastExport

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

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

newDescribeWhatIfForecastExport

Arguments

:: Text

DescribeWhatIfForecastExport

-> DescribeWhatIfForecastExport

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

DescribeWhatIfForecastExport, describeWhatIfForecastExport_whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

Request Lenses

describeWhatIfForecastExport_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExport Text

The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

Destructuring the Response

data DescribeWhatIfForecastExportResponse

See: newDescribeWhatIfForecastExportResponse smart constructor.

Constructors

DescribeWhatIfForecastExportResponse'

Fields

• creationTime :: Maybe POSIX

  When the what-if forecast export was created.

• destination :: Maybe DataDestination
• estimatedTimeRemainingInMinutes :: Maybe Integer

  The approximate time remaining to complete the what-if forecast export, in minutes.

• format :: Maybe Text

  The format of the exported data, CSV or PARQUET.

• 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 what-if forecast. 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 what-if forecast export must be ACTIVE before you can access the forecast export.

• whatIfForecastArns :: Maybe [Text]

  An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

• whatIfForecastExportArn :: Maybe Text

  The Amazon Resource Name (ARN) of the what-if forecast export.

• whatIfForecastExportName :: Maybe Text

  The name of the what-if forecast export.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Associated Types

type Rep DescribeWhatIfForecastExportResponse :: Type -> Type

Methods

from :: DescribeWhatIfForecastExportResponse -> Rep DescribeWhatIfForecastExportResponse x

to :: Rep DescribeWhatIfForecastExportResponse x -> DescribeWhatIfForecastExportResponse

Read DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

readsPrec :: Int -> ReadS DescribeWhatIfForecastExportResponse

readList :: ReadS [DescribeWhatIfForecastExportResponse]

readPrec :: ReadPrec DescribeWhatIfForecastExportResponse

readListPrec :: ReadPrec [DescribeWhatIfForecastExportResponse]

Show DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

showsPrec :: Int -> DescribeWhatIfForecastExportResponse -> ShowS

show :: DescribeWhatIfForecastExportResponse -> String

showList :: [DescribeWhatIfForecastExportResponse] -> ShowS

NFData DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

rnf :: DescribeWhatIfForecastExportResponse -> ()

Eq DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

Methods

(==) :: DescribeWhatIfForecastExportResponse -> DescribeWhatIfForecastExportResponse -> Bool

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

type Rep DescribeWhatIfForecastExportResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecastExport

type Rep DescribeWhatIfForecastExportResponse = D1 ('MetaData "DescribeWhatIfForecastExportResponse" "Amazonka.Forecast.DescribeWhatIfForecastExport" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeWhatIfForecastExportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataDestination))) :*: (S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "format") '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 "whatIfForecastArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "whatIfForecastExportArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "whatIfForecastExportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeWhatIfForecastExportResponse

Arguments

:: Int

$sel:httpStatus:DescribeWhatIfForecastExportResponse'

-> DescribeWhatIfForecastExportResponse

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

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_creationTime - When the what-if forecast export was created.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_destination - Undocumented member.

$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfForecastExportResponse', describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if forecast export, in minutes.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_format - The format of the exported data, CSV or PARQUET.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_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.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_message - If an error occurred, an informational message about the error.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_status - The status of the what-if forecast. 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 what-if forecast export must be ACTIVE before you can access the forecast export.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_whatIfForecastArns - An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

DescribeWhatIfForecastExport, describeWhatIfForecastExportResponse_whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.

DescribeWhatIfForecastExportResponse, describeWhatIfForecastExportResponse_whatIfForecastExportName - The name of the what-if forecast export.

$sel:httpStatus:DescribeWhatIfForecastExportResponse', describeWhatIfForecastExportResponse_httpStatus - The response's http status code.

Response Lenses

describeWhatIfForecastExportResponse_creationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)

When the what-if forecast export was created.

describeWhatIfForecastExportResponse_destination :: Lens' DescribeWhatIfForecastExportResponse (Maybe DataDestination)

Undocumented member.

describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastExportResponse (Maybe Integer)

The approximate time remaining to complete the what-if forecast export, in minutes.

describeWhatIfForecastExportResponse_format :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)

The format of the exported data, CSV or PARQUET.

describeWhatIfForecastExportResponse_lastModificationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)

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.

describeWhatIfForecastExportResponse_message :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)

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

describeWhatIfForecastExportResponse_status :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)

The status of the what-if forecast. 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 what-if forecast export must be ACTIVE before you can access the forecast export.

describeWhatIfForecastExportResponse_whatIfForecastArns :: Lens' DescribeWhatIfForecastExportResponse (Maybe [Text])

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

describeWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)

The Amazon Resource Name (ARN) of the what-if forecast export.

describeWhatIfForecastExportResponse_whatIfForecastExportName :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)

The name of the what-if forecast export.

describeWhatIfForecastExportResponse_httpStatus :: Lens' DescribeWhatIfForecastExportResponse Int

The response's http status code.