Amazon Forecast Forecast Dataset Import Job API

openapi: 3.2.0
info:
  title: Amazon Forecast Service Dataset Import 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: Dataset Import Job
paths:
  /#CreateDatasetImportJob:
    post:
      operationId: CreateDatasetImportJob
      summary: Create Dataset Import Job
      description: Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions. The training data must be in CSV or Parquet format. The delimiter must be a comma (,). You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files. Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import. To get a list of all your dataset import jobs, filtered by specified
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetImportJobResponse'
        '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.CreateDatasetImportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetImportJobRequest'
      tags:
      - Dataset Import Job
  /#DeleteDatasetImportJob:
    post:
      operationId: DeleteDatasetImportJob
      summary: Delete Dataset Import Job
      description: Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob 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.DeleteDatasetImportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDatasetImportJobRequest'
      tags:
      - Dataset Import Job
  /#DescribeDatasetImportJob:
    post:
      operationId: DescribeDatasetImportJob
      summary: Describe Dataset Import Job
      description: 'Describes a dataset import job created using the CreateDatasetImportJob operation. In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties: CreationTime LastModificationTime DataSize FieldStatistics 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/DescribeDatasetImportJobResponse'
        '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.DescribeDatasetImportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetImportJobRequest'
      tags:
      - Dataset Import Job
  /#ListDatasetImportJobs:
    post:
      operationId: ListDatasetImportJobs
      summary: List Dataset Import Jobs
      description: Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDatasetImportJobsResponse'
        '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.ListDatasetImportJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDatasetImportJobsRequest'
      tags:
      - Dataset Import Job
components:
  schemas:
    DeleteDatasetImportJobRequest:
      type: object
      properties:
        DatasetImportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset import job to delete.
      required:
      - DatasetImportJobArn
    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
    ListDatasetImportJobsResponse:
      type: object
      properties:
        DatasetImportJobs:
          type: array
          items:
            $ref: '#/components/schemas/DatasetImportJobSummary'
          description: An array of objects that summarize each dataset import 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
    CreateDatasetImportJobRequest:
      type: object
      properties:
        DatasetImportJobName:
          type: string
          description: The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
        DataSource:
          $ref: '#/components/schemas/DataSource'
        TimestampFormat:
          type: string
          description: 'The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D If the format isn''t specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".'
        TimeZone:
          type: string
          description: A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone. Refer to the Joda-Time API for a complete list of valid time zone names.
        UseGeolocationForTimeZone:
          type: boolean
          description: Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.
        GeolocationFormat:
          type: string
          description: 'The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways: LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33). CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'The optional metadata that you apply to the dataset import 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 allo'
        Format:
          type: string
          description: The format of the imported data, CSV or PARQUET. The default value is CSV.
        ImportMode:
          type: string
          enum:
          - FULL
          - INCREMENTAL
          description: Specifies whether the dataset import job is a FULL or INCREMENTAL import. A FULL dataset import replaces all of the existing data with the newly imported data. An INCREMENTAL import appends the imported data to the existing data.
      required:
      - DatasetImportJobName
      - DatasetArn
      - DataSource
    DescribeDatasetImportJobResponse:
      type: object
      properties:
        DatasetImportJobName:
          type: string
          description: The name of the dataset import job.
        DatasetImportJobArn:
          type: string
          description: The ARN of the dataset import job.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
        TimestampFormat:
          type: string
          description: 'The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D'
        TimeZone:
          type: string
          description: The single time zone applied to every item in the dataset
        UseGeolocationForTimeZone:
          type: boolean
          description: Whether TimeZone is automatically derived from the geolocation attribute.
        GeolocationFormat:
          type: string
          description: The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".
        DataSource:
          $ref: '#/components/schemas/DataSource'
        EstimatedTimeRemainingInMinutes:
          type: integer
          description: The estimated time remaining in minutes for the dataset import job to complete.
        FieldStatistics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Statistics'
          description: Statistical information about each field in the input data.
        DataSize:
          type: number
          description: The size of the dataset in gigabytes (GB) after the import job has finished.
        Status:
          type: string
          description: 'The status of the dataset import job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED CREATE_STOPPING, CREATE_STOPPED'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the dataset import 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 imported data, CSV or PARQUET.
        ImportMode:
          type: string
          enum:
          - FULL
          - INCREMENTAL
          description: The import mode of the dataset import job, FULL or INCREMENTAL.
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    DatasetImportJobSummary:
      type: object
      properties:
        DatasetImportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset import job.
        DatasetImportJobName:
          type: string
          description: The name of the dataset import job.
        DataSource:
          $ref: '#/components/schemas/DataSource'
        Status:
          type: string
          description: 'The status of the dataset import job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED CREATE_STOPPING, CREATE_STOPPED'
        Message:
          type: string
          description: If an error occurred, an informational message about the error.
        CreationTime:
          type: string
          format: date-time
          description: When the dataset import 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.'
        ImportMode:
          type: string
          enum:
          - FULL
          - INCREMENTAL
          description: The import mode of the dataset import job, FULL or INCREMENTAL.
    ListDatasetImportJobsRequest:
      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 datasets 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 datasets that match the statement, specify IS. To exclude matching datasets, specify IS_NOT. Key - The name of the parameter to filter on. Valid values are DatasetArn and Status. Value - The value to match. For e
    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
    DataSource:
      type: object
      properties:
        S3Config:
          $ref: '#/components/schemas/S3Config'
      required:
      - S3Config
    Statistics:
      type: object
      properties:
        Count:
          type: integer
          description: The number of values in the field. If the response value is -1, refer to CountLong.
        CountDistinct:
          type: integer
          description: The number of distinct values in the field. If the response value is -1, refer to CountDistinctLong.
        CountNull:
          type: integer
          description: The number of null values in the field. If the response value is -1, refer to CountNullLong.
        CountNan:
          type: integer
          description: The number of NAN (not a number) values in the field. If the response value is -1, refer to CountNanLong.
        Min:
          type: string
          description: For a numeric field, the minimum value in the field.
        Max:
          type: string
          description: For a numeric field, the maximum value in the field.
        Avg:
          type: number
          description: For a numeric field, the average value in the field.
        Stddev:
          type: number
          description: For a numeric field, the standard deviation.
        CountLong:
          type: integer
          description: The number of values in the field. CountLong is used instead of Count if the value is greater than 2,147,483,647.
        CountDistinctLong:
          type: integer
          description: The number of distinct values in the field. CountDistinctLong is used instead of CountDistinct if the value is greater than 2,147,483,647.
        CountNullLong:
          type: integer
          description: The number of null values in the field. CountNullLong is used instead of CountNull if the value is greater than 2,147,483,647.
        CountNanLong:
          type: integer
          description: The number of NAN (not a number) values in the field. CountNanLong is used instead of CountNan if the value is greater than 2,147,483,647.
    DescribeDatasetImportJobRequest:
      type: object
      properties:
        DatasetImportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset import job.
      required:
      - DatasetImportJobArn
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    CreateDatasetImportJobResponse:
      type: object
      properties:
        DatasetImportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset import job.
  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)