Amazon Forecast Forecast Explainability Export API

openapi: 3.2.0
info:
  title: Amazon Forecast Service Explainability 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: Explainability Export
paths:
  /#CreateExplainabilityExport:
    post:
      operationId: CreateExplainabilityExport
      summary: Create Explainability Export
      description: Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify a DataDestination object that includes an Amazon S3 bucket and 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. The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExplainabilityExportResponse'
        '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.CreateExplainabilityExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExplainabilityExportRequest'
      tags:
      - Explainability Export
  /#DeleteExplainabilityExport:
    post:
      operationId: DeleteExplainabilityExport
      summary: Delete Explainability Export
      description: Deletes an Explainability export.
      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.DeleteExplainabilityExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExplainabilityExportRequest'
      tags:
      - Explainability Export
  /#DescribeExplainabilityExport:
    post:
      operationId: DescribeExplainabilityExport
      summary: Describe Explainability Export
      description: Describes an Explainability export created using the CreateExplainabilityExport operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExplainabilityExportResponse'
        '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.DescribeExplainabilityExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExplainabilityExportRequest'
      tags:
      - Explainability Export
  /#ListExplainabilityExports:
    post:
      operationId: ListExplainabilityExports
      summary: List Explainability Exports
      description: Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListExplainabilityExportsResponse'
        '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.ListExplainabilityExports
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListExplainabilityExportsRequest'
      tags:
      - Explainability Export
components:
  schemas:
    ListExplainabilityExportsRequest:
      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, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude 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.
    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
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    ExplainabilityExportSummary:
      type: object
      properties:
        ExplainabilityExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability export.
        ExplainabilityExportName:
          type: string
          description: The name of the Explainability export
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Status:
          type: string
          description: 'The status of the Explainability export. 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 export.
        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.'
    DescribeExplainabilityExportResponse:
      type: object
      properties:
        ExplainabilityExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability export.
        ExplainabilityExportName:
          type: string
          description: The name of the Explainability export.
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability export.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Message:
          type: string
          description: Information about any errors that occurred during the export.
        Status:
          type: string
          description: 'The status of the Explainability export. 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 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.'
        Format:
          type: string
          description: The format of the exported data, CSV or PARQUET.
    CreateExplainabilityExportRequest:
      type: object
      properties:
        ExplainabilityExportName:
          type: string
          description: A unique name for the Explainability export.
        ExplainabilityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability to export.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        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'
        Format:
          type: string
          description: The format of the exported data, CSV or PARQUET.
      required:
      - ExplainabilityExportName
      - ExplainabilityArn
      - Destination
    DescribeExplainabilityExportRequest:
      type: object
      properties:
        ExplainabilityExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability export.
      required:
      - ExplainabilityExportArn
    DeleteExplainabilityExportRequest:
      type: object
      properties:
        ExplainabilityExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Explainability export to delete.
      required:
      - ExplainabilityExportArn
    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
    ListExplainabilityExportsResponse:
      type: object
      properties:
        ExplainabilityExports:
          type: array
          items:
            $ref: '#/components/schemas/ExplainabilityExportSummary'
          description: An array of objects that summarize the properties of each Explainability export.
        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.
    CreateExplainabilityExportResponse:
      type: object
      properties:
        ExplainabilityExportArn:
          type: string
          description: The Amazon Resource Name (ARN) of the export.
    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)