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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:

```
Baseline
```
```
CreationTime
```
```
LastEvaluationTime
```
```
LastEvaluationState
```
```
LastModificationTime
```
```
Message
```
```
Status
```

Synopsis

data DescribeMonitor = DescribeMonitor' {
- monitorArn :: Text
}
newDescribeMonitor :: Text -> DescribeMonitor
describeMonitor_monitorArn :: Lens' DescribeMonitor Text
data DescribeMonitorResponse = DescribeMonitorResponse' {
- baseline :: Maybe Baseline
- creationTime :: Maybe POSIX
- estimatedEvaluationTimeRemainingInMinutes :: Maybe Integer
- lastEvaluationState :: Maybe Text
- lastEvaluationTime :: Maybe POSIX
- lastModificationTime :: Maybe POSIX
- message :: Maybe Text
- monitorArn :: Maybe Text
- monitorName :: Maybe Text
- resourceArn :: Maybe Text
- status :: Maybe Text
- httpStatus :: Int
}
newDescribeMonitorResponse :: Int -> DescribeMonitorResponse
describeMonitorResponse_baseline :: Lens' DescribeMonitorResponse (Maybe Baseline)
describeMonitorResponse_creationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes :: Lens' DescribeMonitorResponse (Maybe Integer)
describeMonitorResponse_lastEvaluationState :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_lastEvaluationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
describeMonitorResponse_lastModificationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
describeMonitorResponse_message :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_monitorArn :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_monitorName :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_resourceArn :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_status :: Lens' DescribeMonitorResponse (Maybe Text)
describeMonitorResponse_httpStatus :: Lens' DescribeMonitorResponse Int

Creating a Request

data DescribeMonitor Source #

See: newDescribeMonitor smart constructor.

Constructors

DescribeMonitor'
Fields monitorArn :: Text The Amazon Resource Name (ARN) of the monitor resource to describe.

Instances

Instances details

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

newDescribeMonitor Source #

Arguments

:: Text	`DescribeMonitor`
-> DescribeMonitor

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

DescribeMonitor, describeMonitor_monitorArn - The Amazon Resource Name (ARN) of the monitor resource to describe.

Request Lenses

describeMonitor_monitorArn :: Lens' DescribeMonitor Text Source #

The Amazon Resource Name (ARN) of the monitor resource to describe.

Destructuring the Response

data DescribeMonitorResponse Source #

See: newDescribeMonitorResponse smart constructor.

Constructors

DescribeMonitorResponse'

Fields

baseline :: Maybe Baseline
Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
creationTime :: Maybe POSIX
The timestamp for when the monitor resource was created.
estimatedEvaluationTimeRemainingInMinutes :: Maybe Integer
The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
lastEvaluationState :: Maybe Text
The state of the monitor's latest evaluation.
lastEvaluationTime :: Maybe POSIX
The timestamp of the latest evaluation completed by the monitor.
lastModificationTime :: Maybe POSIX
The timestamp of the latest modification to the monitor.
message :: Maybe Text
An error message, if any, for the monitor.
monitorArn :: Maybe Text
The Amazon Resource Name (ARN) of the monitor resource described.
monitorName :: Maybe Text
The name of the monitor.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the auto predictor being monitored.
status :: Maybe Text
The status of the monitor resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor Associated Types type Rep DescribeMonitorResponse :: Type -> Type # Methods from :: DescribeMonitorResponse -> Rep DescribeMonitorResponse x # to :: Rep DescribeMonitorResponse x -> DescribeMonitorResponse #
Read DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor Methods readsPrec :: Int -> ReadS DescribeMonitorResponse # readList :: ReadS [DescribeMonitorResponse] # readPrec :: ReadPrec DescribeMonitorResponse # readListPrec :: ReadPrec [DescribeMonitorResponse] #
Show DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor Methods showsPrec :: Int -> DescribeMonitorResponse -> ShowS # show :: DescribeMonitorResponse -> String # showList :: [DescribeMonitorResponse] -> ShowS #
NFData DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor Methods rnf :: DescribeMonitorResponse -> () #
Eq DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor Methods (==) :: DescribeMonitorResponse -> DescribeMonitorResponse -> Bool # (/=) :: DescribeMonitorResponse -> DescribeMonitorResponse -> Bool #
type Rep DescribeMonitorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeMonitor type Rep DescribeMonitorResponse = D1 ('MetaData "DescribeMonitorResponse" "Amazonka.Forecast.DescribeMonitor" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeMonitorResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "baseline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Baseline)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "estimatedEvaluationTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "lastEvaluationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastEvaluationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "monitorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "monitorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeMonitorResponse Source #

Arguments

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

Create a value of DescribeMonitorResponse 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:baseline:DescribeMonitorResponse', describeMonitorResponse_baseline - Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

DescribeMonitorResponse, describeMonitorResponse_creationTime - The timestamp for when the monitor resource was created.

$sel:estimatedEvaluationTimeRemainingInMinutes:DescribeMonitorResponse', describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes - The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

$sel:lastEvaluationState:DescribeMonitorResponse', describeMonitorResponse_lastEvaluationState - The state of the monitor's latest evaluation.

$sel:lastEvaluationTime:DescribeMonitorResponse', describeMonitorResponse_lastEvaluationTime - The timestamp of the latest evaluation completed by the monitor.

DescribeMonitorResponse, describeMonitorResponse_lastModificationTime - The timestamp of the latest modification to the monitor.

DescribeMonitorResponse, describeMonitorResponse_message - An error message, if any, for the monitor.

DescribeMonitor, describeMonitorResponse_monitorArn - The Amazon Resource Name (ARN) of the monitor resource described.

DescribeMonitorResponse, describeMonitorResponse_monitorName - The name of the monitor.

DescribeMonitorResponse, describeMonitorResponse_resourceArn - The Amazon Resource Name (ARN) of the auto predictor being monitored.

DescribeMonitorResponse, describeMonitorResponse_status - The status of the monitor resource.

$sel:httpStatus:DescribeMonitorResponse', describeMonitorResponse_httpStatus - The response's http status code.

Response Lenses

describeMonitorResponse_baseline :: Lens' DescribeMonitorResponse (Maybe Baseline) Source #

Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

describeMonitorResponse_creationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #

The timestamp for when the monitor resource was created.

describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes :: Lens' DescribeMonitorResponse (Maybe Integer) Source #

The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

describeMonitorResponse_lastEvaluationState :: Lens' DescribeMonitorResponse (Maybe Text) Source #

The state of the monitor's latest evaluation.

describeMonitorResponse_lastEvaluationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #

The timestamp of the latest evaluation completed by the monitor.

describeMonitorResponse_lastModificationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #

The timestamp of the latest modification to the monitor.

describeMonitorResponse_message :: Lens' DescribeMonitorResponse (Maybe Text) Source #

An error message, if any, for the monitor.

describeMonitorResponse_monitorArn :: Lens' DescribeMonitorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the monitor resource described.

describeMonitorResponse_monitorName :: Lens' DescribeMonitorResponse (Maybe Text) Source #

The name of the monitor.

describeMonitorResponse_resourceArn :: Lens' DescribeMonitorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the auto predictor being monitored.

describeMonitorResponse_status :: Lens' DescribeMonitorResponse (Maybe Text) Source #

The status of the monitor resource.

describeMonitorResponse_httpStatus :: Lens' DescribeMonitorResponse Int Source #

The response's http status code.