Amazon IoT Events Logging API

openapi: 3.0.0
info:
  version: '2018-07-27'
  x-release: v4
  title: AWS IoT Events Alarm Models Logging 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: Logging
paths:
  /logging:
    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'
    get:
      operationId: DescribeLoggingOptions
      description: Retrieves the current settings of the AWS IoT Events logging options.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeLoggingOptionsResponse'
        '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: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '485':
          description: UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationException'
      parameters: []
      summary: Amazon IoT Events Describe Logging Options
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Logging
    put:
      operationId: PutLoggingOptions
      description: <p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.</p>
      responses:
        '200':
          description: Success
        '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: UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationException'
        '485':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - loggingOptions
              properties:
                loggingOptions:
                  description: The values of the AWS IoT Events logging options.
                  type: object
                  properties:
                    roleArn:
                      allOf:
                      - $ref: '#/components/schemas/AmazonResourceName'
                      - description: The ARN of the role that grants permission to AWS IoT Events to perform logging.
                    level:
                      allOf:
                      - $ref: '#/components/schemas/LoggingLevel'
                      - description: The logging level.
                    enabled:
                      allOf:
                      - $ref: '#/components/schemas/LoggingEnabled'
                      - description: If TRUE, logging is enabled for AWS IoT Events.
                    detectorDebugOptions:
                      allOf:
                      - $ref: '#/components/schemas/DetectorDebugOptions'
                      - description: Information that identifies those detector models and their detectors (instances) for which the logging level is given.
      summary: Amazon IoT Events Put Logging Options
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Logging
components:
  schemas:
    ResourceInUseException: {}
    InternalFailureException: {}
    DetectorModelName:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      minLength: 1
      maxLength: 128
    DetectorDebugOptions:
      type: array
      items:
        $ref: '#/components/schemas/DetectorDebugOption'
      minItems: 1
    DescribeLoggingOptionsResponse:
      type: object
      properties:
        loggingOptions:
          allOf:
          - $ref: '#/components/schemas/LoggingOptions'
          - description: The current settings of the AWS IoT Events logging options.
    DetectorDebugOption:
      type: object
      required:
      - detectorModelName
      properties:
        detectorModelName:
          allOf:
          - $ref: '#/components/schemas/DetectorModelName'
          - description: The name of the detector model.
        keyValue:
          allOf:
          - $ref: '#/components/schemas/KeyValue'
          - description: The value of the input attribute key used to create the detector (the instance of the detector model).
      description: The detector model and the specific detectors (instances) for which the logging level is given.
    AmazonResourceName:
      type: string
      minLength: 1
      maxLength: 2048
    LoggingLevel:
      type: string
      enum:
      - ERROR
      - INFO
      - DEBUG
    InvalidRequestException: {}
    UnsupportedOperationException: {}
    ServiceUnavailableException: {}
    KeyValue:
      type: string
      pattern: ^[a-zA-Z0-9\-_:]+$
      minLength: 1
      maxLength: 128
    LoggingEnabled:
      type: boolean
    ThrottlingException: {}
    LoggingOptions:
      type: object
      required:
      - roleArn
      - level
      - enabled
      properties:
        roleArn:
          allOf:
          - $ref: '#/components/schemas/AmazonResourceName'
          - description: The ARN of the role that grants permission to AWS IoT Events to perform logging.
        level:
          allOf:
          - $ref: '#/components/schemas/LoggingLevel'
          - description: The logging level.
        enabled:
          allOf:
          - $ref: '#/components/schemas/LoggingEnabled'
          - description: If TRUE, logging is enabled for AWS IoT Events.
        detectorDebugOptions:
          allOf:
          - $ref: '#/components/schemas/DetectorDebugOptions'
          - description: Information that identifies those detector models and their detectors (instances) for which the logging level is given.
      description: The values of the AWS IoT Events logging options.
    ResourceNotFoundException: {}
  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
  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