Amazon IoT TwinMaker

AWS IoT TwinMaker API

The AWS IoT TwinMaker API provides access to workspaces, scenes, entities, components, and sync jobs for building and managing digital twin applications.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/
📖
GettingStarted
https://docs.aws.amazon.com/iot-twinmaker/latest/guide/twinmaker-gs.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/openapi/amazon-iot-twinmaker-openapi-original.yml

Other Resources

🔗
Pricing
https://aws.amazon.com/iot-twinmaker/pricing/
🔗
FAQ
https://aws.amazon.com/iot-twinmaker/faqs/
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/capabilities/amazon-iot-twinmaker.yaml

OpenAPI Specification

amazon-iot-twinmaker-openapi-original.yml Raw ↑ 
openapi: 3.0.0
info:
  version: '2021-11-29'
  x-release: v4
  title: AWS IoT TwinMaker
  description: 'IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and
    enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and
    repair errors.'
  x-logo:
    url: 'https://twitter.com/awscloud/profile_image?size=original'
    backgroundColor: '#FFFFFF'
  termsOfService: 'https://aws.amazon.com/service-terms/'
  contact:
    name: Mike Ralphson
    email: [email protected]
    url: 'https://github.com/mermade/aws2openapi'
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: 'http://www.apache.org/licenses/'
  x-providerName: amazonaws.com
  x-serviceName: iottwinmaker
  x-aws-signingName: iottwinmaker
  x-origin:
  - contentType: application/json
    url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iottwinmaker-2021-11-29.normal.json'
    converter:
      url: 'https://github.com/mermade/aws2openapi'
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
  x-apisguru-categories:
  - cloud
  x-preferred: true
externalDocs:
  description: Amazon Web Services documentation
  url: 'https://docs.aws.amazon.com/iottwinmaker/'
servers:
- url: 'http://iottwinmaker.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: 'https://iottwinmaker.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: 'http://iottwinmaker.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
- url: 'https://iottwinmaker.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
  '/workspaces/{workspaceId}/entity-properties':
    post:
      operationId: BatchPutPropertyValues
      description: Sets values for multiple time series properties.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPutPropertyValuesResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the properties to set.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - entries
              properties:
                entries:
                  description: An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
                  type: array
                  items:
                    $ref: '#/components/schemas/PropertyValueEntry'
                  minItems: 1
                  maxItems: 10
      summary: Amazon IoT TwinMaker Batch Put Property Values
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  '/workspaces/{workspaceId}/component-types/{componentTypeId}':
    post:
      operationId: CreateComponentType
      description: Creates a component type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentTypeResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      - name: componentTypeId
        in: path
        required: true
        description: The ID of the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_\.\-0-9:]+'
          minLength: 1
          maxLength: 256
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                isSingleton:
                  description: A Boolean value that specifies whether an entity can have more than one component of this type.
                  type: boolean
                description:
                  description: The description of the component type.
                  type: string
                  pattern: .*
                  minLength: 0
                  maxLength: 2048
                propertyDefinitions:
                  description: An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/PropertyDefinitionRequest'
                extendsFrom:
                  description: Specifies the parent component type to extend.
                  type: array
                  items:
                    $ref: '#/components/schemas/ComponentTypeId'
                functions:
                  description: An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/FunctionRequest'
                tags:
                  description: Metadata that you can use to manage the component type.
                  type: object
                  minProperties: 0
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
                propertyGroups:
                  description: <p/>
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/PropertyGroupRequest'
                componentTypeName:
                  description: A friendly name for the component type.
                  type: string
                  pattern: '.*[^\u0000-\u001F\u007F]*.*'
                  minLength: 0
                  maxLength: 256
      summary: Amazon IoT TwinMaker Create Component Type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteComponentType
      description: Deletes a component type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteComponentTypeResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      - name: componentTypeId
        in: path
        required: true
        description: The ID of the component type to delete.
        schema:
          type: string
          pattern: '[a-zA-Z_\.\-0-9:]+'
          minLength: 1
          maxLength: 256
      summary: Amazon IoT TwinMaker Delete Component Type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: GetComponentType
      description: Retrieves information about a component type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentTypeResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      - name: componentTypeId
        in: path
        required: true
        description: The ID of the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_\.\-0-9:]+'
          minLength: 1
          maxLength: 256
      summary: Amazon IoT TwinMaker Get Component Type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: UpdateComponentType
      description: Updates information in a component type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentTypeResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      - name: componentTypeId
        in: path
        required: true
        description: The ID of the component type.
        schema:
          type: string
          pattern: '[a-zA-Z_\.\-0-9:]+'
          minLength: 1
          maxLength: 256
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                isSingleton:
                  description: A Boolean value that specifies whether an entity can have more than one component of this type.
                  type: boolean
                description:
                  description: The description of the component type.
                  type: string
                  pattern: .*
                  minLength: 0
                  maxLength: 2048
                propertyDefinitions:
                  description: An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/PropertyDefinitionRequest'
                extendsFrom:
                  description: Specifies the component type that this component type extends.
                  type: array
                  items:
                    $ref: '#/components/schemas/ComponentTypeId'
                functions:
                  description: An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/FunctionRequest'
                propertyGroups:
                  description: The property groups.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/PropertyGroupRequest'
                componentTypeName:
                  description: The component type name.
                  type: string
                  pattern: '.*[^\u0000-\u001F\u007F]*.*'
                  minLength: 0
                  maxLength: 256
      summary: Amazon IoT TwinMaker Update Component Type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  '/workspaces/{workspaceId}/entities':
    post:
      operationId: CreateEntity
      description: Creates an entity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEntityResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the entity.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - entityName
              properties:
                entityId:
                  description: The ID of the entity.
                  type: string
                  pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+'
                  minLength: 1
                  maxLength: 128
                entityName:
                  description: The name of the entity.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
                description:
                  description: The description of the entity.
                  type: string
                  pattern: .*
                  minLength: 0
                  maxLength: 2048
                components:
                  description: An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/ComponentRequest'
                parentEntityId:
                  description: The ID of the entity's parent entity.
                  type: string
                  pattern: '\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+'
                  minLength: 1
                  maxLength: 128
                tags:
                  description: Metadata that you can use to manage the entity.
                  type: object
                  minProperties: 0
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
      summary: Amazon IoT TwinMaker Create Entity
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  '/workspaces/{workspaceId}/scenes':
    post:
      operationId: CreateScene
      description: Creates a scene.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSceneResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The ID of the workspace that contains the scene.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - sceneId
              - contentLocation
              properties:
                sceneId:
                  description: The ID of the scene.
                  type: string
                  pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
                  minLength: 1
                  maxLength: 128
                contentLocation:
                  description: The relative path that specifies the location of the content definition file.
                  type: string
                  pattern: '[sS]3://[A-Za-z0-9._/-]+'
                  minLength: 0
                  maxLength: 256
                description:
                  description: The description for this scene.
                  type: string
                  pattern: .*
                  minLength: 0
                  maxLength: 2048
                capabilities:
                  description: A list of capabilities that the scene uses to render itself.
                  type: array
                  items:
                    $ref: '#/components/schemas/SceneCapability'
                  minItems: 0
                  maxItems: 50
                tags:
                  description: Metadata that you can use to manage the scene.
                  type: object
                  minProperties: 0
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
                sceneMetadata:
                  description: The request metadata.
                  type: object
                  minProperties: 0
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/SceneMetadataValue'
      summary: Amazon IoT TwinMaker Create Scene
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  '/workspaces/{workspaceId}/sync-jobs/{syncSource}':
    post:
      operationId: CreateSyncJob
      description: This action creates a SyncJob.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSyncJobResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The workspace ID.
        schema:
          type: string
          pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
          minLength: 1
          maxLength: 128
      - name: syncSource
        in: path
        required: true
        description: <p>The sync source.</p> <note> <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p> </note>
        schema:
          type: string
          pattern: '[a-zA-Z_0-9]+'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - syncRole
              properties:
                syncRole:
                  description: 'The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.'
                  type: string
                  pattern: 'arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*'
                  minLength: 20
                  maxLength: 2048
                tags:
                  description: The SyncJob tags.
                  type: object
                  minProperties: 0
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
      summary: Amazon IoT TwinMaker Create Sync Job
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteSyncJob
      description: Delete the SyncJob.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSyncJobResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The workspace ID.
        schema:
          type: string
          pat

# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/openapi/amazon-iot-twinmaker-openapi-original.yml