Amazon Forecast Forecast What If Forecast API

openapi: 3.2.0
info:
  title: Amazon Forecast Service What If Forecast 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
paths:
  /#CreateWhatIfForecast:
    post:
      operationId: CreateWhatIfForecast
      summary: Create What If Forecast
      description: A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateWhatIfForecastResponse'
        '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.CreateWhatIfForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateWhatIfForecastRequest'
      tags:
      - What If Forecast
  /#DeleteWhatIfForecast:
    post:
      operationId: DeleteWhatIfForecast
      summary: Delete What If Forecast
      description: Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecast operation. You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.
      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.DeleteWhatIfForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteWhatIfForecastRequest'
      tags:
      - What If Forecast
  /#DescribeWhatIfForecast:
    post:
      operationId: DescribeWhatIfForecast
      summary: Describe What If Forecast
      description: 'Describes the what-if forecast created using the CreateWhatIfForecast operation. In addition to listing the properties provided in the CreateWhatIfForecast 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/DescribeWhatIfForecastResponse'
        '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.DescribeWhatIfForecast
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWhatIfForecastRequest'
      tags:
      - What If Forecast
  /#ListWhatIfForecasts:
    post:
      operationId: ListWhatIfForecasts
      summary: List What If Forecasts
      description: Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, 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 ARN with the DescribeWhatIfForecast operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListWhatIfForecastsResponse'
        '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.ListWhatIfForecasts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListWhatIfForecastsRequest'
      tags:
      - What If Forecast
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
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    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
    CreateWhatIfForecastRequest:
      type: object
      properties:
        WhatIfForecastName:
          type: string
          description: The name of the what-if forecast. Names must be unique within each what-if analysis.
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis.
        TimeSeriesTransformations:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesTransformation'
          description: The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.
        TimeSeriesReplacementsDataSource:
          $ref: '#/components/schemas/TimeSeriesReplacementsDataSource'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the what if forecast.
      required:
      - WhatIfForecastName
      - WhatIfAnalysisArn
    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
    ListWhatIfForecastsResponse:
      type: object
      properties:
        WhatIfForecasts:
          type: array
          items:
            $ref: '#/components/schemas/WhatIfForecastSummary'
          description: An array of WhatIfForecasts objects that describe the matched forecasts.
        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.
    Action:
      type: object
      properties:
        AttributeName:
          type: string
          description: The related time series that you are modifying. This value is case insensitive.
        Operation:
          type: string
          enum:
          - ADD
          - SUBTRACT
          - MULTIPLY
          - DIVIDE
          description: 'The operation that is applied to the provided attribute. Operations include: ADD - adds Value to all rows of AttributeName. SUBTRACT - subtracts Value from all rows of AttributeName. MULTIPLY - multiplies all rows of AttributeName by Value. DIVIDE - divides all rows of AttributeName by Value.'
        Value:
          type: number
          description: The value that is applied for the chosen Operation.
      required:
      - AttributeName
      - Operation
      - Value
    DescribeWhatIfForecastRequest:
      type: object
      properties:
        WhatIfForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.
      required:
      - WhatIfForecastArn
    DeleteWhatIfForecastRequest:
      type: object
      properties:
        WhatIfForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.
      required:
      - WhatIfForecastArn
    TimeSeriesReplacementsDataSource:
      type: object
      properties:
        S3Config:
          $ref: '#/components/schemas/S3Config'
        Schema:
          $ref: '#/components/schemas/Schema'
        Format:
          type: string
          description: The format of the replacement data, CSV or PARQUET.
        TimestampFormat:
          type: string
          description: The timestamp format of the replacement data.
      required:
      - S3Config
      - Schema
    TimeSeriesTransformation:
      type: object
      properties:
        Action:
          $ref: '#/components/schemas/Action'
        TimeSeriesConditions:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesCondition'
          description: An array of conditions that define which members of the related time series are transformed.
    DescribeWhatIfForecastResponse:
      type: object
      properties:
        WhatIfForecastName:
          type: string
          description: The name of the what-if forecast.
        WhatIfForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast.
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The approximate time remaining to complete the what-if forecast, in minutes.
        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 must be ACTIVE before you can access 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 what-if forecast 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.'
        TimeSeriesTransformations:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesTransformation'
          description: An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
        TimeSeriesReplacementsDataSource:
          $ref: '#/components/schemas/TimeSeriesReplacementsDataSource'
        ForecastTypes:
          type: array
          items:
            type: string
          description: The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
    WhatIfForecastSummary:
      type: object
      properties:
        WhatIfForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast.
        WhatIfForecastName:
          type: string
          description: The name of the what-if forecast.
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
        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 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 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.'
    TimeSeriesCondition:
      type: object
      properties:
        AttributeName:
          type: string
          description: The item_id, dimension name, IM name, or timestamp that you are modifying.
        AttributeValue:
          type: string
          description: The value that is applied for the chosen Condition.
        Condition:
          type: string
          enum:
          - EQUALS
          - NOT_EQUALS
          - LESS_THAN
          - GREATER_THAN
          description: The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.
      required:
      - AttributeName
      - AttributeValue
      - Condition
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    CreateWhatIfForecastResponse:
      type: object
      properties:
        WhatIfForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast.
    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.
    ListWhatIfForecastsRequest:
      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
  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)