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-pipelines-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: AWS IoT SiteWise Pipelines 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: Pipelines
paths:
  /workspaces/{workspaceName}/pipelines:
    post:
      operationId: CreatePipeline
      summary: Create Pipeline
      description: Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting. You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePipelineResponse'
        '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/CreatePipelineRequest'
      tags:
      - Pipelines
    get:
      operationId: ListPipelines
      summary: List Pipelines
      description: Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPipelinesResponse'
        '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/ListPipelinesRequest'
      tags:
      - Pipelines
  /workspaces/{workspaceName}/pipelines/{pipelineName}:
    delete:
      operationId: DeletePipeline
      summary: Delete Pipeline
      description: Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePipelineResponse'
        '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/DeletePipelineRequest'
      tags:
      - Pipelines
    get:
      operationId: DescribePipeline
      summary: Describe Pipeline
      description: Retrieves detailed information about a specific pipeline in a workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePipelineResponse'
        '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/DescribePipelineRequest'
      tags:
      - Pipelines
    put:
      operationId: UpdatePipeline
      summary: Update Pipeline
      description: Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePipelineResponse'
        '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/UpdatePipelineRequest'
      tags:
      - Pipelines
components:
  schemas:
    DescribePipelineResponse:
      type: object
      properties:
        pipelineName:
          type: string
          description: A unique name of the pipeline within the workspace.
        workspaceName:
          type: string
          description: The name of the workspace.
        description:
          type: string
          description: The description of the pipeline.
        pipelineArn:
          type: string
          description: The ARN of the pipeline.
        version:
          type: string
          description: The version of the pipeline.
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: The environment variables shared across all compute nodes in the pipeline.
        computations:
          type: array
          items:
            $ref: '#/components/schemas/ComputeNode'
          description: The list of compute nodes that form the pipeline DAG.
        status:
          $ref: '#/components/schemas/ResourceStatus'
        createdAt:
          type: string
          format: date-time
          description: The time the pipeline was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The time the pipeline was last updated, in Unix epoch time.
      required:
      - pipelineName
      - workspaceName
      - pipelineArn
      - version
      - computations
      - status
      - createdAt
      - updatedAt
    ComputeNode:
      type: object
      properties:
        computeNodeName:
          type: string
          description: The unique name for this compute node within the pipeline.
        taskName:
          type: string
          description: The name of the task to execute for this compute node.
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
        dependsOn:
          type: array
          items:
            type: string
          description: A list of compute node names that must complete successfully before this node can start.
      required:
      - computeNodeName
      - taskName
    ListPipelinesResponse:
      type: object
      properties:
        pipelineSummaries:
          type: array
          items:
            $ref: '#/components/schemas/PipelineSummary'
          description: A list that summarizes each pipeline in the workspace.
        nextToken:
          type: string
          description: The token to be used for the next set of paginated results.
      required:
      - pipelineSummaries
    UpdatePipelineResponse:
      type: object
      properties:
        version:
          type: string
          description: The new version of the pipeline created by this update.
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - version
      - status
    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
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    UpdatePipelineRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        pipelineName:
          type: string
          description: The name of the pipeline to update.
        description:
          type: string
          description: A new description for the pipeline.
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: Updated environment variables shared across all compute nodes.
        computations:
          type: array
          items:
            $ref: '#/components/schemas/ComputeNode'
          description: Updated list of compute nodes forming the pipeline DAG.
      required:
      - workspaceName
      - pipelineName
    DeletePipelineRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        pipelineName:
          type: string
          description: The name of the pipeline to delete.
      required:
      - workspaceName
      - pipelineName
    ListPipelinesRequest:
      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
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreatePipelineRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        pipelineName:
          type: string
          description: The name of the pipeline to create. Must be unique within the workspace.
        description:
          type: string
          description: A description of the pipeline.
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.
        computations:
          type: array
          items:
            $ref: '#/components/schemas/ComputeNode'
          description: The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs that contain metadata for the pipeline. 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
      - pipelineName
      - computations
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PipelineSummary:
      type: object
      properties:
        pipelineName:
          type: string
          description: The name of the pipeline.
        description:
          type: string
          description: The description of the pipeline.
        pipelineArn:
          type: string
          description: The ARN of the pipeline.
        version:
          type: string
          description: The version of the pipeline.
        status:
          $ref: '#/components/schemas/ResourceStatus'
        createdAt:
          type: string
          format: date-time
          description: The time the pipeline was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The time the pipeline was last updated, in Unix epoch time.
      required:
      - pipelineName
      - pipelineArn
      - version
      - status
      - createdAt
      - updatedAt
    CreatePipelineResponse:
      type: object
      properties:
        pipelineName:
          type: string
          description: The name of the created pipeline.
        pipelineArn:
          type: string
          description: The ARN of the created pipeline.
        version:
          type: string
          description: The version of the newly created pipeline.
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - pipelineName
      - pipelineArn
      - version
      - status
    DeletePipelineResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ResourceStatus'
      required:
      - status
    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.
    DescribePipelineRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        pipelineName:
          type: string
          description: The name of the pipeline.
        pipelineVersion:
          type: string
          description: The version number of the pipeline to retrieve. If not specified, returns the latest version.
      required:
      - workspaceName
      - pipelineName
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  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)