Amazon IoT SiteWise Gateways API

openapi: 3.1.0
info:
  title: AWS IoT SiteWise Gateways API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 7 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: []
paths:
  /20200301/gateways:
    post:
      operationId: CreateGateway
      summary: Create Gateway
      description: Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers
        to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGatewayResponse'
        '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'
        '409':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGatewayRequest'
      tags:
      - Gateways
    get:
      operationId: ListGateways
      summary: List Gateways
      description: Retrieves a paginated list of gateways.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGatewaysResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListGatewaysRequest'
      tags:
      - Gateways
  /20200301/gateways/{gatewayId}:
    delete:
      operationId: DeleteGateway
      summary: Delete Gateway
      description: Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your
        gateway's file system.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteGatewayRequest'
      tags:
      - Gateways
    get:
      operationId: DescribeGateway
      summary: Describe Gateway
      description: Retrieves information about a gateway.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGatewayResponse'
        '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/DescribeGatewayRequest'
      tags:
      - Gateways
    put:
      operationId: UpdateGateway
      summary: Update Gateway
      description: Updates a gateway's name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/UpdateGatewayRequest'
      tags:
      - Gateways
  /20200301/gateways/{gatewayId}/capability/{capabilityNamespace}:
    get:
      operationId: DescribeGatewayCapabilityConfiguration
      summary: Describe Gateway Capability Configuration
      description: 'Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
        . The namespace follows the format service:capability:version, where: service - The service providing the capability,
        or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source
        collector, or publisher for data publisher capability. version - The version number of the capability. Option include
        2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration,
        the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration
        to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations
        with different namespaces.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGatewayCapabilityConfigurationResponse'
        '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/DescribeGatewayCapabilityConfigurationRequest'
      tags:
      - Gateways
  /20200301/gateways/{gatewayId}/capability:
    post:
      operationId: UpdateGatewayCapabilityConfiguration
      summary: Update Gateway Capability Configuration
      description: 'Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability
        defines data sources for a gateway. Important workflow notes: Each gateway capability defines data sources for a gateway.
        This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where:
        service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options
        include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version
        - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled,
        V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes
        the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration
        was applied. A gateway can have multiple capability configurations with different namespaces.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGatewayCapabilityConfigurationResponse'
        '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/UpdateGatewayCapabilityConfigurationRequest'
      tags:
      - Gateways
components:
  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
  schemas:
    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
    CreateGatewayRequest:
      type: object
      properties:
        gatewayName:
          type: string
          description: A unique name for the gateway.
        gatewayPlatform:
          $ref: '#/components/schemas/GatewayPlatform'
        gatewayVersion:
          type: string
          description: The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create
            a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway). When creating
            a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem
            parameter. We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge
            gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging
            your IoT SiteWise resources in the IoT SiteWise User Guide.
      required:
      - gatewayName
      - gatewayPlatform
    CreateGatewayResponse:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.
        gatewayArn:
          type: string
          description: The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
      required:
      - gatewayId
      - gatewayArn
    DeleteGatewayRequest:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway to delete.
      required:
      - gatewayId
    DescribeGatewayCapabilityConfigurationRequest:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway that defines the capability configuration.
        capabilityNamespace:
          type: string
          description: The namespace of the capability configuration. For example, if you configure OPC UA sources for an
            MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
      required:
      - gatewayId
      - capabilityNamespace
    DescribeGatewayCapabilityConfigurationResponse:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway that defines the capability configuration.
        capabilityNamespace:
          type: string
          description: The namespace of the gateway capability.
        capabilityConfiguration:
          type: string
          description: The JSON document that defines the gateway capability's configuration. For more information, see Configuring
            data sources (CLI) in the IoT SiteWise User Guide.
        capabilitySyncStatus:
          type: string
          enum:
          - IN_SYNC
          - OUT_OF_SYNC
          - SYNC_FAILED
          - UNKNOWN
          - NOT_APPLICABLE
          description: 'The synchronization status of the gateway capability configuration. The sync status can be one of
            the following: IN_SYNC - The gateway is running with the latest configuration. OUT_OF_SYNC - The gateway hasn''t
            received the latest configuration. SYNC_FAILED - The gateway rejected the latest configuration. UNKNOWN - The
            gateway hasn''t reported its sync status. NOT_APPLICABLE - The gateway doesn''t support this capability. This
            is most common when integrating partner data sources, because the data integration is handled externally by the
            partner.'
      required:
      - gatewayId
      - capabilityNamespace
      - capabilityConfiguration
      - capabilitySyncStatus
    DescribeGatewayRequest:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway device.
      required:
      - gatewayId
    DescribeGatewayResponse:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway device.
        gatewayName:
          type: string
          description: The name of the gateway.
        gatewayArn:
          type: string
          description: The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
        gatewayPlatform:
          $ref: '#/components/schemas/GatewayPlatform'
        gatewayVersion:
          type: string
          description: The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a
            Classic streams, V2 gateway.
        gatewayCapabilitySummaries:
          type: array
          items:
            $ref: '#/components/schemas/GatewayCapabilitySummary'
          description: A list of gateway capability summaries that each contain a namespace and status. Each gateway capability
            defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
        creationDate:
          type: string
          format: date-time
          description: The date the gateway was created, in Unix epoch time.
        lastUpdateDate:
          type: string
          format: date-time
          description: The date the gateway was last updated, in Unix epoch time.
      required:
      - gatewayId
      - gatewayName
      - gatewayArn
      - gatewayCapabilitySummaries
      - creationDate
      - lastUpdateDate
    GatewayCapabilitySummary:
      type: object
      properties:
        capabilityNamespace:
          type: string
          description: The namespace of the capability configuration. For example, if you configure OPC UA sources for an
            MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
        capabilitySyncStatus:
          type: string
          enum:
          - IN_SYNC
          - OUT_OF_SYNC
          - SYNC_FAILED
          - UNKNOWN
          - NOT_APPLICABLE
          description: 'The synchronization status of the gateway capability configuration. The sync status can be one of
            the following: IN_SYNC - The gateway is running with the latest configuration. OUT_OF_SYNC - The gateway hasn''t
            received the latest configuration. SYNC_FAILED - The gateway rejected the latest configuration. UNKNOWN - The
            gateway hasn''t reported its sync status. NOT_APPLICABLE - The gateway doesn''t support this capability. This
            is most common when integrating partner data sources, because the data integration is handled externally by the
            partner.'
      required:
      - capabilityNamespace
      - capabilitySyncStatus
    GatewayPlatform:
      type: object
      properties:
        greengrass:
          $ref: '#/components/schemas/Greengrass'
        greengrassV2:
          $ref: '#/components/schemas/GreengrassV2'
        siemensIE:
          $ref: '#/components/schemas/SiemensIE'
    GatewaySummary:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway device.
        gatewayName:
          type: string
          description: The name of the gateway.
        gatewayPlatform:
          $ref: '#/components/schemas/GatewayPlatform'
        gatewayVersion:
          type: string
          description: The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a
            Classic streams, V2 gateway.
        gatewayCapabilitySummaries:
          type: array
          items:
            $ref: '#/components/schemas/GatewayCapabilitySummary'
          description: A list of gateway capability summaries that each contain a namespace and status. Each gateway capability
            defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
        creationDate:
          type: string
          format: date-time
          description: The date the gateway was created, in Unix epoch time.
        lastUpdateDate:
          type: string
          format: date-time
          description: The date the gateway was last updated, in Unix epoch time.
      required:
      - gatewayId
      - gatewayName
      - creationDate
      - lastUpdateDate
    Greengrass:
      type: object
      properties:
        groupArn:
          type: string
          description: The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups
            and GetGroup in the IoT Greengrass V1 API Reference.
      required:
      - groupArn
    GreengrassV2:
      type: object
      properties:
        coreDeviceThingName:
          type: string
          description: The name of the IoT thing for your IoT Greengrass V2 core device.
        coreDeviceOperatingSystem:
          type: string
          enum:
          - LINUX_AARCH64
          - LINUX_AMD64
          - WINDOWS_AMD64
          description: The operating system of the core device in IoT Greengrass V2. Specifying the operating system is required
            for MQTT-enabled, V3 gateways (gatewayVersion 3) and not applicable for Classic stream, V2 gateways (gatewayVersion
            2).
      required:
      - coreDeviceThingName
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListGatewaysRequest:
      type: object
      properties:
        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'
    ListGatewaysResponse:
      type: object
      properties:
        gatewaySummaries:
          type: array
          items:
            $ref: '#/components/schemas/GatewaySummary'
          description: A list that summarizes each gateway.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - gatewaySummaries
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that already exists.
        resourceArn:
          type: string
          description: The ARN of the resource that already exists.
      required:
      - message
      - resourceId
      - resourceArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    SiemensIE:
      type: object
      properties:
        iotCoreThingName:
          type: string
          description: The name of the IoT Thing for your SiteWise Edge gateway.
      required:
      - iotCoreThingName
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateGatewayCapabilityConfigurationRequest:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway to be updated.
        capabilityNamespace:
          type: string
          description: The namespace of the gateway capability configuration to be updated. For example, if you configure
            OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
        capabilityConfiguration:
          type: string
          description: The JSON document that defines the configuration for the gateway capability. For more information,
            see Configuring data sources (CLI) in the IoT SiteWise User Guide.
      required:
      - gatewayId
      - capabilityNamespace
      - capabilityConfiguration
    UpdateGatewayCapabilityConfigurationResponse:
      type: object
      properties:
        capabilityNamespace:
          type: string
          description: The namespace of the gateway capability.
        capabilitySyncStatus:
          type: string
          enum:
          - IN_SYNC
          - OUT_OF_SYNC
          - SYNC_FAILED
          - UNKNOWN
          - NOT_APPLICABLE
          description: 'The synchronization status of the gateway capability configuration. The sync status can be one of
            the following: IN_SYNC - The gateway is running with the latest configuration. OUT_OF_SYNC - The gateway hasn''t
            received the latest configuration. SYNC_FAILED - The gateway rejected the latest configuration. UNKNOWN - The
            gateway hasn''t reported its sync status. NOT_APPLICABLE - The gateway doesn''t support this capability. This
            is most common when integrating partner data sources, because the data integration is handled externally by the
            partner. After you update a capability configuration, its sy'
      required:
      - capabilityNamespace
      - capabilitySyncStatus
    UpdateGatewayRequest:
      type: object
      properties:
        gatewayId:
          type: string
          description: The ID of the gateway to update.
        gatewayName:
          type: string
          description: A unique name for the gateway.
      required:
      - gatewayId
      - gatewayName
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)