Amazon Firewall Manager Compliance API

Compliance status and violations

GitHub OpenAPI
Business capability
Security Strategy & Governance Management BC-620.10

Operations 1

POST /#GetComplianceDetail Get Compliance Detail #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-firewall-manager:amazon-firewall-manager-compliance-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.

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

OpenAPI Specification

amazon-firewall-manager-compliance-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Firewall Management Service Compliance API
  version: '2018-01-01'
  description: Generated from AWS's published Smithy model for Firewall Management Service. 1 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://fms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#GetComplianceDetail:
    post:
      operationId: GetComplianceDetail
      summary: Get Compliance Detail
      description: Returns detailed compliance information about the specified member account. Details include resources that
        are in and out of compliance with the specified policy. The reasons for resources being considered compliant depend
        on the Firewall Manager policy type.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetComplianceDetailResponse'
        '400':
          description: InternalErrorException; InvalidInputException; InvalidOperationException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSFMS_20180101.GetComplianceDetail
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetComplianceDetailRequest'
      tags:
      - Compliance
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: fms
  schemas:
    ComplianceViolator:
      type: object
      properties:
        ResourceId:
          type: string
          description: The resource ID.
        ViolationReason:
          type: string
          enum:
          - WEB_ACL_MISSING_RULE_GROUP
          - RESOURCE_MISSING_WEB_ACL
          - RESOURCE_INCORRECT_WEB_ACL
          - RESOURCE_MISSING_SHIELD_PROTECTION
          - RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION
          - RESOURCE_MISSING_SECURITY_GROUP
          - RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP
          - SECURITY_GROUP_UNUSED
          - SECURITY_GROUP_REDUNDANT
          - FMS_CREATED_SECURITY_GROUP_EDITED
          - MISSING_FIREWALL
          - MISSING_FIREWALL_SUBNET_IN_AZ
          - MISSING_EXPECTED_ROUTE_TABLE
          - NETWORK_FIREWALL_POLICY_MODIFIED
          - FIREWALL_SUBNET_IS_OUT_OF_SCOPE
          - INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE
          - FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE
          - UNEXPECTED_FIREWALL_ROUTES
          - UNEXPECTED_TARGET_GATEWAY_ROUTES
          - TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY
          - INVALID_ROUTE_CONFIGURATION
          - MISSING_TARGET_GATEWAY
          - INTERNET_TRAFFIC_NOT_INSPECTED
          - BLACK_HOLE_ROUTE_DETECTED
          - BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET
          - RESOURCE_MISSING_DNS_FIREWALL
          - ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT
          - FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT
          - INVALID_NETWORK_ACL_ENTRY
          - WEB_ACL_CONFIGURATION_OR_SCOPE_OF_USE
          description: The reason that the resource is not protected by the policy.
        ResourceType:
          type: string
          description: 'The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference.
            For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.'
        Metadata:
          type: object
          additionalProperties:
            type: string
          description: Metadata about the resource that doesn't comply with the policy scope.
    GetComplianceDetailRequest:
      type: object
      properties:
        PolicyId:
          type: string
          description: The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by
            ListPolicies.
        MemberAccount:
          type: string
          description: The Amazon Web Services account that owns the resources that you want to get the details for.
      required:
      - PolicyId
      - MemberAccount
    GetComplianceDetailResponse:
      type: object
      properties:
        PolicyComplianceDetail:
          $ref: '#/components/schemas/PolicyComplianceDetail'
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
    PolicyComplianceDetail:
      type: object
      properties:
        PolicyOwner:
          type: string
          description: The Amazon Web Services account that created the Firewall Manager policy.
        PolicyId:
          type: string
          description: The ID of the Firewall Manager policy.
        MemberAccount:
          type: string
          description: The Amazon Web Services account ID.
        Violators:
          type: array
          items:
            $ref: '#/components/schemas/ComplianceViolator'
          description: An array of resources that aren't protected by the WAF or Shield Advanced policy or that aren't in
            compliance with the security group policy.
        EvaluationLimitExceeded:
          type: boolean
          description: Indicates if over 100 resources are noncompliant with the Firewall Manager policy.
        ExpiredAt:
          type: string
          format: date-time
          description: A timestamp that indicates when the returned information should be considered out of date.
        IssueInfoMap:
          type: object
          additionalProperties:
            type: string
          description: Details about problems with dependent services, such as WAF or Config, and the error message received
            that indicates the problem with the service.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/fms/service/2018-01-01/fms-2018-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)