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.ListWhatIfForecasts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, 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 forecast ARN with the DescribeWhatIfForecast operation.

This operation returns paginated results.

Synopsis

data ListWhatIfForecasts = ListWhatIfForecasts' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListWhatIfForecasts :: ListWhatIfForecasts
listWhatIfForecasts_filters :: Lens' ListWhatIfForecasts (Maybe [Filter])
listWhatIfForecasts_maxResults :: Lens' ListWhatIfForecasts (Maybe Natural)
listWhatIfForecasts_nextToken :: Lens' ListWhatIfForecasts (Maybe Text)
data ListWhatIfForecastsResponse = ListWhatIfForecastsResponse' {
- nextToken :: Maybe Text
- whatIfForecasts :: Maybe [WhatIfForecastSummary]
- httpStatus :: Int
}
newListWhatIfForecastsResponse :: Int -> ListWhatIfForecastsResponse
listWhatIfForecastsResponse_nextToken :: Lens' ListWhatIfForecastsResponse (Maybe Text)
listWhatIfForecastsResponse_whatIfForecasts :: Lens' ListWhatIfForecastsResponse (Maybe [WhatIfForecastSummary])
listWhatIfForecastsResponse_httpStatus :: Lens' ListWhatIfForecastsResponse Int

Creating a Request

data ListWhatIfForecasts Source #

See: newListWhatIfForecasts smart constructor.

Constructors

ListWhatIfForecasts'

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 forecast export 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 forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.
- Key - The name of the parameter to filter on. Valid values are WhatIfForecastArn and Status.
- Value - The value to match.
For example, to list all jobs that export a forecast named electricityWhatIfForecast, specify the following filter:
```
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]
```
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

Instances details

ToJSON ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods toJSON :: ListWhatIfForecasts -> Value # toEncoding :: ListWhatIfForecasts -> Encoding # toJSONList :: [ListWhatIfForecasts] -> Value # toEncodingList :: [ListWhatIfForecasts] -> Encoding #
ToHeaders ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods toHeaders :: ListWhatIfForecasts -> [Header] #
ToPath ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods toPath :: ListWhatIfForecasts -> ByteString #
ToQuery ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods toQuery :: ListWhatIfForecasts -> QueryString #
AWSPager ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods page :: ListWhatIfForecasts -> AWSResponse ListWhatIfForecasts -> Maybe ListWhatIfForecasts #
AWSRequest ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Associated Types type AWSResponse ListWhatIfForecasts # Methods request :: (Service -> Service) -> ListWhatIfForecasts -> Request ListWhatIfForecasts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWhatIfForecasts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWhatIfForecasts))) #
Generic ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Associated Types type Rep ListWhatIfForecasts :: Type -> Type # Methods from :: ListWhatIfForecasts -> Rep ListWhatIfForecasts x # to :: Rep ListWhatIfForecasts x -> ListWhatIfForecasts #
Read ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods readsPrec :: Int -> ReadS ListWhatIfForecasts # readList :: ReadS [ListWhatIfForecasts] # readPrec :: ReadPrec ListWhatIfForecasts # readListPrec :: ReadPrec [ListWhatIfForecasts] #
Show ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods showsPrec :: Int -> ListWhatIfForecasts -> ShowS # show :: ListWhatIfForecasts -> String # showList :: [ListWhatIfForecasts] -> ShowS #
NFData ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods rnf :: ListWhatIfForecasts -> () #
Eq ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods (==) :: ListWhatIfForecasts -> ListWhatIfForecasts -> Bool # (/=) :: ListWhatIfForecasts -> ListWhatIfForecasts -> Bool #
Hashable ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods hashWithSalt :: Int -> ListWhatIfForecasts -> Int # hash :: ListWhatIfForecasts -> Int #
type AWSResponse ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts type AWSResponse ListWhatIfForecasts = ListWhatIfForecastsResponse
type Rep ListWhatIfForecasts Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts type Rep ListWhatIfForecasts = D1 ('MetaData "ListWhatIfForecasts" "Amazonka.Forecast.ListWhatIfForecasts" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListWhatIfForecasts'" '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)))))

newListWhatIfForecasts :: ListWhatIfForecasts Source #

Create a value of ListWhatIfForecasts 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:ListWhatIfForecasts', listWhatIfForecasts_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 forecast export 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 forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.
Key - The name of the parameter to filter on. Valid values are WhatIfForecastArn and Status.
Value - The value to match.

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

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

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

ListWhatIfForecasts, listWhatIfForecasts_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

listWhatIfForecasts_filters :: Lens' ListWhatIfForecasts (Maybe [Filter]) Source #

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 forecast export 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 forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.
Key - The name of the parameter to filter on. Valid values are WhatIfForecastArn and Status.
Value - The value to match.

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

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

listWhatIfForecasts_maxResults :: Lens' ListWhatIfForecasts (Maybe Natural) Source #

The number of items to return in the response.

listWhatIfForecasts_nextToken :: Lens' ListWhatIfForecasts (Maybe Text) Source #

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 ListWhatIfForecastsResponse Source #

See: newListWhatIfForecastsResponse smart constructor.

Constructors

ListWhatIfForecastsResponse'

Fields

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.
whatIfForecasts :: Maybe [WhatIfForecastSummary]
An array of WhatIfForecasts objects that describe the matched forecasts.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Associated Types type Rep ListWhatIfForecastsResponse :: Type -> Type # Methods from :: ListWhatIfForecastsResponse -> Rep ListWhatIfForecastsResponse x # to :: Rep ListWhatIfForecastsResponse x -> ListWhatIfForecastsResponse #
Read ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods readsPrec :: Int -> ReadS ListWhatIfForecastsResponse # readList :: ReadS [ListWhatIfForecastsResponse] # readPrec :: ReadPrec ListWhatIfForecastsResponse # readListPrec :: ReadPrec [ListWhatIfForecastsResponse] #
Show ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods showsPrec :: Int -> ListWhatIfForecastsResponse -> ShowS # show :: ListWhatIfForecastsResponse -> String # showList :: [ListWhatIfForecastsResponse] -> ShowS #
NFData ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods rnf :: ListWhatIfForecastsResponse -> () #
Eq ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts Methods (==) :: ListWhatIfForecastsResponse -> ListWhatIfForecastsResponse -> Bool # (/=) :: ListWhatIfForecastsResponse -> ListWhatIfForecastsResponse -> Bool #
type Rep ListWhatIfForecastsResponse Source #
Instance details Defined in Amazonka.Forecast.ListWhatIfForecasts type Rep ListWhatIfForecastsResponse = D1 ('MetaData "ListWhatIfForecastsResponse" "Amazonka.Forecast.ListWhatIfForecasts" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListWhatIfForecastsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "whatIfForecasts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WhatIfForecastSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWhatIfForecastsResponse Source #

Arguments

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

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

ListWhatIfForecasts, listWhatIfForecastsResponse_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.

$sel:whatIfForecasts:ListWhatIfForecastsResponse', listWhatIfForecastsResponse_whatIfForecasts - An array of WhatIfForecasts objects that describe the matched forecasts.

$sel:httpStatus:ListWhatIfForecastsResponse', listWhatIfForecastsResponse_httpStatus - The response's http status code.

Response Lenses

listWhatIfForecastsResponse_nextToken :: Lens' ListWhatIfForecastsResponse (Maybe Text) Source #

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.

listWhatIfForecastsResponse_whatIfForecasts :: Lens' ListWhatIfForecastsResponse (Maybe [WhatIfForecastSummary]) Source #

An array of WhatIfForecasts objects that describe the matched forecasts.

listWhatIfForecastsResponse_httpStatus :: Lens' ListWhatIfForecastsResponse Int Source #

The response's http status code.