Amazon Forecast Export Jobs API

openapi: 3.2.0
info:
  title: Amazon Forecast Export Jobs API
  version: '2018-06-26'
  description: 'Operations tagged Export Jobs across 2 of this provider''s published API definitions: amazon-forecast-openapi.yml, amazon-forecast-export-jobs-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: Export Jobs
  description: Forecast data export to S3
paths:
  /forecast-export-jobs:
    post:
      operationId: createForecastExportJob
      summary: Create Forecast Export Job
      description: Exports a forecast created by CreateForecast to your Amazon S3 bucket.
      tags:
      - Export Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateForecastExportJobRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ForecastExportJobArn:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    ForecastExportJobArn: arn:aws:forecast:us-east-1:123456789012:forecast-export-job/MyExportJob
        '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
  /#CreateForecastExportJob:
    post:
      operationId: CreateForecastExportJob
      summary: Create Forecast Export Job
      description: 'Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: __ where the component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes 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. For more information, see howitworks-forecast. To get a list of all your forecast export jobs, use the ListForecastExportJobs operation. The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateForecastExportJobResponse'
        '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.CreateForecastExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateForecastExportJobRequest_2'
      tags:
      - Export Jobs
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    CreateForecastExportJobRequest:
      type: object
      required:
      - ForecastExportJobName
      - ForecastArn
      - Destination
      properties:
        ForecastExportJobName:
          type: string
        ForecastArn:
          type: string
        Destination:
          type: object
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Tag:
      type: object
      description: A metadata label applied to a Forecast resource.
      properties:
        Key:
          type: string
        Value:
          type: string
      required:
      - Key
      - Value
    ErrorResponse:
      type: object
      description: Standard error response from the Amazon Forecast API.
      properties:
        Message:
          type: string
        Code:
          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
    DataDestination:
      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
    CreateForecastExportJobResponse:
      type: object
      properties:
        ForecastExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the export job.
    CreateForecastExportJobRequest_2:
      type: object
      properties:
        ForecastExportJobName:
          type: string
          description: The name for the forecast export job.
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast that you want to export.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag_2'
          description: 'The optional metadata that you apply to the forecast export job 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 all'
        Format:
          type: string
          description: The format of the exported data, CSV or PARQUET. The default value is CSV.
      required:
      - ForecastExportJobName
      - ForecastArn
      - Destination
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
  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-export-jobs-api-openapi.yml