find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-forecast:amazon-forecast-forecast-export-job-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Forecast Service Forecast Export Job 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: Forecast Export Job
paths:
  /#DeleteForecastExportJob:
    post:
      operationId: DeleteForecastExportJob
      summary: Delete Forecast Export Job
      description: Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob 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.DeleteForecastExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteForecastExportJobRequest'
      tags:
      - Forecast Export Job
  /#DescribeForecastExportJob:
    post:
      operationId: DescribeForecastExportJob
      summary: Describe Forecast Export Job
      description: 'Describes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message - If an error occurred, information about the error.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeForecastExportJobResponse'
        '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.DescribeForecastExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeForecastExportJobRequest'
      tags:
      - Forecast Export Job
  /#ListForecastExportJobs:
    post:
      operationId: ListForecastExportJobs
      summary: List Forecast Export Jobs
      description: Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListForecastExportJobsResponse'
        '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.ListForecastExportJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListForecastExportJobsRequest'
      tags:
      - Forecast Export Job
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
    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
    ListForecastExportJobsResponse:
      type: object
      properties:
        ForecastExportJobs:
          type: array
          items:
            $ref: '#/components/schemas/ForecastExportJobSummary'
          description: An array of objects that summarize each export job's properties.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    DescribeForecastExportJobResponse:
      type: object
      properties:
        ForecastExportJobArn:
          type: string
          description: The ARN of the forecast export job.
        ForecastExportJobName:
          type: string
          description: The name of the forecast export job.
        ForecastArn:
          type: string
          description: The Amazon Resource Name (ARN) of the exported forecast.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        Status:
          type: string
          description: 'The status of the forecast export job. 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 forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.'
        CreationTime:
          type: string
          format: date-time
          description: When the forecast export job 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.
    DeleteForecastExportJobRequest:
      type: object
      properties:
        ForecastExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast export job to delete.
      required:
      - ForecastExportJobArn
    DataDestination:
      type: object
      properties:
        S3Config:
          $ref: '#/components/schemas/S3Config'
      required:
      - S3Config
    DescribeForecastExportJobRequest:
      type: object
      properties:
        ForecastExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast export job.
      required:
      - ForecastExportJobArn
    ListForecastExportJobsRequest:
      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 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 ForecastArn and Stat
    ForecastExportJobSummary:
      type: object
      properties:
        ForecastExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the forecast export job.
        ForecastExportJobName:
          type: string
          description: The name of the forecast export job.
        Destination:
          $ref: '#/components/schemas/DataDestination'
        Status:
          type: string
          description: 'The status of the forecast export job. 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 forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the forecast export job 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.'
  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)