Amazon IoT Core Iot Core Data API

openapi: 3.1.0
info:
  title: AWS IoT Data API
  version: '2015-05-28'
  description: Generated from AWS's published Smithy model for AWS IoT. 4 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://api.iotwireless.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /wireless-devices/{Id}/data:
    delete:
      operationId: DeleteQueuedMessages
      summary: Delete Queued Messages
      description: Remove queued messages from the downlink queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueuedMessagesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteQueuedMessagesRequest'
      tags:
      - Data
    get:
      operationId: ListQueuedMessages
      summary: List Queued Messages
      description: List queued messages in the downlink queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueuedMessagesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListQueuedMessagesRequest'
      tags:
      - Data
    post:
      operationId: SendDataToWirelessDevice
      summary: Send Data To Wireless Device
      description: Sends a decrypted application data frame to a device.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendDataToWirelessDeviceResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendDataToWirelessDeviceRequest'
      tags:
      - Data
  /multicast-groups/{Id}/data:
    post:
      operationId: SendDataToMulticastGroup
      summary: Send Data To Multicast Group
      description: Sends the specified data to a multicast group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendDataToMulticastGroupResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIotwirelessValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendDataToMulticastGroupRequest'
      tags:
      - Data
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: iotwireless
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ApiIotwirelessConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Id of the resource in the conflicting operation.
        ResourceType:
          type: string
          description: Type of the resource in the conflicting operation.
    ApiIotwirelessInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ApiIotwirelessResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Id of the not found resource.
        ResourceType:
          type: string
          description: Type of the font found resource.
    ApiIotwirelessThrottlingException:
      type: object
      properties:
        Message:
          type: string
    ApiIotwirelessValidationException:
      type: object
      properties:
        Message:
          type: string
    DeleteQueuedMessagesRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of a given wireless device for which downlink messages will be deleted.
        MessageId:
          type: string
          description: If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless
            device ID. Otherwise, the downlink message with the specified message ID will be deleted.
        WirelessDeviceType:
          type: string
          enum:
          - Sidewalk
          - LoRaWAN
          description: The wireless device type, which can be either Sidewalk or LoRaWAN.
      required:
      - Id
      - MessageId
    DeleteQueuedMessagesResponse:
      type: object
      properties: {}
    DownlinkQueueMessage:
      type: object
      properties:
        MessageId:
          type: string
          description: The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.
        TransmitMode:
          type: integer
          description: The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge
            mode) or 1 for AM (acknowledge mode).
        ReceivedAt:
          type: string
          description: The time at which Iot Wireless received the downlink message.
        LoRaWAN:
          $ref: '#/components/schemas/LoRaWANSendDataToDevice'
    GatewayListItem:
      type: object
      properties:
        GatewayId:
          type: string
          description: The ID of the wireless gateways that you want to add to the list of gateways when sending downlink
            messages.
        DownlinkFrequency:
          type: integer
          description: The frequency to use for the gateways when sending a downlink message to the wireless device.
      required:
      - GatewayId
      - DownlinkFrequency
    ListQueuedMessagesRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of a given wireless device which the downlink message packets are being sent.
        NextToken:
          type: string
          description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to
            receive the first set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return in this operation.
        WirelessDeviceType:
          type: string
          enum:
          - Sidewalk
          - LoRaWAN
          description: The wireless device type, whic can be either Sidewalk or LoRaWAN.
      required:
      - Id
    ListQueuedMessagesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to
            receive the first set of results.
        DownlinkQueueMessagesList:
          type: array
          items:
            $ref: '#/components/schemas/DownlinkQueueMessage'
          description: The messages in the downlink queue.
    LoRaWANMulticastMetadata:
      type: object
      properties:
        FPort:
          type: integer
    LoRaWANSendDataToDevice:
      type: object
      properties:
        FPort:
          type: integer
        ParticipatingGateways:
          $ref: '#/components/schemas/ParticipatingGateways'
    MulticastWirelessMetadata:
      type: object
      properties:
        LoRaWAN:
          $ref: '#/components/schemas/LoRaWANMulticastMetadata'
    ParticipatingGateways:
      type: object
      properties:
        DownlinkMode:
          type: string
          enum:
          - SEQUENTIAL
          - CONCURRENT
          - USING_UPLINK_GATEWAY
          description: Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only
            the chosen gateways from the previous uplink message transmission.
        GatewayList:
          type: array
          items:
            $ref: '#/components/schemas/GatewayListItem'
          description: The list of gateways that you want to use for sending the downlink data traffic.
        TransmissionInterval:
          type: integer
          description: The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to
            the next gateway.
      required:
      - DownlinkMode
      - GatewayList
      - TransmissionInterval
    SendDataToMulticastGroupRequest:
      type: object
      properties:
        Id:
          type: string
        PayloadData:
          type: string
        WirelessMetadata:
          $ref: '#/components/schemas/MulticastWirelessMetadata'
      required:
      - Id
      - PayloadData
      - WirelessMetadata
    SendDataToMulticastGroupResponse:
      type: object
      properties:
        MessageId:
          type: string
    SendDataToWirelessDeviceRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the wireless device to receive the data.
        TransmitMode:
          type: integer
          description: 'The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode)
            or 1 for AM (acknowledge mode).'
        PayloadData:
          type: string
        WirelessMetadata:
          $ref: '#/components/schemas/WirelessMetadata'
      required:
      - Id
      - TransmitMode
      - PayloadData
    SendDataToWirelessDeviceResponse:
      type: object
      properties:
        MessageId:
          type: string
          description: The ID of the message sent to the wireless device.
    SidewalkSendDataToDevice:
      type: object
      properties:
        Seq:
          type: integer
          description: The sequence number.
        MessageType:
          type: string
          enum:
          - CUSTOM_COMMAND_ID_NOTIFY
          - CUSTOM_COMMAND_ID_GET
          - CUSTOM_COMMAND_ID_SET
          - CUSTOM_COMMAND_ID_RESP
        AckModeRetryDurationSecs:
          type: integer
          description: The duration of time in seconds to retry sending the ACK.
    WirelessMetadata:
      type: object
      properties:
        LoRaWAN:
          $ref: '#/components/schemas/LoRaWANSendDataToDevice'
        Sidewalk:
          $ref: '#/components/schemas/SidewalkSendDataToDevice'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/iot-wireless/service/2020-11-22/iot-wireless-2020-11-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)