Amazon IoT SiteWise Iot Sitewise Tasks API

openapi: 3.2.0
info:
  title: AWS IoT SiteWise Tasks API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 5 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://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tasks
paths:
  /workspaces/{workspaceName}/tasks:
    post:
      operationId: CreateTask
      summary: Create Task
      description: Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes. Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTaskRequest'
      tags:
      - Tasks
    get:
      operationId: ListTasks
      summary: List Tasks
      description: Lists tasks in a workspace. To get complete details about a task, use DescribeTask.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTasksResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTasksRequest'
      tags:
      - Tasks
  /workspaces/{workspaceName}/tasks/{taskName}:
    delete:
      operationId: DeleteTask
      summary: Delete Task
      description: Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTaskRequest'
      tags:
      - Tasks
    get:
      operationId: DescribeTask
      summary: Describe Task
      description: Retrieves detailed information about a specific task in a workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeTaskRequest'
      tags:
      - Tasks
    put:
      operationId: UpdateTask
      summary: Update Task
      description: Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskRequest'
      tags:
      - Tasks
components:
  schemas:
    ContainerTaskConfiguration:
      type: object
      properties:
        ecrUri:
          type: string
          description: The Amazon ECR image URI for the task container.
        taskExecutionRole:
          type: string
          description: The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
        processingType:
          type: string
          enum:
          - GENERIC_COMPUTE_PROCESSING
          - HARDWARE_ACCELERATED_PROCESSING
          description: The processing type for compute resources.
        processingUnit:
          type: string
          enum:
          - UNITS_2
          - UNITS_4
          - UNITS_8
          - UNITS_12
          - UNITS_16
          - UNITS_24
          - UNITS_32
          - UNITS_36
          - UNITS_48
          - UNITS_60
          - UNITS_64
          - UNITS_72
          - UNITS_84
          - UNITS_96
          description: The processing unit allocation that determines the vCPU, memory, and GPU resources.
        ephemeralStorageConfiguration:
          $ref: '#/components/schemas/EphemeralStorageConfiguration'
        command:
          type: array
          items:
            type: string
          description: The command to execute in the container.
        timeoutSeconds:
          type: integer
          description: 'The timeout in seconds for task execution. Default: 3600 (1 hour).'
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: Environment variables passed to the container at runtime.
        mounts:
          type: array
          items:
            $ref: '#/components/schemas/Mount'
          description: Mounts attached to the container filesystem. Each mount exposes an external data source as a local directory inside the container. The service assigns each mount a container path based on the mount name. The container reads files through that path as if the data were on the local filesystem.
      required:
      - ecrUri
      - taskExecutionRole
      - processingType
      - processingUnit
    EphemeralStorageConfiguration:
      type: object
      properties:
        storageClass:
          type: string
          enum:
          - STANDARD_1
          - STANDARD_2
          - THROUGHPUT_1
          - THROUGHPUT_2
          description: Storage type that determines I/O performance family and level.
        storageSizeInGiB:
          type: integer
          description: Storage volume size in GiB.
      required:
      - storageClass
      - storageSizeInGiB
    UpdateTaskRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        taskName:
          type: string
          description: The name of the task to update.
        description:
          type: string
          description: A new description for the task.
        taskConfiguration:
          $ref: '#/components/schemas/TaskConfiguration'
      required:
      - workspaceName
      - taskName
    CreateTaskRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        taskName:
          type: string
          description: The name of the task to create. Must be unique within the workspace.
        description:
          type: string
          description: A description of the task.
        taskConfiguration:
          $ref: '#/components/schemas/TaskConfiguration'
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.
      required:
      - workspaceName
      - taskName
      - taskConfiguration
    S3AccessPointSource:
      type: object
      properties:
        accessPointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the S3 access point.
        prefix:
          type: string
          description: An optional key prefix to scope the mount to a subset of objects at the access point.
      required:
      - accessPointArn
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictingOperationException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that conflicts with this operation.
        resourceArn:
          type: string
          description: The ARN of the resource that conflicts with this operation.
      required:
      - message
      - resourceId
      - resourceArn
    TaskSummary:
      type: object
      properties:
        taskName:
          type: string
          description: The name of the task.
        description:
          type: string
          description: The description of the task.
        taskArn:
          type: string
          description: The ARN of the task.
        version:
          type: string
          description: The version of the task.
        status:
          $ref: '#/components/schemas/ResourceStatus'
        createdAt:
          type: string
          format: date-time
          description: The time the task was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The time the task was last updated, in Unix epoch time.
      required:
      - taskName
      - taskArn
      - version
      - status
      - createdAt
      - updatedAt
    DeleteTaskRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        taskName:
          type: string
          description: The name of the task to delete.
      required:
      - workspaceName
      - taskName
    ListTasksResponse:
      type: object
      properties:
        taskSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TaskSummary'
          description: A list that summarizes each task in the workspace.
        nextToken:
          type: string
          description: The token to be used for the next set of paginated results.
      required:
      - taskSummaries
    DescribeTaskResponse:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        taskName:
          type: string
          description: The name of the task.
        description:
          type: string
          description: The description of the task.
        taskArn:
          type: string
          description: The ARN of the task.
        version:
          type: string
          description: The version of the task.
        taskConfiguration:
          $ref: '#/components/schemas/TaskConfiguration'
        status:
          $ref: '#/components/schemas/ResourceStatus'
        createdAt:
          type: string
          format: date-time
          description: The time the task was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The time the task was last updated, in Unix epoch time.
      required:
      - workspaceName
      - taskName
      - taskArn
      - version
      - taskConfiguration
      - status
      - createdAt
      - updatedAt
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateTaskResponse:
      type: object
      properties:
        version:
          type: string
          description: The new version of the task created by this update.
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - version
      - status
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListTasksRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        nextToken:
          type: string
          description: The token to be used for the next set of paginated results.
        maxResults:
          type: integer
          description: 'The maximum number of results to return for each paginated request. Default: 50.'
      required:
      - workspaceName
    CreateTaskResponse:
      type: object
      properties:
        taskName:
          type: string
          description: The name of the created task.
        taskArn:
          type: string
          description: The ARN of the created task.
        version:
          type: string
          description: The version of the newly created task.
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - taskName
      - taskArn
      - version
      - status
    DescribeTaskRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        taskName:
          type: string
          description: The name of the task.
        taskVersion:
          type: string
          description: The version number of the task to retrieve. If not specified, returns the latest version.
      required:
      - workspaceName
      - taskName
    Mount:
      type: object
      properties:
        name:
          type: string
          description: A unique name for the mount within the task.
        relativePath:
          type: string
          description: The relative path under the service-owned mount root where this mount is attached inside the container.
        source:
          $ref: '#/components/schemas/MountSource'
        storageType:
          type: string
          enum:
          - SHARED_STORAGE
          description: The type of storage used for the mount.
      required:
      - name
      - relativePath
      - source
      - storageType
    MountSource:
      type: object
      properties:
        s3AccessPoint:
          $ref: '#/components/schemas/S3AccessPointSource'
      description: Exactly one member is set.
    ResourceError:
      type: object
      properties:
        code:
          type: string
          enum:
          - VALIDATION_ERROR
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
    ResourceStatus:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ResourceError'
        state:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - FAILED
          description: The current status of the resource.
    DeleteTaskResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - status
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    TaskConfiguration:
      type: object
      properties:
        containerTaskConfiguration:
          $ref: '#/components/schemas/ContainerTaskConfiguration'
      description: Exactly one member is set.
  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: iotsitewise
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)