Amazon Forecast Forecasts API

openapi: 3.2.0
info:
  title: Amazon Forecast Forecasts API
  version: '2018-06-26'
  description: 'Operations tagged Forecasts across 2 of this provider''s published API definitions: amazon-forecast-openapi.yml, amazon-forecast-forecasts-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://forecast.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Forecasts
  description: Generated forecast outputs
paths:
  /forecasts:
    post:
      operationId: createForecast
      summary: Create Forecast
      description: Creates a forecast for each item in the TARGET_TIME_SERIES dataset.
      tags:
      - Forecasts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateForecastRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ForecastArn:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    ForecastArn: arn:aws:forecast:us-east-1:123456789012:forecast/MyForecast
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - awsSigV4: []
    get:
      operationId: listForecasts
      summary: List Forecasts
      description: Returns a list of forecasts.
      tags:
      - Forecasts
      parameters:
      - name: maxResults
        in: query
        schema:
          type: integer
        description: Maximum results.
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Forecasts:
                    type: array
                    items:
                      $ref: '#/components/schemas/ForecastSummary'
                  NextToken:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    Forecasts:
                    - ForecastArn: arn:aws:forecast:us-east-1:123456789012:forecast/MyForecast
                      ForecastName: MyForecast
                      PredictorArn: arn:aws:forecast:us-east-1:123456789012:predictor/MyPredictor
                      Status: ACTIVE
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - awsSigV4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#CreateForecast:
    post:
      operationId: CreateForecast
      summary: Create Forecast
      description: Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation. The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast. To get a list of all your forecasts, use the ListForecasts operation. The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor. For more information, see howitworks-forecast. The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status. By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateForecastResponse'
        '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.CreateForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateForecastRequest_2'
      tags:
      - Forecasts
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DeleteForecast:
    post:
      operationId: DeleteForecast
      summary: Delete Forecast
      description: Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation. You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.
      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.DeleteForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteForecastRequest'
      tags:
      - Forecasts
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DescribeForecast:
    post:
      operationId: DescribeForecast
      summary: Describe Forecast
      description: 'Describes a forecast created using the CreateForecast operation. In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties: DatasetGroupArn - The dataset group that provided the training data. CreationTime LastModificationTime Status Message - If an error occurred, information about the error.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeForecastResponse'
        '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.DescribeForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeForecastRequest'
      tags:
      - Forecasts
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#ListForecasts:
    post:
      operationId: ListForecasts
      summary: List Forecasts
      description: Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListForecastsResponse'
        '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.ListForecasts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListForecastsRequest'
      tags:
      - Forecasts
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    ForecastSummary:
      type: object
      description: Summary of an Amazon Forecast forecast.
      properties:
        ForecastArn:
          type: string
        ForecastName:
          type: string
        PredictorArn:
          type: string
        DatasetGroupArn:
          type: string
        Status:
          type: string
        CreationTime:
          type: string
          format: date-time
        LastModificationTime:
          type: string
          format: date-time
    Tag:
      type: object
      description: A metadata label applied to a Forecast resource.
      properties:
        Key:
          type: string
        Value:
          type: string
      required:
      - Key
      - Value
    CreateForecastRequest:
      type: object
      required:
      - ForecastName
      - PredictorArn
      properties:
        ForecastName:
          type: string
        PredictorArn:
          type: string
        ForecastTypes:
          type: array
          items:
            type: string
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    ErrorResponse:
      type: object
      description: Standard error response from the Amazon Forecast API.
      properties:
        Message:
          type: string
        Code:
          type: string
    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
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    CreateForecastRequest_2:
      type: object
      properties:
        ForecastName:
          type: string
          description: A name for the forecast.
        PredictorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
        ForecastTypes:
          type: array
          items:
            type: string
          description: The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag_2'
          description: 'The optional metadata that you apply to the forecast 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 charac'
        TimeSeriesSelector:
          $ref: '#/components/schemas/TimeSeriesSelector'
      required:
      - ForecastName
      - PredictorArn
    DescribeForecastResponse:
      type: object
      properties:
        ForecastArn:
          type: string
          description: The forecast ARN as specified in the request.
        ForecastName:
          type: string
          description: The name of the forecast.
        ForecastTypes:
          type: array
          items:
            type: string
          description: The quantiles at which probabilistic forecasts were generated.
        PredictorArn:
          type: string
          description: The ARN of the predictor used to generate the forecast.
        DatasetGroupArn:
          type: string
          description: The ARN of the dataset group that provided the data used to train the predictor.
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The estimated time remaining in minutes for the forecast job to complete.
        Status:
          type: string
          description: 'The status of the 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 forecast must be ACTIVE before you can query or export the forecast.'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the forecast creation task 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.'
        TimeSeriesSelector:
          $ref: '#/components/schemas/TimeSeriesSelector'
    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).
    DataSource:
      type: object
      properties:
        S3Config:
          $ref: '#/components/schemas/S3Config'
      required:
      - S3Config
    Tag_2:
      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
    ListForecastsRequest:
      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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT. Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status. Value - Th
    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
    CreateForecastResponse:
      type: object
      properties:
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast.
    TimeSeriesIdentifiers:
      type: object
      properties:
        DataSource:
          $ref: '#/components/schemas/DataSource'
        Schema:
          $ref: '#/components/schemas/Schema'
        Format:
          type: string
          description: The format of the data, either CSV or PARQUET.
    TimeSeriesSelector:
      type: object
      properties:
        TimeSeriesIdentifiers:
          $ref: '#/components/schemas/TimeSeriesIdentifiers'
    ForecastSummary_2:
      type: object
      properties:
        ForecastArn:
          type: string
          description: The ARN of the forecast.
        ForecastName:
          type: string
          description: The name of the forecast.
        PredictorArn:
          type: string
          description: The ARN of the predictor used to generate the forecast.
        CreatedUsingAutoPredictor:
          type: boolean
          description: Whether the Forecast was created from an AutoPredictor.
        DatasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
        Status:
          type: string
          description: 'The status of the 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 forecast must be ACTIVE before you can query or export the forecast.'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the forecast creation task 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.'
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    DescribeForecastRequest:
      type: object
      properties:
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast.
      required:
      - ForecastArn
    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.
    DeleteForecastRequest:
      type: object
      properties:
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast to delete.
      required:
      - ForecastArn
    ListForecastsResponse:
      type: object
      properties:
        Forecasts:
          type: array
          items:
            $ref: '#/components/schemas/ForecastSummary_2'
          description: An array of objects that summarize each forecast'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.
  securitySchemes:
    awsSigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4
    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-refined-from:
- amazon-forecast-openapi.yml
- amazon-forecast-forecasts-api-openapi.yml