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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMonitorEvaluations Source #

See: newListMonitorEvaluations smart constructor.

Constructors

ListMonitorEvaluations'

Fields

filters :: Maybe [Filter]
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.
Filter properties
- Condition - The condition to apply. Valid values are IS and IS_NOT.
- Key - The name of the parameter to filter on. The only valid value is EvaluationState.
- Value - The value to match. Valid values are only SUCCESS or FAILURE.
For example, to list only successful monitor evaluations, you would specify:
```
"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]
```
maxResults :: Maybe Natural
The maximum number of monitoring results to return.
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.
monitorArn :: Text
The Amazon Resource Name (ARN) of the monitor resource to get results from.

Instances

Instances details

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

newListMonitorEvaluations Source #

Arguments

:: Text	`ListMonitorEvaluations`
-> ListMonitorEvaluations

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

Filter properties

Condition - The condition to apply. Valid values are IS and IS_NOT.
Key - The name of the parameter to filter on. The only valid value is EvaluationState.
Value - The value to match. Valid values are only SUCCESS or FAILURE.

For example, to list only successful monitor evaluations, you would specify:

"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]

$sel:maxResults:ListMonitorEvaluations', listMonitorEvaluations_maxResults - The maximum number of monitoring results to return.

ListMonitorEvaluations, listMonitorEvaluations_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.

ListMonitorEvaluations, listMonitorEvaluations_monitorArn - The Amazon Resource Name (ARN) of the monitor resource to get results from.

Request Lenses

listMonitorEvaluations_filters :: Lens' ListMonitorEvaluations (Maybe [Filter]) Source #

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

Filter properties

Condition - The condition to apply. Valid values are IS and IS_NOT.
Key - The name of the parameter to filter on. The only valid value is EvaluationState.
Value - The value to match. Valid values are only SUCCESS or FAILURE.

For example, to list only successful monitor evaluations, you would specify:

"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]

listMonitorEvaluations_maxResults :: Lens' ListMonitorEvaluations (Maybe Natural) Source #

The maximum number of monitoring results to return.

listMonitorEvaluations_nextToken :: Lens' ListMonitorEvaluations (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.

listMonitorEvaluations_monitorArn :: Lens' ListMonitorEvaluations Text Source #

The Amazon Resource Name (ARN) of the monitor resource to get results from.

Destructuring the Response

data ListMonitorEvaluationsResponse Source #

See: newListMonitorEvaluationsResponse smart constructor.

Constructors

ListMonitorEvaluationsResponse'

Fields

nextToken :: Maybe Text
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
predictorMonitorEvaluations :: Maybe [PredictorMonitorEvaluation]
The monitoring results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListMonitorEvaluationsResponse Source #

Arguments

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

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

ListMonitorEvaluations, listMonitorEvaluationsResponse_nextToken - If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

$sel:predictorMonitorEvaluations:ListMonitorEvaluationsResponse', listMonitorEvaluationsResponse_predictorMonitorEvaluations - The monitoring results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.

$sel:httpStatus:ListMonitorEvaluationsResponse', listMonitorEvaluationsResponse_httpStatus - The response's http status code.

Response Lenses

listMonitorEvaluationsResponse_nextToken :: Lens' ListMonitorEvaluationsResponse (Maybe Text) Source #

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

listMonitorEvaluationsResponse_predictorMonitorEvaluations :: Lens' ListMonitorEvaluationsResponse (Maybe [PredictorMonitorEvaluation]) Source #

The monitoring results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.

listMonitorEvaluationsResponse_httpStatus :: Lens' ListMonitorEvaluationsResponse Int Source #

The response's http status code.