find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-audit-manager:amazon-audit-manager-insights-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Audit Manager Insights API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 6 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://auditmanager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Insights
paths:
  /insights:
    get:
      operationId: GetInsights
      summary: Get Insights
      description: Gets the latest analytics data for all your current active assessments.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInsightsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInsightsRequest'
      tags:
      - Insights
  /insights/assessments/{assessmentId}:
    get:
      operationId: GetInsightsByAssessment
      summary: Get Insights By Assessment
      description: Gets the latest analytics data for a specific active assessment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInsightsByAssessmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInsightsByAssessmentRequest'
      tags:
      - Insights
  /insights/controls-by-assessment:
    get:
      operationId: ListAssessmentControlInsightsByControlDomain
      summary: List Assessment Control Insights By Control Domain
      description: Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssessmentControlInsightsByControlDomainResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssessmentControlInsightsByControlDomainRequest'
      tags:
      - Insights
  /insights/control-domains:
    get:
      operationId: ListControlDomainInsights
      summary: List Control Domain Insights
      description: Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListControlDomainInsightsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListControlDomainInsightsRequest'
      tags:
      - Insights
  /insights/control-domains-by-assessment:
    get:
      operationId: ListControlDomainInsightsByAssessment
      summary: List Control Domain Insights By Assessment
      description: Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListControlDomainInsightsByAssessmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListControlDomainInsightsByAssessmentRequest'
      tags:
      - Insights
  /insights/controls:
    get:
      operationId: ListControlInsightsByControlDomain
      summary: List Control Insights By Control Domain
      description: Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListControlInsightsByControlDomainResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListControlInsightsByControlDomainRequest'
      tags:
      - Insights
components:
  schemas:
    ListControlInsightsByControlDomainResponse:
      type: object
      properties:
        controlInsightsMetadata:
          type: array
          items:
            $ref: '#/components/schemas/ControlInsightsMetadataItem'
          description: The control analytics data that the ListControlInsightsByControlDomain API returned.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    ListControlDomainInsightsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: Represents the maximum number of results on a page or for an API request call.
    ListControlDomainInsightsByAssessmentResponse:
      type: object
      properties:
        controlDomainInsights:
          type: array
          items:
            $ref: '#/components/schemas/ControlDomainInsights'
          description: The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    ControlInsightsMetadataItem:
      type: object
      properties:
        name:
          type: string
          description: The name of the control.
        id:
          type: string
          description: The unique identifier for the control.
        evidenceInsights:
          $ref: '#/components/schemas/EvidenceInsights'
        lastUpdated:
          type: string
          format: date-time
          description: The time when the control insights were last updated.
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation error.
        message:
          type: string
          description: The body of the error message.
      required:
      - name
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The unique identifier for the resource.
        resourceType:
          type: string
          description: The type of resource that's affected by the error.
      required:
      - message
      - resourceId
      - resourceType
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason the request failed validation.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that caused the error, if applicable.
      required:
      - message
    ListControlDomainInsightsResponse:
      type: object
      properties:
        controlDomainInsights:
          type: array
          items:
            $ref: '#/components/schemas/ControlDomainInsights'
          description: The control domain analytics data that the ListControlDomainInsights API returned.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    ListControlDomainInsightsByAssessmentRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the active assessment.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: Represents the maximum number of results on a page or for an API request call.
      required:
      - assessmentId
    GetInsightsByAssessmentRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
      required:
      - assessmentId
    ControlInsightsMetadataByAssessmentItem:
      type: object
      properties:
        name:
          type: string
          description: The name of the assessment control.
        id:
          type: string
          description: The unique identifier for the assessment control.
        evidenceInsights:
          $ref: '#/components/schemas/EvidenceInsights'
        controlSetName:
          type: string
          description: The name of the control set that the assessment control belongs to.
        lastUpdated:
          type: string
          format: date-time
          description: The time when the assessment control insights were last updated.
    Insights:
      type: object
      properties:
        activeAssessmentsCount:
          type: integer
          description: The number of active assessments in Audit Manager.
        noncompliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling.
        compliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling.
        inconclusiveEvidenceCount:
          type: integer
          description: 'The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub CSPM or Config as a data source but you didn''t enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it''s classed as inconclusive in Insights data.'
        assessmentControlsCountByNoncompliantEvidence:
          type: integer
          description: The number of assessment controls that collected non-compliant evidence on the lastUpdated date.
        totalAssessmentControlsCount:
          type: integer
          description: The total number of controls across all active assessments.
        lastUpdated:
          type: string
          format: date-time
          description: The time when the cross-assessment insights were last updated.
    ListAssessmentControlInsightsByControlDomainRequest:
      type: object
      properties:
        controlDomainId:
          type: string
          description: The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.
        assessmentId:
          type: string
          description: The unique identifier for the active assessment.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: Represents the maximum number of results on a page or for an API request call.
      required:
      - controlDomainId
      - assessmentId
    ListAssessmentControlInsightsByControlDomainResponse:
      type: object
      properties:
        controlInsightsByAssessment:
          type: array
          items:
            $ref: '#/components/schemas/ControlInsightsMetadataByAssessmentItem'
          description: The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    GetInsightsResponse:
      type: object
      properties:
        insights:
          $ref: '#/components/schemas/Insights'
    GetInsightsRequest:
      type: object
      properties: {}
    EvidenceInsights:
      type: object
      properties:
        noncompliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling.
        compliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling.
        inconclusiveEvidenceCount:
          type: integer
          description: The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub CSPM or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListControlInsightsByControlDomainRequest:
      type: object
      properties:
        controlDomainId:
          type: string
          description: The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: Represents the maximum number of results on a page or for an API request call.
      required:
      - controlDomainId
    InsightsByAssessment:
      type: object
      properties:
        noncompliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling.
        compliantEvidenceCount:
          type: integer
          description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling.
        inconclusiveEvidenceCount:
          type: integer
          description: The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub CSPM or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.
        assessmentControlsCountByNoncompliantEvidence:
          type: integer
          description: The number of assessment controls that collected non-compliant evidence on the lastUpdated date.
        totalAssessmentControlsCount:
          type: integer
          description: The total number of controls in the assessment.
        lastUpdated:
          type: string
          format: date-time
          description: The time when the assessment insights were last updated.
    GetInsightsByAssessmentResponse:
      type: object
      properties:
        insights:
          $ref: '#/components/schemas/InsightsByAssessment'
    ControlDomainInsights:
      type: object
      properties:
        name:
          type: string
          description: The name of the control domain.
        id:
          type: string
          description: The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.
        controlsCountByNoncompliantEvidence:
          type: integer
          description: The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date.
        totalControlsCount:
          type: integer
          description: The total number of controls in the control domain.
        evidenceInsights:
          $ref: '#/components/schemas/EvidenceInsights'
        lastUpdated:
          type: string
          format: date-time
          description: The time when the control domain insights were last updated.
  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: auditmanager
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/auditmanager/service/2017-07-25/auditmanager-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)