Amazon Forecast Forecast Monitor API
The Forecast Monitor API from Amazon Forecast — 4 operation(s) for forecast monitor.
The Forecast Monitor API from Amazon Forecast — 4 operation(s) for forecast monitor.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-forecast:amazon-forecast-monitor-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Forecast Service Monitor API
version: '2018-06-26'
description: Generated from AWS's published Smithy model for Amazon Forecast Service. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://forecast.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Monitor
paths:
/#CreateMonitor:
post:
operationId: CreateMonitor
summary: Create Monitor
description: Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateMonitorResponse'
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'409':
description: LimitExceededException; ResourceInUseException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/LimitExceededException'
'403':
description: ResourceAlreadyExistsException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.CreateMonitor
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateMonitorRequest'
tags:
- Monitor
/#DeleteMonitor:
post:
operationId: DeleteMonitor
summary: Delete Monitor
description: Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
type: string
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'409':
description: ResourceInUseException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.DeleteMonitor
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteMonitorRequest'
tags:
- Monitor
/#DescribeMonitor:
post:
operationId: DescribeMonitor
summary: Describe Monitor
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'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMonitorResponse'
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.DescribeMonitor
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMonitorRequest'
tags:
- Monitor
/#ListMonitors:
post:
operationId: ListMonitors
summary: List Monitors
description: Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListMonitorsResponse'
'400':
description: InvalidInputException; InvalidNextTokenException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.ListMonitors
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListMonitorsRequest'
tags:
- Monitor
components:
schemas:
ResourceInUseException:
type: object
properties:
Message:
type: string
Filter:
type: object
properties:
Key:
type: string
description: The name of the parameter to filter on.
Value:
type: string
description: The value to match.
Condition:
type: string
enum:
- IS
- IS_NOT
description: The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.
required:
- Key
- Value
- Condition
DescribeMonitorRequest:
type: object
properties:
MonitorArn:
type: string
description: The Amazon Resource Name (ARN) of the monitor resource to describe.
required:
- MonitorArn
CreateMonitorRequest:
type: object
properties:
MonitorName:
type: string
description: The name of the monitor resource.
ResourceArn:
type: string
description: The Amazon Resource Name (ARN) of the predictor to monitor.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of tags to apply to the monitor resource.
required:
- MonitorName
- ResourceArn
ResourceNotFoundException:
type: object
properties:
Message:
type: string
InvalidInputException:
type: object
properties:
Message:
type: string
ListMonitorsResponse:
type: object
properties:
Monitors:
type: array
items:
$ref: '#/components/schemas/MonitorSummary'
description: An array of objects that summarize each monitor's properties.
NextToken:
type: string
description: If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
DeleteMonitorRequest:
type: object
properties:
MonitorArn:
type: string
description: The Amazon Resource Name (ARN) of the monitor resource to delete.
required:
- MonitorArn
LimitExceededException:
type: object
properties:
Message:
type: string
BaselineMetric:
type: object
properties:
Name:
type: string
description: The name of the metric.
Value:
type: number
description: The value for the metric.
Tag:
type: object
properties:
Key:
type: string
description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
Value:
type: string
description: The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
required:
- Key
- Value
PredictorBaseline:
type: object
properties:
BaselineMetrics:
type: array
items:
$ref: '#/components/schemas/BaselineMetric'
description: The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.
ListMonitorsRequest:
type: object
properties:
NextToken:
type: string
description: 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.
MaxResults:
type: integer
description: The maximum number of monitors to include in the response.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: '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 Status. Value - The value to match. For example, to list all monitors who''s status is ACTIVE, you would specify: "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "'
DescribeMonitorResponse:
type: object
properties:
MonitorName:
type: string
description: The name of the monitor.
MonitorArn:
type: string
description: The Amazon Resource Name (ARN) of the monitor resource described.
ResourceArn:
type: string
description: The Amazon Resource Name (ARN) of the auto predictor being monitored.
Status:
type: string
description: The status of the monitor resource.
LastEvaluationTime:
type: string
format: date-time
description: The timestamp of the latest evaluation completed by the monitor.
LastEvaluationState:
type: string
description: The state of the monitor's latest evaluation.
Baseline:
$ref: '#/components/schemas/Baseline'
Message:
type: string
description: An error message, if any, for the monitor.
CreationTime:
type: string
format: date-time
description: The timestamp for when the monitor resource was created.
LastModificationTime:
type: string
format: date-time
description: The timestamp of the latest modification to the monitor.
EstimatedEvaluationTimeRemainingInMinutes:
type: integer
description: The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
ResourceAlreadyExistsException:
type: object
properties:
Message:
type: string
CreateMonitorResponse:
type: object
properties:
MonitorArn:
type: string
description: The Amazon Resource Name (ARN) of the monitor resource.
Baseline:
type: object
properties:
PredictorBaseline:
$ref: '#/components/schemas/PredictorBaseline'
MonitorSummary:
type: object
properties:
MonitorArn:
type: string
description: The Amazon Resource Name (ARN) of the monitor resource.
MonitorName:
type: string
description: The name of the monitor resource.
ResourceArn:
type: string
description: The Amazon Resource Name (ARN) of the predictor being monitored.
Status:
type: string
description: 'The status of the monitor. States include: ACTIVE ACTIVE_STOPPING, ACTIVE_STOPPED UPDATE_IN_PROGRESS CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED'
CreationTime:
type: string
format: date-time
description: When the monitor resource was created.
LastModificationTime:
type: string
format: date-time
description: 'The last time the monitor resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. STOPPED - When the resource stopped. ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.'
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: forecast
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/forecast/service/2018-06-26/forecast-2018-06-26.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)