Amazon Forecast Forecast What If Analysis API

openapi: 3.2.0
info:
  title: Amazon Forecast Service What If Analysis API
  version: '2018-06-26'
  description: Generated from AWS's published Smithy model for Amazon Forecast Service. 3 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 Analysis
paths:
  /#CreateWhatIfAnalysis:
    post:
      operationId: CreateWhatIfAnalysis
      summary: Create What If Analysis
      description: What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series. For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other. Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For inst
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateWhatIfAnalysisResponse'
        '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.CreateWhatIfAnalysis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateWhatIfAnalysisRequest'
      tags:
      - What If Analysis
  /#DeleteWhatIfAnalysis:
    post:
      operationId: DeleteWhatIfAnalysis
      summary: Delete What If Analysis
      description: Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfAnalysis operation. You can't delete a what-if analysis while any of its forecasts are being exported.
      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.DeleteWhatIfAnalysis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteWhatIfAnalysisRequest'
      tags:
      - What If Analysis
  /#DescribeWhatIfAnalysis:
    post:
      operationId: DescribeWhatIfAnalysis
      summary: Describe What If Analysis
      description: 'Describes the what-if analysis created using the CreateWhatIfAnalysis operation. In addition to listing the properties provided in the CreateWhatIfAnalysis 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/DescribeWhatIfAnalysisResponse'
        '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.DescribeWhatIfAnalysis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWhatIfAnalysisRequest'
      tags:
      - What If Analysis
components:
  schemas:
    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.
    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
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    TimeSeriesSelector:
      type: object
      properties:
        TimeSeriesIdentifiers:
          $ref: '#/components/schemas/TimeSeriesIdentifiers'
    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.
    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
    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
    DescribeWhatIfAnalysisResponse:
      type: object
      properties:
        WhatIfAnalysisName:
          type: string
          description: The name of the what-if analysis.
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis.
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if forecast.
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The approximate time remaining to complete the what-if analysis, in minutes.
        Status:
          type: string
          description: 'The status of the what-if analysis. 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 analysis 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'
    DeleteWhatIfAnalysisRequest:
      type: object
      properties:
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.
      required:
      - WhatIfAnalysisArn
    CreateWhatIfAnalysisRequest:
      type: object
      properties:
        WhatIfAnalysisName:
          type: string
          description: The name of the what-if analysis. Each name must be unique.
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the baseline forecast.
        TimeSeriesSelector:
          $ref: '#/components/schemas/TimeSeriesSelector'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the what if forecast.
      required:
      - WhatIfAnalysisName
      - ForecastArn
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    DescribeWhatIfAnalysisRequest:
      type: object
      properties:
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.
      required:
      - WhatIfAnalysisArn
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    CreateWhatIfAnalysisResponse:
      type: object
      properties:
        WhatIfAnalysisArn:
          type: string
          description: The Amazon Resource Name (ARN) of the what-if analysis.
  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)