Amazon Config #X Amz Target=StarlingDoveService.DescribeConformancePackCompliance API

openapi: 3.0.0
info:
  version: '2014-11-12'
  x-release: v4
  title: 'AWS Config #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.DescribeConformancePackCompliance API'
  description: <fullname>Config</fullname> <p>Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p> <p>You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer Guide</i>.</p>
  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: config
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/config-2014-11-12.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://config.{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 Config Service multi-region endpoint
- url: https://config.{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 Config Service multi-region endpoint
- url: http://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
- url: https://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=StarlingDoveService.DescribeConformancePackCompliance'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeConformancePackCompliance:
    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: DescribeConformancePackCompliance
      description: <p>Returns compliance details for each rule in that conformance pack.</p> <note> <p>You must provide exact rule names.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConformancePackComplianceResponse'
              examples:
                DescribeConformancePackCompliance200Example:
                  summary: Default DescribeConformancePackCompliance 200
                  x-microcks-default: true
                  value:
                    ConformancePackName: example
                    ConformancePackRuleComplianceList: example
                    NextToken: example
        '480':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                DescribeConformancePackCompliance480Example:
                  summary: Default DescribeConformancePackCompliance 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                DescribeConformancePackCompliance481Example:
                  summary: Default DescribeConformancePackCompliance 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                DescribeConformancePackCompliance482Example:
                  summary: Default DescribeConformancePackCompliance 482
                  x-microcks-default: true
                  value: example
        '483':
          description: NoSuchConfigRuleInConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigRuleInConformancePackException'
              examples:
                DescribeConformancePackCompliance483Example:
                  summary: Default DescribeConformancePackCompliance 483
                  x-microcks-default: true
                  value: example
        '484':
          description: NoSuchConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConformancePackException'
              examples:
                DescribeConformancePackCompliance484Example:
                  summary: Default DescribeConformancePackCompliance 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConformancePackComplianceRequest'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.DescribeConformancePackCompliance
      summary: Amazon Config Describe Conformance Pack Compliance
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeConformancePackCompliance'
components:
  schemas:
    DescribeConformancePackComplianceResponse:
      type: object
      required:
      - ConformancePackName
      - ConformancePackRuleComplianceList
      properties:
        ConformancePackName:
          allOf:
          - $ref: '#/components/schemas/ConformancePackName'
          - description: Name of the conformance pack.
        ConformancePackRuleComplianceList:
          allOf:
          - $ref: '#/components/schemas/ConformancePackRuleComplianceList'
          - description: Returns a list of <code>ConformancePackRuleCompliance</code> objects.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.
    ConformancePackComplianceFilters:
      type: object
      properties:
        ConfigRuleNames:
          allOf:
          - $ref: '#/components/schemas/ConformancePackConfigRuleNames'
          - description: Filters the results by Config rule names.
        ComplianceType:
          allOf:
          - $ref: '#/components/schemas/ConformancePackComplianceType'
          - description: <p>Filters the results by compliance.</p> <p>The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. <code>INSUFFICIENT_DATA</code> is not supported.</p>
      description: Filters the conformance pack by compliance types and Config rule names.
    ConformancePackRuleCompliance:
      type: object
      properties:
        ConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleName'
          - description: Name of the Config rule.
        ComplianceType:
          allOf:
          - $ref: '#/components/schemas/ConformancePackComplianceType'
          - description: Compliance of the Config rule.
        Controls:
          allOf:
          - $ref: '#/components/schemas/ControlsList'
          - description: Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.
      description: Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.
    StringWithCharLimit64:
      type: string
      minLength: 1
      maxLength: 64
    DescribeConformancePackComplianceRequest:
      type: object
      required:
      - ConformancePackName
      title: DescribeConformancePackComplianceRequest
      properties:
        ConformancePackName:
          allOf:
          - $ref: '#/components/schemas/ConformancePackName'
          - description: Name of the conformance pack.
        Filters:
          allOf:
          - $ref: '#/components/schemas/ConformancePackComplianceFilters'
          - description: A <code>ConformancePackComplianceFilters</code> object.
        Limit:
          allOf:
          - $ref: '#/components/schemas/DescribeConformancePackComplianceLimit'
          - description: The maximum number of Config rules within a conformance pack are returned on each page.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.
    ConformancePackRuleComplianceList:
      type: array
      items:
        $ref: '#/components/schemas/ConformancePackRuleCompliance'
      minItems: 0
      maxItems: 1000
    NoSuchConformancePackException: {}
    NoSuchConfigRuleInConformancePackException: {}
    InvalidNextTokenException: {}
    DescribeConformancePackComplianceLimit:
      type: integer
      minimum: 0
      maximum: 1000
    ControlsList:
      type: array
      items:
        $ref: '#/components/schemas/StringWithCharLimit128'
      minItems: 0
      maxItems: 20
    InvalidParameterValueException: {}
    ConformancePackName:
      type: string
      pattern: '[a-zA-Z][-a-zA-Z0-9]*'
      minLength: 1
      maxLength: 256
    StringWithCharLimit128:
      type: string
      minLength: 1
      maxLength: 128
    InvalidLimitException: {}
    ConfigRuleName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 128
    ConformancePackConfigRuleNames:
      type: array
      items:
        $ref: '#/components/schemas/StringWithCharLimit64'
      minItems: 0
      maxItems: 10
    ConformancePackComplianceType:
      type: string
      enum:
      - COMPLIANT
      - NON_COMPLIANT
      - INSUFFICIENT_DATA
    NextToken:
      type: string
  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/config/
x-hasEquivalentPaths: true