Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-forecast:amazon-forecast-datasets-api"
All apis
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.
Get an API 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.1.0
info:
title: Amazon Forecast Service Datasets 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: []
paths:
/#CreateDataset:
post:
operationId: CreateDataset
summary: Create Dataset
description: 'Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast
understand how to consume the data for model training. This includes the following: DataFrequency - How frequently
your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain
and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain.
For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum
set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data
type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You
use the dataset group to create a predictor. For more information, see Importing datasets. To get a list of all your
datasets, use the ListDatasets operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get
the status.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateDatasetResponse'
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'409':
description: LimitExceededException
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'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.CreateDataset
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateDatasetRequest'
tags:
- Datasets
/#DeleteDataset:
post:
operationId: DeleteDataset
summary: Delete Dataset
description: Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete
datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast
does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset
group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
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.DeleteDataset
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteDatasetRequest'
tags:
- Datasets
/#DescribeDataset:
post:
operationId: DescribeDataset
summary: Describe Dataset
description: 'Describes an Amazon Forecast dataset created using the CreateDataset operation. In addition to listing
the parameters specified in the CreateDataset request, this operation includes the following dataset properties: CreationTime
LastModificationTime Status'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeDatasetResponse'
'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.DescribeDataset
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeDatasetRequest'
tags:
- Datasets
/#ListDatasets:
post:
operationId: ListDatasets
summary: List Datasets
description: Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its
properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use
the ARN with the DescribeDataset operation.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListDatasetsResponse'
'400':
description: InvalidNextTokenException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonForecast.ListDatasets
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListDatasetsRequest'
tags:
- Datasets
components:
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
schemas:
CreateDatasetRequest:
type: object
properties:
DatasetName:
type: string
description: A name for the dataset.
Domain:
type: string
enum:
- RETAIL
- CUSTOM
- INVENTORY_PLANNING
- EC2_CAPACITY
- WORK_FORCE
- WEB_TRAFFIC
- METRICS
description: The domain associated with the dataset. When you add a dataset to a dataset group, this value and the
value specified for the Domain parameter of the CreateDatasetGroup operation must match. The Domain and DatasetType
that you choose determine the fields that must be present in the training data that you import to the dataset.
For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires
item_id, timestamp, and demand fields to be present in your data. For more information, see Importing datasets.
DatasetType:
type: string
enum:
- TARGET_TIME_SERIES
- RELATED_TIME_SERIES
- ITEM_METADATA
description: The dataset type. Valid values depend on the chosen Domain.
DataFrequency:
type: string
description: 'The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets. Valid
intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
"1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap
with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because
that is equivalent to 1 hour. The valid values for each frequency are the following: Minute - 1-59 Hour - 1-23
Day - 1-6 Week - 1-4 Month - 1-11 Year - 1 Thus,'
Schema:
$ref: '#/components/schemas/Schema'
EncryptionConfig:
$ref: '#/components/schemas/EncryptionConfig'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: 'The optional metadata that you apply to the dataset to help you categorize and organize them. Each
tag consists of a key and an optional value, both of which you define. The following basic restrictions apply
to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag
key can have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256
Unicode characters in UTF-8. If your tagging schema is used across multiple services and resources, remember that
other services may have restrictions on allowed charact'
required:
- DatasetName
- Domain
- DatasetType
- Schema
CreateDatasetResponse:
type: object
properties:
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
DatasetSummary:
type: object
properties:
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
DatasetName:
type: string
description: The name of the dataset.
DatasetType:
type: string
enum:
- TARGET_TIME_SERIES
- RELATED_TIME_SERIES
- ITEM_METADATA
description: The dataset type.
Domain:
type: string
enum:
- RETAIL
- CUSTOM
- INVENTORY_PLANNING
- EC2_CAPACITY
- WORK_FORCE
- WEB_TRAFFIC
- METRICS
description: The domain associated with the dataset.
CreationTime:
type: string
format: date-time
description: When the dataset was created.
LastModificationTime:
type: string
format: date-time
description: When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported
to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob
operation has finished, LastModificationTime is when the import job completed or failed.
DeleteDatasetRequest:
type: object
properties:
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset to delete.
required:
- DatasetArn
DescribeDatasetRequest:
type: object
properties:
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
required:
- DatasetArn
DescribeDatasetResponse:
type: object
properties:
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
DatasetName:
type: string
description: The name of the dataset.
Domain:
type: string
enum:
- RETAIL
- CUSTOM
- INVENTORY_PLANNING
- EC2_CAPACITY
- WORK_FORCE
- WEB_TRAFFIC
- METRICS
description: The domain associated with the dataset.
DatasetType:
type: string
enum:
- TARGET_TIME_SERIES
- RELATED_TIME_SERIES
- ITEM_METADATA
description: The dataset type.
DataFrequency:
type: string
description: The frequency of data collection. Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
"M" indicates every month and "30min" indicates every 30 minutes.
Schema:
$ref: '#/components/schemas/Schema'
EncryptionConfig:
$ref: '#/components/schemas/EncryptionConfig'
Status:
type: string
description: 'The status of the dataset. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED The UPDATE
states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect
the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status
of the dataset is UPDATE_IN_PROGRESS. The Status of the dataset must be ACTIVE before you can import training
data.'
CreationTime:
type: string
format: date-time
description: When the dataset was created.
LastModificationTime:
type: string
format: date-time
description: When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported
to the dataset, LastModificationTime is the current time of the DescribeDataset call. After a CreateDatasetImportJob
operation has finished, LastModificationTime is when the import job completed or failed.
EncryptionConfig:
type: object
properties:
RoleArn:
type: string
description: The ARN of the IAM role that Amazon Forecast can assume to access the KMS key. Passing a role across
Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException
error.
KMSKeyArn:
type: string
description: The Amazon Resource Name (ARN) of the KMS key.
required:
- RoleArn
- KMSKeyArn
InvalidInputException:
type: object
properties:
Message:
type: string
InvalidNextTokenException:
type: object
properties:
Message:
type: string
LimitExceededException:
type: object
properties:
Message:
type: string
ListDatasetsRequest:
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 number of items to return in the response.
ListDatasetsResponse:
type: object
properties:
Datasets:
type: array
items:
$ref: '#/components/schemas/DatasetSummary'
description: An array of objects that summarize each dataset'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.
ResourceAlreadyExistsException:
type: object
properties:
Message:
type: string
ResourceInUseException:
type: object
properties:
Message:
type: string
ResourceNotFoundException:
type: object
properties:
Message:
type: string
Schema:
type: object
properties:
Attributes:
type: array
items:
$ref: '#/components/schemas/SchemaAttribute'
description: An array of attributes specifying the name and type of each field in a dataset.
SchemaAttribute:
type: object
properties:
AttributeName:
type: string
description: The name of the dataset field.
AttributeType:
type: string
enum:
- string
- integer
- float
- timestamp
- geolocation
description: The data type of the field. For a related time series dataset, other than date, item_id, and forecast
dimensions attributes, all attributes should be of numerical type (integer/float).
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
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)