Amazonka.Forecast.DescribeWhatIfAnalysis

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

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

• CreationTime

• LastModificationTime

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

• Status

Creating a Request

data DescribeWhatIfAnalysis

See: newDescribeWhatIfAnalysis smart constructor.

Constructors

DescribeWhatIfAnalysis'

Fields

• whatIfAnalysisArn :: Text

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

Instances

ToJSON DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

toJSON :: DescribeWhatIfAnalysis -> Value

toEncoding :: DescribeWhatIfAnalysis -> Encoding

toJSONList :: [DescribeWhatIfAnalysis] -> Value

toEncodingList :: [DescribeWhatIfAnalysis] -> Encoding

ToHeaders DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

toHeaders :: DescribeWhatIfAnalysis -> [Header]

ToPath DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

toPath :: DescribeWhatIfAnalysis -> ByteString

ToQuery DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

toQuery :: DescribeWhatIfAnalysis -> QueryString

AWSRequest DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Associated Types

type AWSResponse DescribeWhatIfAnalysis

Methods

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

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

Generic DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Associated Types

type Rep DescribeWhatIfAnalysis :: Type -> Type

Methods

from :: DescribeWhatIfAnalysis -> Rep DescribeWhatIfAnalysis x

to :: Rep DescribeWhatIfAnalysis x -> DescribeWhatIfAnalysis

Read DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

readsPrec :: Int -> ReadS DescribeWhatIfAnalysis

readList :: ReadS [DescribeWhatIfAnalysis]

readPrec :: ReadPrec DescribeWhatIfAnalysis

readListPrec :: ReadPrec [DescribeWhatIfAnalysis]

Show DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

showsPrec :: Int -> DescribeWhatIfAnalysis -> ShowS

show :: DescribeWhatIfAnalysis -> String

showList :: [DescribeWhatIfAnalysis] -> ShowS

NFData DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

rnf :: DescribeWhatIfAnalysis -> ()

Eq DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

(==) :: DescribeWhatIfAnalysis -> DescribeWhatIfAnalysis -> Bool

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

Hashable DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

hashWithSalt :: Int -> DescribeWhatIfAnalysis -> Int

hash :: DescribeWhatIfAnalysis -> Int

type AWSResponse DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

type AWSResponse DescribeWhatIfAnalysis = DescribeWhatIfAnalysisResponse

type Rep DescribeWhatIfAnalysis

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

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

newDescribeWhatIfAnalysis

Arguments

:: Text

DescribeWhatIfAnalysis

-> DescribeWhatIfAnalysis

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

DescribeWhatIfAnalysis, describeWhatIfAnalysis_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

Request Lenses

describeWhatIfAnalysis_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysis Text

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

Destructuring the Response

data DescribeWhatIfAnalysisResponse

See: newDescribeWhatIfAnalysisResponse smart constructor.

Constructors

DescribeWhatIfAnalysisResponse'

Fields

• creationTime :: Maybe POSIX

  When the what-if analysis was created.

• estimatedTimeRemainingInMinutes :: Maybe Integer

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

• forecastArn :: Maybe Text

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

• 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 analysis. 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 analysis must be ACTIVE before you can access the analysis.

• timeSeriesSelector :: Maybe TimeSeriesSelector
• whatIfAnalysisArn :: Maybe Text

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

• whatIfAnalysisName :: Maybe Text

  The name of the what-if analysis.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Associated Types

type Rep DescribeWhatIfAnalysisResponse :: Type -> Type

Methods

from :: DescribeWhatIfAnalysisResponse -> Rep DescribeWhatIfAnalysisResponse x

to :: Rep DescribeWhatIfAnalysisResponse x -> DescribeWhatIfAnalysisResponse

Read DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

readsPrec :: Int -> ReadS DescribeWhatIfAnalysisResponse

readList :: ReadS [DescribeWhatIfAnalysisResponse]

readPrec :: ReadPrec DescribeWhatIfAnalysisResponse

readListPrec :: ReadPrec [DescribeWhatIfAnalysisResponse]

Show DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

showsPrec :: Int -> DescribeWhatIfAnalysisResponse -> ShowS

show :: DescribeWhatIfAnalysisResponse -> String

showList :: [DescribeWhatIfAnalysisResponse] -> ShowS

NFData DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

rnf :: DescribeWhatIfAnalysisResponse -> ()

Eq DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

Methods

(==) :: DescribeWhatIfAnalysisResponse -> DescribeWhatIfAnalysisResponse -> Bool

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

type Rep DescribeWhatIfAnalysisResponse

Defined in Amazonka.Forecast.DescribeWhatIfAnalysis

type Rep DescribeWhatIfAnalysisResponse = D1 ('MetaData "DescribeWhatIfAnalysisResponse" "Amazonka.Forecast.DescribeWhatIfAnalysis" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeWhatIfAnalysisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "forecastArn") '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 "timeSeriesSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSeriesSelector))) :*: (S1 ('MetaSel ('Just "whatIfAnalysisArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "whatIfAnalysisName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeWhatIfAnalysisResponse

Arguments

:: Int

$sel:httpStatus:DescribeWhatIfAnalysisResponse'

-> DescribeWhatIfAnalysisResponse

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

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_creationTime - When the what-if analysis was created.

$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfAnalysisResponse', describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if analysis, in minutes.

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_forecastArn - The Amazon Resource Name (ARN) of the what-if forecast.

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_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.

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_message - If an error occurred, an informational message about the error.

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_status - The status of the what-if analysis. 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 analysis must be ACTIVE before you can access the analysis.

$sel:timeSeriesSelector:DescribeWhatIfAnalysisResponse', describeWhatIfAnalysisResponse_timeSeriesSelector - Undocumented member.

DescribeWhatIfAnalysis, describeWhatIfAnalysisResponse_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.

DescribeWhatIfAnalysisResponse, describeWhatIfAnalysisResponse_whatIfAnalysisName - The name of the what-if analysis.

$sel:httpStatus:DescribeWhatIfAnalysisResponse', describeWhatIfAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

describeWhatIfAnalysisResponse_creationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime)

When the what-if analysis was created.

describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfAnalysisResponse (Maybe Integer)

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

describeWhatIfAnalysisResponse_forecastArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)

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

describeWhatIfAnalysisResponse_lastModificationTime :: Lens' DescribeWhatIfAnalysisResponse (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.

describeWhatIfAnalysisResponse_message :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)

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

describeWhatIfAnalysisResponse_status :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)

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

describeWhatIfAnalysisResponse_timeSeriesSelector :: Lens' DescribeWhatIfAnalysisResponse (Maybe TimeSeriesSelector)

Undocumented member.

describeWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)

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

describeWhatIfAnalysisResponse_whatIfAnalysisName :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)

The name of the what-if analysis.

describeWhatIfAnalysisResponse_httpStatus :: Lens' DescribeWhatIfAnalysisResponse Int

The response's http status code.