Amazonka.Forecast.ListWhatIfAnalyses

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.

This operation returns paginated results.

Creating a Request

data ListWhatIfAnalyses

See: newListWhatIfAnalyses smart constructor.

Constructors

ListWhatIfAnalyses'

Fields

• filters :: Maybe [Filter]

  An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

  Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.
  • Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn and Status.
  • Value - The value to match.

  For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

  "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

• maxResults :: Maybe Natural

  The number of items to return in the response.

• nextToken :: Maybe Text

  If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Instances

ToJSON ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

toJSON :: ListWhatIfAnalyses -> Value

toEncoding :: ListWhatIfAnalyses -> Encoding

toJSONList :: [ListWhatIfAnalyses] -> Value

toEncodingList :: [ListWhatIfAnalyses] -> Encoding

ToHeaders ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

toHeaders :: ListWhatIfAnalyses -> [Header]

ToPath ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

toPath :: ListWhatIfAnalyses -> ByteString

ToQuery ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

toQuery :: ListWhatIfAnalyses -> QueryString

AWSPager ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

page :: ListWhatIfAnalyses -> AWSResponse ListWhatIfAnalyses -> Maybe ListWhatIfAnalyses

AWSRequest ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Associated Types

type AWSResponse ListWhatIfAnalyses

Methods

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

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

Generic ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Associated Types

type Rep ListWhatIfAnalyses :: Type -> Type

Methods

from :: ListWhatIfAnalyses -> Rep ListWhatIfAnalyses x

to :: Rep ListWhatIfAnalyses x -> ListWhatIfAnalyses

Read ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

readsPrec :: Int -> ReadS ListWhatIfAnalyses

readList :: ReadS [ListWhatIfAnalyses]

readPrec :: ReadPrec ListWhatIfAnalyses

readListPrec :: ReadPrec [ListWhatIfAnalyses]

Show ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

showsPrec :: Int -> ListWhatIfAnalyses -> ShowS

show :: ListWhatIfAnalyses -> String

showList :: [ListWhatIfAnalyses] -> ShowS

NFData ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

rnf :: ListWhatIfAnalyses -> ()

Eq ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

(==) :: ListWhatIfAnalyses -> ListWhatIfAnalyses -> Bool

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

Hashable ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

hashWithSalt :: Int -> ListWhatIfAnalyses -> Int

hash :: ListWhatIfAnalyses -> Int

type AWSResponse ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

type AWSResponse ListWhatIfAnalyses = ListWhatIfAnalysesResponse

type Rep ListWhatIfAnalyses

Defined in Amazonka.Forecast.ListWhatIfAnalyses

type Rep ListWhatIfAnalyses = D1 ('MetaData "ListWhatIfAnalyses" "Amazonka.Forecast.ListWhatIfAnalyses" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListWhatIfAnalyses'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListWhatIfAnalyses :: ListWhatIfAnalyses

Create a value of ListWhatIfAnalyses 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:filters:ListWhatIfAnalyses', listWhatIfAnalyses_filters - An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.
• Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn and Status.
• Value - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

$sel:maxResults:ListWhatIfAnalyses', listWhatIfAnalyses_maxResults - The number of items to return in the response.

ListWhatIfAnalyses, listWhatIfAnalyses_nextToken - If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Request Lenses

listWhatIfAnalyses_filters :: Lens' ListWhatIfAnalyses (Maybe [Filter])

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.
• Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn and Status.
• Value - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

listWhatIfAnalyses_maxResults :: Lens' ListWhatIfAnalyses (Maybe Natural)

The number of items to return in the response.

listWhatIfAnalyses_nextToken :: Lens' ListWhatIfAnalyses (Maybe Text)

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Destructuring the Response

data ListWhatIfAnalysesResponse

See: newListWhatIfAnalysesResponse smart constructor.

Constructors

ListWhatIfAnalysesResponse'

Fields

• nextToken :: Maybe Text

  If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

• whatIfAnalyses :: Maybe [WhatIfAnalysisSummary]

  An array of WhatIfAnalysisSummary objects that describe the matched analyses.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Associated Types

type Rep ListWhatIfAnalysesResponse :: Type -> Type

Methods

from :: ListWhatIfAnalysesResponse -> Rep ListWhatIfAnalysesResponse x

to :: Rep ListWhatIfAnalysesResponse x -> ListWhatIfAnalysesResponse

Read ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

readsPrec :: Int -> ReadS ListWhatIfAnalysesResponse

readList :: ReadS [ListWhatIfAnalysesResponse]

readPrec :: ReadPrec ListWhatIfAnalysesResponse

readListPrec :: ReadPrec [ListWhatIfAnalysesResponse]

Show ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

showsPrec :: Int -> ListWhatIfAnalysesResponse -> ShowS

show :: ListWhatIfAnalysesResponse -> String

showList :: [ListWhatIfAnalysesResponse] -> ShowS

NFData ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

rnf :: ListWhatIfAnalysesResponse -> ()

Eq ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

Methods

(==) :: ListWhatIfAnalysesResponse -> ListWhatIfAnalysesResponse -> Bool

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

type Rep ListWhatIfAnalysesResponse

Defined in Amazonka.Forecast.ListWhatIfAnalyses

type Rep ListWhatIfAnalysesResponse = D1 ('MetaData "ListWhatIfAnalysesResponse" "Amazonka.Forecast.ListWhatIfAnalyses" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListWhatIfAnalysesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "whatIfAnalyses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WhatIfAnalysisSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWhatIfAnalysesResponse

Arguments

:: Int

$sel:httpStatus:ListWhatIfAnalysesResponse'

-> ListWhatIfAnalysesResponse

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

ListWhatIfAnalyses, listWhatIfAnalysesResponse_nextToken - If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

$sel:whatIfAnalyses:ListWhatIfAnalysesResponse', listWhatIfAnalysesResponse_whatIfAnalyses - An array of WhatIfAnalysisSummary objects that describe the matched analyses.

$sel:httpStatus:ListWhatIfAnalysesResponse', listWhatIfAnalysesResponse_httpStatus - The response's http status code.

Response Lenses

listWhatIfAnalysesResponse_nextToken :: Lens' ListWhatIfAnalysesResponse (Maybe Text)

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

listWhatIfAnalysesResponse_whatIfAnalyses :: Lens' ListWhatIfAnalysesResponse (Maybe [WhatIfAnalysisSummary])

An array of WhatIfAnalysisSummary objects that describe the matched analyses.

listWhatIfAnalysesResponse_httpStatus :: Lens' ListWhatIfAnalysesResponse Int

The response's http status code.