Amazon IoT Events Input Routings API

openapi: 3.0.0
info:
  version: '2018-07-27'
  x-release: v4
  title: AWS IoT Events Alarm Models Input Routings API
  description: AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
  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: mike.ralphson@gmail.com
    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: iotevents
  x-aws-signingName: iotevents
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotevents-2018-07-27.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
servers:
- url: http://iotevents.{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 Events multi-region endpoint
- url: https://iotevents.{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 Events multi-region endpoint
- url: http://iotevents.{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 Events endpoint for China (Beijing) and China (Ningxia)
- url: https://iotevents.{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 Events endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Input Routings
paths:
  /input-routings:
    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'
    post:
      operationId: ListInputRoutings
      description: ' Lists one or more input routings. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInputRoutingsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '483':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '484':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - inputIdentifier
              properties:
                inputIdentifier:
                  description: ' The identifer of the input. '
                  type: object
                  properties:
                    iotEventsInputIdentifier:
                      allOf:
                      - $ref: '#/components/schemas/IotEventsInputIdentifier'
                      - description: ' The identifier of the input routed to AWS IoT Events. '
                    iotSiteWiseInputIdentifier:
                      allOf:
                      - $ref: '#/components/schemas/IotSiteWiseInputIdentifier'
                      - description: ' The identifer of the input routed from AWS IoT SiteWise. '
                maxResults:
                  description: ' The maximum number of results to be returned per request. '
                  type: integer
                  minimum: 1
                  maximum: 250
                nextToken:
                  description: ' The token that you can use to return the next set of results. '
                  type: string
      summary: Amazon IoT Events List Input Routings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Input Routings
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  schemas:
    RoutedResources:
      type: array
      items:
        $ref: '#/components/schemas/RoutedResource'
    InternalFailureException: {}
    RoutedResource:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: ' The name of the routed resource. '
        arn:
          allOf:
          - $ref: '#/components/schemas/AmazonResourceName'
          - description: ' The ARN of the routed resource. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>. '
      description: ' Contains information about the routed resource. '
    AssetPropertyId:
      type: string
    InputName:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
      minLength: 1
      maxLength: 128
    AmazonResourceName:
      type: string
      minLength: 1
      maxLength: 2048
    IotSiteWiseInputIdentifier:
      type: object
      properties:
        iotSiteWiseAssetModelPropertyIdentifier:
          allOf:
          - $ref: '#/components/schemas/IotSiteWiseAssetModelPropertyIdentifier'
          - description: ' The identifier of the AWS IoT SiteWise asset model property. '
      description: ' The identifer of the input routed from AWS IoT SiteWise. '
    InvalidRequestException: {}
    ServiceUnavailableException: {}
    AssetModelId:
      type: string
    IotEventsInputIdentifier:
      type: object
      required:
      - inputName
      properties:
        inputName:
          allOf:
          - $ref: '#/components/schemas/InputName'
          - description: ' The name of the input routed to AWS IoT Events. '
      description: ' The identifier of the input routed to AWS IoT Events. '
    ResourceName:
      type: string
    IotSiteWiseAssetModelPropertyIdentifier:
      type: object
      required:
      - assetModelId
      - propertyId
      properties:
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/AssetModelId'
          - description: ' The ID of the AWS IoT SiteWise asset model. '
        propertyId:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyId'
          - description: ' The ID of the AWS IoT SiteWise asset property. '
      description: ' The asset model property identifer of the input routed from AWS IoT SiteWise. '
    ListInputRoutingsResponse:
      type: object
      properties:
        routedResources:
          allOf:
          - $ref: '#/components/schemas/RoutedResources'
          - description: ' Summary information about the routed resources. '
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: ' The token that you can use to return the next set of results, or <code>null</code> if there are no more results. '
    ThrottlingException: {}
    ResourceNotFoundException: {}
    NextToken:
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/iotevents/
x-hasEquivalentPaths: true