AWS Security Hub Insights API

The Insights API from AWS Security Hub — 4 operation(s) for insights.

OpenAPI Specification

aws-security-hub-insights-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Security Hub Action Targets Insights API
  version: '2018-10-26'
  description: 'AWS Security Hub is a cloud security posture management service that

    aggregates, organizes, and prioritizes security findings from AWS

    services and third-party products. The API exposes REST operations for

    managing security standards, controls, findings, insights, automation

    rules, configuration policies, and member account configuration. All

    requests are signed with AWS Signature Version 4 (SigV4).


    See https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html

    '
servers:
- url: https://securityhub.{region}.amazonaws.com
  description: AWS Security Hub regional endpoint
  variables:
    region:
      default: us-east-1
security:
- SigV4: []
tags:
- name: Insights
paths:
  /insights:
    post:
      tags:
      - Insights
      operationId: CreateInsight
      summary: Create an insight
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /insights/get:
    post:
      tags:
      - Insights
      operationId: GetInsights
      summary: Get insights
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /insights/results/{InsightArn}:
    get:
      tags:
      - Insights
      operationId: GetInsightResults
      summary: Get insight results
      parameters:
      - name: InsightArn
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /insights/{InsightArn}:
    patch:
      tags:
      - Insights
      operationId: UpdateInsight
      summary: Update an insight
      parameters:
      - name: InsightArn
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
    delete:
      tags:
      - Insights
      operationId: DeleteInsight
      summary: Delete an insight
      parameters:
      - name: InsightArn
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header