Amazon IoT TwinMaker Iot Twinmaker Operations API

openapi: 3.2.0
info:
  title: AWS IoT TwinMaker Operations API
  version: '2021-11-29'
  description: Generated from AWS's published Smithy model for AWS IoT TwinMaker. 11 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://iottwinmaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /metadata-transfer-jobs/{metadataTransferJobId}/cancel:
    put:
      operationId: CancelMetadataTransferJob
      summary: Cancel Metadata Transfer Job
      description: Cancels the metadata transfer job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelMetadataTransferJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelMetadataTransferJobRequest'
      tags:
      - Operations
  /metadata-transfer-jobs:
    post:
      operationId: CreateMetadataTransferJob
      summary: Create Metadata Transfer Job
      description: Creates a new metadata transfer job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMetadataTransferJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMetadataTransferJobRequest'
      tags:
      - Operations
  /metadata-transfer-jobs/{metadataTransferJobId}:
    get:
      operationId: GetMetadataTransferJob
      summary: Get Metadata Transfer Job
      description: Gets a nmetadata transfer job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetadataTransferJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMetadataTransferJobRequest'
      tags:
      - Operations
  /workspaces/{workspaceId}/entities/{entityId}/components-list:
    post:
      operationId: ListComponents
      summary: List Components
      description: This API lists the components of an entity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComponentsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListComponentsRequest'
      tags:
      - Operations
  /metadata-transfer-jobs-list:
    post:
      operationId: ListMetadataTransferJobs
      summary: List Metadata Transfer Jobs
      description: Lists the metadata transfer jobs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMetadataTransferJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMetadataTransferJobsRequest'
      tags:
      - Operations
  /workspaces/{workspaceId}/properties-list:
    post:
      operationId: ListProperties
      summary: List Properties
      description: This API lists the properties of a component.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPropertiesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListPropertiesRequest'
      tags:
      - Operations
components:
  schemas:
    Status:
      type: object
      properties:
        state:
          type: string
          description: The current state of the entity, component, component type, or workspace.
        error:
          $ref: '#/components/schemas/ErrorDetails'
    CancelMetadataTransferJobResponse:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
        arn:
          type: string
          description: The metadata transfer job ARN.
        updateDateTime:
          type: string
          format: date-time
          description: Used to update the DateTime property.
        status:
          $ref: '#/components/schemas/MetadataTransferJobStatus'
        progress:
          $ref: '#/components/schemas/MetadataTransferJobProgress'
      required:
      - metadataTransferJobId
      - arn
      - updateDateTime
      - status
    ListMetadataTransferJobsRequest:
      type: object
      properties:
        sourceType:
          type: string
          description: The metadata transfer job's source type.
        destinationType:
          type: string
          description: The metadata transfer job's destination type.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ListMetadataTransferJobsFilter'
          description: An object that filters metadata transfer jobs.
        nextToken:
          type: string
          description: The string that specifies the next page of results.
        maxResults:
          type: integer
          description: The maximum number of results to return at one time.
      required:
      - sourceType
      - destinationType
    PropertyDefinitionResponse:
      type: object
      properties:
        dataType:
          $ref: '#/components/schemas/DataType'
        isTimeSeries:
          type: boolean
          description: A Boolean value that specifies whether the property consists of time series data.
        isRequiredInEntity:
          type: boolean
          description: A Boolean value that specifies whether the property is required in an entity.
        isExternalId:
          type: boolean
          description: A Boolean value that specifies whether the property ID comes from an external data store.
        isStoredExternally:
          type: boolean
          description: A Boolean value that specifies whether the property is stored externally.
        isImported:
          type: boolean
          description: A Boolean value that specifies whether the property definition is imported from an external data store.
        isFinal:
          type: boolean
          description: A Boolean value that specifies whether the property definition can be updated.
        isInherited:
          type: boolean
          description: A Boolean value that specifies whether the property definition is inherited from a parent entity.
        defaultValue:
          $ref: '#/components/schemas/DataValue'
        configuration:
          type: object
          additionalProperties:
            type: string
          description: A mapping that specifies configuration information about the property.
        displayName:
          type: string
          description: A friendly name for the property.
      required:
      - dataType
      - isTimeSeries
      - isRequiredInEntity
      - isExternalId
      - isStoredExternally
      - isImported
      - isFinal
      - isInherited
    CreateMetadataTransferJobResponse:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
        arn:
          type: string
          description: The metadata transfer job ARN.
        creationDateTime:
          type: string
          format: date-time
          description: The The metadata transfer job creation DateTime property.
        status:
          $ref: '#/components/schemas/MetadataTransferJobStatus'
      required:
      - metadataTransferJobId
      - arn
      - creationDateTime
      - status
    CancelMetadataTransferJobRequest:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
      required:
      - metadataTransferJobId
    DataType:
      type: object
      properties:
        type:
          type: string
          description: The underlying type of the data type.
        nestedType:
          $ref: '#/components/schemas/DataType'
        allowedValues:
          type: array
          items:
            $ref: '#/components/schemas/DataValue'
          description: The allowed values for this data type.
        unitOfMeasure:
          type: string
          description: The unit of measure used in this data type.
        relationship:
          $ref: '#/components/schemas/Relationship'
      required:
      - type
    FilterByAsset:
      type: object
      properties:
        assetId:
          type: string
          description: Filter by asset Id.
        assetExternalId:
          type: string
          description: The external-Id property of an asset.
        includeOffspring:
          type: boolean
          description: Includes sub-assets.[need description hekp for this]
        includeAssetModel:
          type: boolean
          description: Boolean to include the asset model.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    Relationship:
      type: object
      properties:
        targetComponentTypeId:
          type: string
          description: The ID of the target component type associated with this relationship.
        relationshipType:
          type: string
          description: The type of the relationship.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    MetadataTransferJobSummary:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job summary Id.
        arn:
          type: string
          description: The metadata transfer job summary ARN.
        creationDateTime:
          type: string
          format: date-time
          description: The metadata transfer job summary creation DateTime object.
        updateDateTime:
          type: string
          format: date-time
          description: The metadata transfer job summary update DateTime object
        status:
          $ref: '#/components/schemas/MetadataTransferJobStatus'
        progress:
          $ref: '#/components/schemas/MetadataTransferJobProgress'
      required:
      - metadataTransferJobId
      - arn
      - creationDateTime
      - updateDateTime
      - status
    IotSiteWiseSourceConfigurationFilter:
      type: object
      properties:
        filterByAssetModel:
          $ref: '#/components/schemas/FilterByAssetModel'
        filterByAsset:
          $ref: '#/components/schemas/FilterByAsset'
      description: Exactly one member is set.
    FilterByAssetModel:
      type: object
      properties:
        assetModelId:
          type: string
          description: The asset model Id.
        assetModelExternalId:
          type: string
          description: The external-Id property of an asset model.
        includeOffspring:
          type: boolean
          description: Include asset offspring. [need desc.]
        includeAssets:
          type: boolean
          description: Bolean to include assets.
    DestinationConfiguration:
      type: object
      properties:
        type:
          type: string
          description: The destination type.
        s3Configuration:
          $ref: '#/components/schemas/S3DestinationConfiguration'
        iotTwinMakerConfiguration:
          $ref: '#/components/schemas/IotTwinMakerDestinationConfiguration'
      required:
      - type
    ConflictException:
      type: object
      properties:
        message:
          type: string
    IotSiteWiseSourceConfiguration:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/IotSiteWiseSourceConfigurationFilter'
          description: The AWS IoT SiteWise soucre configuration filters.
    FilterByComponentType:
      type: object
      properties:
        componentTypeId:
          type: string
          description: The component type Id.
      required:
      - componentTypeId
    ListComponentsRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The workspace ID.
        entityId:
          type: string
          description: The ID for the entity whose metadata (component/properties) is returned by the operation.
        componentPath:
          type: string
          description: This string specifies the path to the composite component, starting from the top-level component.
        maxResults:
          type: integer
          description: The maximum number of results returned at one time. The default is 25.
        nextToken:
          type: string
          description: The string that specifies the next page of results.
      required:
      - workspaceId
      - entityId
    ListComponentsResponse:
      type: object
      properties:
        componentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ComponentSummary'
          description: A list of objects that contain information about the components.
        nextToken:
          type: string
          description: The string that specifies the next page of component results.
      required:
      - componentSummaries
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    GetMetadataTransferJobResponse:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
        arn:
          type: string
          description: The metadata transfer job ARN.
        description:
          type: string
          description: The metadata transfer job description.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceConfiguration'
          description: The metadata transfer job's sources.
        destination:
          $ref: '#/components/schemas/DestinationConfiguration'
        metadataTransferJobRole:
          type: string
          description: The metadata transfer job's role.
        reportUrl:
          type: string
          description: The metadata transfer job's report URL.
        creationDateTime:
          type: string
          format: date-time
          description: The metadata transfer job's creation DateTime property.
        updateDateTime:
          type: string
          format: date-time
          description: The metadata transfer job's update DateTime property.
        status:
          $ref: '#/components/schemas/MetadataTransferJobStatus'
        progress:
          $ref: '#/components/schemas/MetadataTransferJobProgress'
      required:
      - metadataTransferJobId
      - arn
      - sources
      - destination
      - metadataTransferJobRole
      - creationDateTime
      - updateDateTime
      - status
    PropertySummary:
      type: object
      properties:
        definition:
          $ref: '#/components/schemas/PropertyDefinitionResponse'
        propertyName:
          type: string
          description: This is the name of the property.
        value:
          $ref: '#/components/schemas/DataValue'
        areAllPropertyValuesReturned:
          type: boolean
          description: This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
      required:
      - propertyName
    ComponentSummary:
      type: object
      properties:
        componentName:
          type: string
          description: The name of the component.
        componentTypeId:
          type: string
          description: The ID of the component type.
        definedIn:
          type: string
          description: The name of the property definition set in the request.
        description:
          type: string
          description: The description of the component request.
        propertyGroups:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ComponentPropertyGroupResponse'
          description: The property groups.
        status:
          $ref: '#/components/schemas/Status'
        syncSource:
          type: string
          description: The syncSource of the sync job, if this entity was created by a sync job.
        componentPath:
          type: string
          description: This string specifies the path to the composite component, starting from the top-level component.
      required:
      - componentName
      - componentTypeId
      - status
    ListPropertiesRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The workspace ID.
        componentName:
          type: string
          description: The name of the component whose properties are returned by the operation.
        componentPath:
          type: string
          description: This string specifies the path to the composite component, starting from the top-level component.
        entityId:
          type: string
          description: The ID for the entity whose metadata (component/properties) is returned by the operation.
        maxResults:
          type: integer
          description: The maximum number of results returned at one time. The default is 25.
        nextToken:
          type: string
          description: The string that specifies the next page of results.
      required:
      - workspaceId
      - entityId
    ListMetadataTransferJobsFilter:
      type: object
      properties:
        workspaceId:
          type: string
          description: The workspace Id.
        state:
          type: string
          description: The filter state.
      description: Exactly one member is set.
    MetadataTransferJobProgress:
      type: object
      properties:
        totalCount:
          type: integer
          description: The total count. [of what]
        succeededCount:
          type: integer
          description: The succeeded count.
        skippedCount:
          type: integer
          description: The skipped count.
        failedCount:
          type: integer
          description: The failed count.
    IotTwinMakerDestinationConfiguration:
      type: object
      properties:
        workspace:
          type: string
          description: The IoT TwinMaker workspace.
      required:
      - workspace
    ComponentPropertyGroupResponse:
      type: object
      properties:
        groupType:
          type: string
          description: The group type.
        propertyNames:
          type: array
          items:
            type: string
          description: The names of properties
        isInherited:
          type: boolean
          description: A Boolean value that specifies whether the property group is inherited from a parent entity
      required:
      - groupType
      - propertyNames
      - isInherited
    ValidationException:
      type: object
      properties:
        message:
          type: string
    S3SourceConfiguration:
      type: object
      properties:
        location:
          type: string
          description: The S3 destination source configuration location.
      required:
      - location
    DataValue:
      type: object
      properties:
        booleanValue:
          type: boolean
          description: A Boolean value.
        doubleValue:
          type: number
          description: A double value.
        integerValue:
          type: integer
          description: An integer value.
        longValue:
          type: integer
          description: A long value.
        stringValue:
          type: string
          description: A string value.
        listValue:
          type: array
          items:
            $ref: '#/components/schemas/DataValue'
          description: A list of multiple values.
        mapValue:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataValue'
          description: An object that maps strings to multiple DataValue objects.
        relationshipValue:
          $ref: '#/components/schemas/RelationshipValue'
        expression:
          type: string
          description: An expression that produces the value.
    RelationshipValue:
      type: object
      properties:
        targetEntityId:
          type: string
          description: The ID of the target entity associated with this relationship value.
        targetComponentName:
          type: string
          description: The name of the target component associated with the relationship value.
    ListPropertiesResponse:
      type: object
      properties:
        propertySummaries:
          type: array
          items:
            $ref: '#/components/schemas/PropertySummary'
          description: A list of objects that contain information about the properties.
        nextToken:
          type: string
          description: The string that specifies the next page of property results.
      required:
      - propertySummaries
    MetadataTransferJobStatus:
      type: object
      properties:
        state:
          type: string
          description: The metadata transfer job state.
        error:
          $ref: '#/components/schemas/ErrorDetails'
        queuedPosition:
          type: integer
          description: The queued position.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    IotTwinMakerSourceConfigurationFilter:
      type: object
      properties:
        filterByComponentType:
          $ref: '#/components/schemas/FilterByComponentType'
        filterByEntity:
          $ref: '#/components/schemas/FilterByEntity'
      description: Exactly one member is set.
    SourceConfiguration:
      type: object
      properties:
        type:
          type: string
          description: The source configuration type.
        s3Configuration:
          $ref: '#/components/schemas/S3SourceConfiguration'
        iotSiteWiseConfiguration:
          $ref: '#/components/schemas/IotSiteWiseSourceConfiguration'
        iotTwinMakerConfiguration:
          $ref: '#/components/schemas/IotTwinMakerSourceConfiguration'
      required:
      - type
    IotTwinMakerSourceConfiguration:
      type: object
      properties:
        workspace:
          type: string
          description: The IoT TwinMaker workspace.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/IotTwinMakerSourceConfigurationFilter'
          description: The metadata transfer job AWS IoT TwinMaker source configuration filters.
      required:
      - workspace
    CreateMetadataTransferJobRequest:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
        description:
          type: string
          description: The metadata transfer job description.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceConfiguration'
          description: The metadata transfer job sources.
        destination:
          $ref: '#/components/schemas/DestinationConfiguration'
      required:
      - sources
      - destination
    FilterByEntity:
      type: object
      properties:
        entityId:
          type: string
          description: The entity Id.
      required:
      - entityId
    ErrorDetails:
      type: object
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
    GetMetadataTransferJobRequest:
      type: object
      properties:
        metadataTransferJobId:
          type: string
          description: The metadata transfer job Id.
      required:
      - metadataTransferJobId
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    S3DestinationConfiguration:
      type: object
      properties:
        location:
          type: string
          description: The S3 destination configuration location.
      required:
      - location
    ListMetadataTransferJobsResponse:
      type: object
      properties:
        metadataTransferJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/MetadataTransferJobSummary'
          description: The metadata transfer job summaries.
        nextToken:
          type: string
          description: The string that specifies the next page of results.
      required:
      - metadataTransferJobSummaries
  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: iottwinmaker
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iottwinmaker/service/2021-11-29/iottwinmaker-2021-11-29.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)