Amazon Forecast

Amazon Forecast Forecast What If Forecast Export API

The Forecast What If Forecast Export API from Amazon Forecast — 4 operation(s) for forecast what if forecast export.

GitHub OpenAPI

Operations 4

POST /#CreateWhatIfForecastExport Create What If Forecast Export #
POST /#DeleteWhatIfForecastExport Delete What If Forecast Export #
POST /#DescribeWhatIfForecastExport Describe What If Forecast Export #
POST /#ListWhatIfForecastExports List What If Forecast Exports #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-forecast/openapi/amazon-forecast-what-if-forecast-export-api-openapi.yml

Work with this as data

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-what-if-forecast-export-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-forecast-what-if-forecast-export-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Forecast Service What If Forecast Export 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: What If Forecast Export
paths:
  /#CreateWhatIfForecastExport:
    post:
      operationId: CreateWhatIfForecastExport
      summary: Create What If Forecast Export
      description: 'Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: ≈__ The component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. For more information, see howitworks-forecast. To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation. The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateWhatIfForecastExportResponse'
        '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.CreateWhatIfForecastExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateWhatIfForecastExportRequest'
      tags:
      - What If Forecast Export
  /#DeleteWhatIfForecastExport:
    post:
      operationId: DeleteWhatIfForecastExport
      summary: Delete What If Forecast Export
      description: Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport operation.
      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.DeleteWhatIfForecastExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteWhatIfForecastExportRequest'
      tags:
      - What If Forecast Export
  /#DescribeWhatIfForecastExport:
    post:
      operationId: DescribeWhatIfForecastExport
      summary: Describe What If Forecast Export
      description: 'Describes the what-if forecast export created using the CreateWhatIfForecastExport operation. In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties: CreationTime LastModificationTime Message - If an error occurred, information about the error. Status'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeWhatIfForecastExportResponse'
        '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.DescribeWhatIfForecastExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWhatIfForecastExportRequest'
      tags:
      - What If Forecast Export
  /#ListWhatIfForecastExports:
    post:
      operationId: ListWhatIfForecastExports
      summary: List What If Forecast Exports
      description: Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListWhatIfForecastExportsResponse'
        '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.ListWhatIfForecastExports
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListWhatIfForecastExportsRequest'
      tags:
      - What If Forecast Export
components:
  schemas:
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
    S3Config:
      type: object
      properties:
        Path:
          type: string
          description: The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
        RoleArn:
          type: string
          description: The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 an Key Management Service (KMS) key.
      required:
      - Path
      - RoleArn
    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
    DeleteWhatIfForecastExportRequest:
      type: object
      properties:
        WhatIfForecastExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete.
      required:
      - WhatIfForecastExportArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    CreateWhatIfForecastExportResponse:
      type: object
      properties:
        WhatIfForecastExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast.
    DescribeWhatIfForecastExportRequest:
      type: object
      properties:
        WhatIfForecastExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.
      required:
      - WhatIfForecastExportArn
    DescribeWhatIfForecastExportResponse:
      type: object
      properties:
        WhatIfForecastExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast export.
        WhatIfForecastExportName:
          type: string
          description: The name of the what-if forecast export.
        WhatIfForecastArns:
          type: array
          items:
            type: string
          description: An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        Status:
          type: string
          description: 'The status of the what-if forecast. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED The Status of the what-if forecast export must be ACTIVE before you can access the forecast export.'
        CreationTime:
          type: string
          format: date-time
          description: When the what-if forecast export was created.
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The approximate time remaining to complete the what-if forecast export, in minutes.
        LastModificationTime:
          type: string
          format: date-time
          description: 'The last time the resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. CREATE_STOPPING - The current timestamp. CREATE_STOPPED - When the job stopped. ACTIVE or CREATE_FAILED - When the job finished or failed.'
        Format:
          type: string
          description: The format of the exported data, CSV or PARQUET.
    DataDestination:
      type: object
      properties:
        S3Config:
          $ref: '#/components/schemas/S3Config'
      required:
      - S3Config
    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
    WhatIfForecastExportSummary:
      type: object
      properties:
        WhatIfForecastExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast export.
        WhatIfForecastArns:
          type: array
          items:
            type: string
          description: An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
        WhatIfForecastExportName:
          type: string
          description: The what-if forecast export name.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Status:
          type: string
          description: 'The status of the what-if forecast export. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED The Status of the what-if analysis must be ACTIVE before you can access the analysis.'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the what-if forecast export was created.
        LastModificationTime:
          type: string
          format: date-time
          description: 'The last time the resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. CREATE_STOPPING - The current timestamp. CREATE_STOPPED - When the job stopped. ACTIVE or CREATE_FAILED - When the job finished or failed.'
    ListWhatIfForecastExportsRequest:
      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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT. Key - The name of the parameter to filter on. Valid values are WhatIfForeca
    CreateWhatIfForecastExportRequest:
      type: object
      properties:
        WhatIfForecastExportName:
          type: string
          description: The name of the what-if forecast to export.
        WhatIfForecastArns:
          type: array
          items:
            type: string
          description: The list of what-if forecast Amazon Resource Names (ARNs) to export.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the what if forecast.
        Format:
          type: string
          description: The format of the exported data, CSV or PARQUET.
      required:
      - WhatIfForecastExportName
      - WhatIfForecastArns
      - Destination
    ListWhatIfForecastExportsResponse:
      type: object
      properties:
        WhatIfForecastExports:
          type: array
          items:
            $ref: '#/components/schemas/WhatIfForecastExportSummary'
          description: An array of WhatIfForecastExports objects that describe the matched forecast exports.
        NextToken:
          type: string
          description: If the response is truncated, 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
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
  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)