Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
DescribeMonitor
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
Important
Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
Request Syntax
{
"MonitorArn": "string"
}Request Parameters
The request accepts the following data in JSON format.
- MonitorArn
-
The Amazon Resource Name (ARN) of the monitor resource to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+Required: Yes
Response Syntax
{
"Baseline": {
"PredictorBaseline": {
"BaselineMetrics": [
{
"Name": "string",
"Value": number
}
]
}
},
"CreationTime": number,
"EstimatedEvaluationTimeRemainingInMinutes": number,
"LastEvaluationState": "string",
"LastEvaluationTime": number,
"LastModificationTime": number,
"Message": "string",
"MonitorArn": "string",
"MonitorName": "string",
"ResourceArn": "string",
"Status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Baseline
-
Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
Type: Baseline object
- CreationTime
-
The timestamp for when the monitor resource was created.
Type: Timestamp
- EstimatedEvaluationTimeRemainingInMinutes
-
The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
Type: Long
- LastEvaluationState
-
The state of the monitor's latest evaluation.
Type: String
Length Constraints: Maximum length of 256.
- LastEvaluationTime
-
The timestamp of the latest evaluation completed by the monitor.
Type: Timestamp
- LastModificationTime
-
The timestamp of the latest modification to the monitor.
Type: Timestamp
- Message
-
An error message, if any, for the monitor.
Type: String
- MonitorArn
-
The Amazon Resource Name (ARN) of the monitor resource described.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+ - MonitorName
-
The name of the monitor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]* - ResourceArn
-
The Amazon Resource Name (ARN) of the auto predictor being monitored.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+ - Status
-
The status of the monitor resource.
Type: String
Length Constraints: Maximum length of 256.
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
