Amazon Config #X Amz Target=StarlingDoveService.GetAggregateConfigRuleComplianceSummary 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.GetAggregateConfigRuleComplianceSummary 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.GetAggregateConfigRuleComplianceSummary'
paths:
  /#X-Amz-Target=StarlingDoveService.GetAggregateConfigRuleComplianceSummary:
    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: GetAggregateConfigRuleComplianceSummary
      description: <p>Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.</p> <note> <p>The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAggregateConfigRuleComplianceSummaryResponse'
              examples:
                GetAggregateConfigRuleComplianceSummary200Example:
                  summary: Default GetAggregateConfigRuleComplianceSummary 200
                  x-microcks-default: true
                  value:
                    GroupByKey: example
                    AggregateComplianceCounts: example
                    NextToken: example
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                GetAggregateConfigRuleComplianceSummary480Example:
                  summary: Default GetAggregateConfigRuleComplianceSummary 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                GetAggregateConfigRuleComplianceSummary481Example:
                  summary: Default GetAggregateConfigRuleComplianceSummary 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                GetAggregateConfigRuleComplianceSummary482Example:
                  summary: Default GetAggregateConfigRuleComplianceSummary 482
                  x-microcks-default: true
                  value: example
        '483':
          description: NoSuchConfigurationAggregatorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigurationAggregatorException'
              examples:
                GetAggregateConfigRuleComplianceSummary483Example:
                  summary: Default GetAggregateConfigRuleComplianceSummary 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAggregateConfigRuleComplianceSummaryRequest'
      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.GetAggregateConfigRuleComplianceSummary
      summary: Amazon Config Get Aggregate Config Rule Compliance Summary
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.GetAggregateConfigRuleComplianceSummary'
components:
  schemas:
    NoSuchConfigurationAggregatorException: {}
    ConfigRuleComplianceSummaryGroupKey:
      type: string
      enum:
      - ACCOUNT_ID
      - AWS_REGION
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    GroupByAPILimit:
      type: integer
      minimum: 0
      maximum: 1000
    Date:
      type: string
      format: date-time
    GetAggregateConfigRuleComplianceSummaryResponse:
      type: object
      properties:
        GroupByKey:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Groups the result based on ACCOUNT_ID or AWS_REGION.
        AggregateComplianceCounts:
          allOf:
          - $ref: '#/components/schemas/AggregateComplianceCountList'
          - description: Returns a list of AggregateComplianceCounts object.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.
    ConfigRuleComplianceSummaryFilters:
      type: object
      properties:
        AccountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: The 12-digit account ID of the source account.
        AwsRegion:
          allOf:
          - $ref: '#/components/schemas/AwsRegion'
          - description: The source region where the data is aggregated.
      description: Filters the results based on the account IDs and regions.
    GetAggregateConfigRuleComplianceSummaryRequest:
      type: object
      required:
      - ConfigurationAggregatorName
      title: GetAggregateConfigRuleComplianceSummaryRequest
      properties:
        ConfigurationAggregatorName:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorName'
          - description: The name of the configuration aggregator.
        Filters:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleComplianceSummaryFilters'
          - description: Filters the results based on the ConfigRuleComplianceSummaryFilters object.
        GroupByKey:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleComplianceSummaryGroupKey'
          - description: Groups the result based on ACCOUNT_ID or AWS_REGION.
        Limit:
          allOf:
          - $ref: '#/components/schemas/GroupByAPILimit'
          - description: The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.
    ComplianceSummary:
      type: object
      properties:
        CompliantResourceCount:
          allOf:
          - $ref: '#/components/schemas/ComplianceContributorCount'
          - description: The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
        NonCompliantResourceCount:
          allOf:
          - $ref: '#/components/schemas/ComplianceContributorCount'
          - description: The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
        ComplianceSummaryTimestamp:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time that Config created the compliance summary.
      description: The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.
    Integer:
      type: integer
    InvalidNextTokenException: {}
    AggregateComplianceCountList:
      type: array
      items:
        $ref: '#/components/schemas/AggregateComplianceCount'
    InvalidLimitException: {}
    ComplianceContributorCount:
      type: object
      properties:
        CappedCount:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
        CapExceeded:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether the maximum count is reached.
      description: The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.
    ConfigurationAggregatorName:
      type: string
      pattern: '[\w\-]+'
      minLength: 1
      maxLength: 256
    Boolean:
      type: boolean
    AccountId:
      type: string
      pattern: \d{12}
    AggregateComplianceCount:
      type: object
      properties:
        GroupName:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: The 12-digit account ID or region based on the GroupByKey value.
        ComplianceSummary:
          allOf:
          - $ref: '#/components/schemas/ComplianceSummary'
          - description: The number of compliant and noncompliant Config rules.
      description: Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
    AwsRegion:
      type: string
      minLength: 1
      maxLength: 64
    NextToken:
      type: string
    ValidationException: {}
  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