Amazon Forecast Dataset Groups API

openapi: 3.2.0
info:
  title: Amazon Forecast Dataset Groups API
  version: '2018-06-26'
  description: 'Operations tagged Dataset Groups across 2 of this provider''s published API definitions: amazon-forecast-openapi.yml, amazon-forecast-dataset-groups-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: Dataset Groups
  description: Logical groupings of related datasets
paths:
  /dataset-groups:
    post:
      operationId: createDatasetGroup
      summary: Create Dataset Group
      description: Creates a dataset group, which holds a collection of related datasets.
      tags:
      - Dataset Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetGroupRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  DatasetGroupArn:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    DatasetGroupArn: arn:aws:forecast:us-east-1:123456789012:dataset-group/MyDSG
        '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: []
    get:
      operationId: listDatasetGroups
      summary: List Dataset Groups
      description: Returns a list of dataset groups.
      tags:
      - Dataset Groups
      parameters:
      - name: maxResults
        in: query
        schema:
          type: integer
        description: Maximum results.
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  DatasetGroups:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatasetGroupSummary'
                  NextToken:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    DatasetGroups:
                    - DatasetGroupArn: arn:aws:forecast:us-east-1:123456789012:dataset-group/MyDSG
                      DatasetGroupName: MyDSG
                      Domain: RETAIL
                      Status: ACTIVE
        '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
  /#CreateDatasetGroup:
    post:
      operationId: CreateDatasetGroup
      summary: Create Dataset Group
      description: Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetGroupResponse'
        '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.CreateDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetGroupRequest_2'
      tags:
      - Dataset Groups
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DeleteDatasetGroup:
    post:
      operationId: DeleteDatasetGroup
      summary: Delete Dataset Group
      description: Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation. This operation deletes only the dataset group, not the datasets in the group.
      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.DeleteDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDatasetGroupRequest'
      tags:
      - Dataset Groups
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DescribeDatasetGroup:
    post:
      operationId: DescribeDatasetGroup
      summary: Describe Dataset Group
      description: 'Describes a dataset group created using the CreateDatasetGroup operation. In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties: DatasetArns - The datasets belonging to the group. CreationTime LastModificationTime Status'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDatasetGroupResponse'
        '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.DescribeDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetGroupRequest'
      tags:
      - Dataset Groups
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#ListDatasetGroups:
    post:
      operationId: ListDatasetGroups
      summary: List Dataset Groups
      description: Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, 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 dataset group ARN with the DescribeDatasetGroup operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDatasetGroupsResponse'
        '400':
          description: InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonForecast.ListDatasetGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDatasetGroupsRequest'
      tags:
      - Dataset Groups
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#UpdateDatasetGroup:
    post:
      operationId: UpdateDatasetGroup
      summary: Update Dataset Group
      description: Replaces the datasets in a dataset group with the specified datasets. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDatasetGroupResponse'
        '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.UpdateDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDatasetGroupRequest'
      tags:
      - Dataset Groups
      security:
      - sigv4: []
    servers:
    - url: https://forecast.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    CreateDatasetGroupRequest:
      type: object
      required:
      - DatasetGroupName
      - Domain
      properties:
        DatasetGroupName:
          type: string
        Domain:
          type: string
        DatasetArns:
          type: array
          items:
            type: string
        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
    DatasetGroupSummary:
      type: object
      description: Summary of an Amazon Forecast dataset group.
      properties:
        DatasetGroupArn:
          type: string
        DatasetGroupName:
          type: string
        Domain:
          type: string
        Status:
          type: string
        CreationTime:
          type: string
          format: date-time
        LastModificationTime:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      description: Standard error response from the Amazon Forecast API.
      properties:
        Message:
          type: string
        Code:
          type: string
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
    DatasetGroupSummary_2:
      type: object
      properties:
        DatasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
        DatasetGroupName:
          type: string
          description: The name of the dataset group.
        CreationTime:
          type: string
          format: date-time
          description: When the dataset group was created.
        LastModificationTime:
          type: string
          format: date-time
          description: When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the ListDatasetGroups call.
    ListDatasetGroupsResponse:
      type: object
      properties:
        DatasetGroups:
          type: array
          items:
            $ref: '#/components/schemas/DatasetGroupSummary_2'
          description: An array of objects that summarize each dataset group'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.
    CreateDatasetGroupResponse:
      type: object
      properties:
        DatasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
    DescribeDatasetGroupRequest:
      type: object
      properties:
        DatasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
      required:
      - DatasetGroupArn
    CreateDatasetGroupRequest_2:
      type: object
      properties:
        DatasetGroupName:
          type: string
          description: A name for the dataset group.
        Domain:
          type: string
          enum:
          - RETAIL
          - CUSTOM
          - INVENTORY_PLANNING
          - EC2_CAPACITY
          - WORK_FORCE
          - WEB_TRAFFIC
          - METRICS
          description: The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match. The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.
        DatasetArns:
          type: array
          items:
            type: string
          description: An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag_2'
          description: 'The optional metadata that you apply to the dataset group 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 allowed c'
      required:
      - DatasetGroupName
      - Domain
    DeleteDatasetGroupRequest:
      type: object
      properties:
        DatasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group to delete.
      required:
      - DatasetGroupArn
    UpdateDatasetGroupResponse:
      type: object
      properties: {}
    InvalidNextTokenException:
      type: object
      properties:
        Message:
          type: string
    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
    DescribeDatasetGroupResponse:
      type: object
      properties:
        DatasetGroupName:
          type: string
          description: The name of the dataset group.
        DatasetGroupArn:
          type: string
          description: The ARN of the dataset group.
        DatasetArns:
          type: array
          items:
            type: string
          description: An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
        Domain:
          type: string
          enum:
          - RETAIL
          - CUSTOM
          - INVENTORY_PLANNING
          - EC2_CAPACITY
          - WORK_FORCE
          - WEB_TRAFFIC
          - METRICS
          description: The domain associated with the dataset group.
        Status:
          type: string
          description: 'The status of the dataset group. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED The UPDATE states apply when you call the UpdateDatasetGroup operation. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.'
        CreationTime:
          type: string
          format: date-time
          description: When the dataset group was created.
        LastModificationTime:
          type: string
          format: date-time
          description: When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.
    UpdateDatasetGroupRequest:
      type: object
      properties:
        DatasetGroupArn:
          type: string
          description: The ARN of the dataset group.
        DatasetArns:
          type: array
          items:
            type: string
          description: An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.
      required:
      - DatasetGroupArn
      - DatasetArns
    ResourceAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ListDatasetGroupsRequest:
      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.
  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-dataset-groups-api-openapi.yml