Amazon IoT SiteWise

Amazon IoT SiteWise Iot Sitewise Cancel API

The Iot Sitewise Cancel API from Amazon IoT SiteWise — 3 operation(s) for iot sitewise cancel.

GitHub OpenAPI

Operations 3

POST /workspaces/{workspaceName}/enrichment-jobs/{jobId}/cancel Cancel Enrichment Job #
POST /workspaces/{workspaceName}/pipelines/{pipelineName}/executions/{pipelineExecutionId}/cancel Cancel Pipeline Execution #
POST /workspaces/{workspaceName}/queries/{queryId}/cancel Cancel Query #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-iot-sitewise/openapi/amazon-iot-sitewise-cancel-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-iot-sitewise:amazon-iot-sitewise-cancel-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

amazon-iot-sitewise-cancel-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS IoT SiteWise Cancel API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 3 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: Cancel
paths:
  /workspaces/{workspaceName}/enrichment-jobs/{jobId}/cancel:
    post:
      operationId: CancelEnrichmentJob
      summary: Cancel Enrichment Job
      description: 'Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status. Behavior Jobs in PENDING or RUNNING status transition to CANCELLED Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior) The API responds immediately after recording the cancellation Cleanup of job resources happens asynchronously in the background When to Cancel Cancel a job when: The job is taking longer than expected The job was created with incorrect parameters You no longer need the results Idempotency You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelEnrichmentJobResponse'
        '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/CancelEnrichmentJobRequest'
      tags:
      - Cancel
  /workspaces/{workspaceName}/pipelines/{pipelineName}/executions/{pipelineExecutionId}/cancel:
    post:
      operationId: CancelPipelineExecution
      summary: Cancel Pipeline Execution
      description: 'Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPipelineExecutionResponse'
        '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/CancelPipelineExecutionRequest'
      tags:
      - Cancel
  /workspaces/{workspaceName}/queries/{queryId}/cancel:
    post:
      operationId: CancelQuery
      summary: Cancel Query
      description: Cancels a running query.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelQueryResponse'
        '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/CancelQueryRequest'
      tags:
      - Cancel
components:
  schemas:
    CancelQueryResponse:
      type: object
      properties:
        queryId:
          type: string
          description: The unique identifier for the cancelled query.
        status:
          type: string
          enum:
          - SUBMITTED
          - RUNNING
          - COMPLETED
          - FAILED
          - CANCELED
          - CANCELING
          description: The current query status.
      required:
      - queryId
      - status
    CancelEnrichmentJobResponse:
      type: object
      properties:
        jobId:
          type: string
          description: The unique identifier of the cancelled enrichment job.
        status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - COMPLETED
          - FAILED
          - TIMED_OUT
          - CANCELLED
          description: The status of the enrichment job after cancellation. This will be CANCELLED, indicating the job was successfully cancelled or was already in CANCELLED state (idempotent behavior).
      required:
      - jobId
      - status
    CancelQueryRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace associated with the query.
        queryId:
          type: string
          description: The unique identifier for the query execution to cancel.
      required:
      - workspaceName
      - queryId
    CancelPipelineExecutionRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        pipelineName:
          type: string
          description: The name of the pipeline.
        pipelineExecutionId:
          type: string
          description: The unique identifier of the pipeline execution.
        reason:
          type: string
          description: A message describing why the pipeline execution is being cancelled.
      required:
      - workspaceName
      - pipelineName
      - pipelineExecutionId
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CancelPipelineExecutionResponse:
      type: object
      properties:
        state:
          type: string
          enum:
          - NOT_STARTED
          - RUNNING
          - SUCCEEDED
          - FAILED
          - CANCELLING
          - CANCELLED
          description: The current execution state of the pipeline. Can only be CANCELLING or CANCELLED.
      required:
      - state
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    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
    CancelEnrichmentJobRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the IoT SiteWise workspace containing the enrichment job to cancel.
        jobId:
          type: string
          description: The unique identifier of the enrichment job to cancel. This is the jobId returned by CreateEnrichmentJob.
      required:
      - workspaceName
      - jobId
  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)