Amazon Forecast Forecast Explainability API

openapi: 3.2.0
info:
  title: Amazon Forecast Service Explainability 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: Explainability
paths:
  /#CreateExplainability:
    post:
      operationId: CreateExplainability
      summary: Create Explainability
      description: 'Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor) Creates an Amazon Forecast Explainability. Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values. To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index. CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN. CreateExplainability with a Predictor ARN You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor in CreateAutoPredictor, that predictor already has an Explainability resource. The following parameters are required when providing a Predictor ARN: ExplainabilityName - A'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExplainabilityResponse'
        '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.CreateExplainability
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExplainabilityRequest'
      tags:
      - Explainability
  /#DeleteExplainability:
    post:
      operationId: DeleteExplainability
      summary: Delete Explainability
      description: Deletes an Explainability resource. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeExplainability 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.DeleteExplainability
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExplainabilityRequest'
      tags:
      - Explainability
  /#DescribeExplainability:
    post:
      operationId: DescribeExplainability
      summary: Describe Explainability
      description: Describes an Explainability resource created using the CreateExplainability operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExplainabilityResponse'
        '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.DescribeExplainability
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExplainabilityRequest'
      tags:
      - Explainability
  /#ListExplainabilities:
    post:
      operationId: ListExplainabilities
      summary: List Explainabilities
      description: Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListExplainabilitiesResponse'
        '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.ListExplainabilities
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListExplainabilitiesRequest'
      tags:
      - Explainability
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
    ExplainabilitySummary:
      type: object
      properties:
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability.
        ExplainabilityName:
          type: string
          description: The name of the Explainability.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
        ExplainabilityConfig:
          $ref: '#/components/schemas/ExplainabilityConfig'
        Status:
          type: string
          description: 'The status of the Explainability. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED'
        Message:
          type: string
          description: Information about any errors that may have occurred during the Explainability creation process.
        CreationTime:
          type: string
          format: date-time
          description: When the Explainability 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.'
    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
    CreateExplainabilityRequest:
      type: object
      properties:
        ExplainabilityName:
          type: string
          description: A unique name for the Explainability.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
        ExplainabilityConfig:
          $ref: '#/components/schemas/ExplainabilityConfig'
        DataSource:
          $ref: '#/components/schemas/DataSource'
        Schema:
          $ref: '#/components/schemas/Schema'
        EnableVisualization:
          type: boolean
          description: Create an Explainability visualization that is viewable within the Amazon Web Services console.
        StartDateTime:
          type: string
          description: 'If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)'
        EndDateTime:
          type: string
          description: 'If TimePointGranularity is set to SPECIFIC, define the last time point for the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive. The following restrictions apply to tags: For each resource, each tag key must be unique and each tag key must have one value. Maximum number of tags per resource: 50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256 Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across ot'
      required:
      - ExplainabilityName
      - ResourceArn
      - ExplainabilityConfig
    ListExplainabilitiesRequest:
      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 returned in the response.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. Key - The name of the parameter to filter on. Valid values are ResourceArn and Status. Value - The value to match.
    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
    DescribeExplainabilityRequest:
      type: object
      properties:
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explaianability to describe.
      required:
      - ExplainabilityArn
    DeleteExplainabilityRequest:
      type: object
      properties:
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability resource to delete.
      required:
      - ExplainabilityArn
    DescribeExplainabilityResponse:
      type: object
      properties:
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability.
        ExplainabilityName:
          type: string
          description: The name of the Explainability.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
        ExplainabilityConfig:
          $ref: '#/components/schemas/ExplainabilityConfig'
        EnableVisualization:
          type: boolean
          description: Whether the visualization was enabled for the Explainability resource.
        DataSource:
          $ref: '#/components/schemas/DataSource'
        Schema:
          $ref: '#/components/schemas/Schema'
        StartDateTime:
          type: string
          description: If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
        EndDateTime:
          type: string
          description: If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The estimated time remaining in minutes for the CreateExplainability job to complete.
        Message:
          type: string
          description: If an error occurred, a message about the error.
        Status:
          type: string
          description: 'The status of the Explainability resource. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED'
        CreationTime:
          type: string
          format: date-time
          description: When the Explainability resource 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.'
    CreateExplainabilityResponse:
      type: object
      properties:
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability.
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ExplainabilityConfig:
      type: object
      properties:
        TimeSeriesGranularity:
          type: string
          enum:
          - ALL
          - SPECIFIC
          description: To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC. Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
        TimePointGranularity:
          type: string
          enum:
          - ALL
          - SPECIFIC
          description: To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC. Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.
      required:
      - TimeSeriesGranularity
      - TimePointGranularity
    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.
    ListExplainabilitiesResponse:
      type: object
      properties:
        Explainabilities:
          type: array
          items:
            $ref: '#/components/schemas/ExplainabilitySummary'
          description: An array of objects that summarize the properties of each Explainability resource.
        NextToken:
          type: string
          description: Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
  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)