Amazon Config #X Amz Target=StarlingDoveService.GetAggregateConformancePackComplianceSummary 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.GetAggregateConformancePackComplianceSummary 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.GetAggregateConformancePackComplianceSummary'
paths:
  /#X-Amz-Target=StarlingDoveService.GetAggregateConformancePackComplianceSummary:
    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: GetAggregateConformancePackComplianceSummary
      description: <p>Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.</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/GetAggregateConformancePackComplianceSummaryResponse'
              examples:
                GetAggregateConformancePackComplianceSummary200Example:
                  summary: Default GetAggregateConformancePackComplianceSummary 200
                  x-microcks-default: true
                  value:
                    AggregateConformancePackComplianceSummaries: example
                    GroupByKey: example
                    NextToken: example
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                GetAggregateConformancePackComplianceSummary480Example:
                  summary: Default GetAggregateConformancePackComplianceSummary 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                GetAggregateConformancePackComplianceSummary481Example:
                  summary: Default GetAggregateConformancePackComplianceSummary 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                GetAggregateConformancePackComplianceSummary482Example:
                  summary: Default GetAggregateConformancePackComplianceSummary 482
                  x-microcks-default: true
                  value: example
        '483':
          description: NoSuchConfigurationAggregatorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigurationAggregatorException'
              examples:
                GetAggregateConformancePackComplianceSummary483Example:
                  summary: Default GetAggregateConformancePackComplianceSummary 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAggregateConformancePackComplianceSummaryRequest'
      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.GetAggregateConformancePackComplianceSummary
      summary: Amazon Config Get Aggregate Conformance Pack Compliance Summary
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.GetAggregateConformancePackComplianceSummary'
components:
  schemas:
    NoSuchConfigurationAggregatorException: {}
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    GetAggregateConformancePackComplianceSummaryRequest:
      type: object
      required:
      - ConfigurationAggregatorName
      title: GetAggregateConformancePackComplianceSummaryRequest
      properties:
        ConfigurationAggregatorName:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorName'
          - description: The name of the configuration aggregator.
        Filters:
          allOf:
          - $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryFilters'
          - description: Filters the results based on the <code>AggregateConformancePackComplianceSummaryFilters</code> object.
        GroupByKey:
          allOf:
          - $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryGroupKey'
          - description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of results returned on each page. The default is maximum. 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.
    AggregateConformancePackComplianceSummary:
      type: object
      properties:
        ComplianceSummary:
          allOf:
          - $ref: '#/components/schemas/AggregateConformancePackComplianceCount'
          - description: 'Returns an <code>AggregateConformancePackComplianceCount</code> object. '
        GroupName:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
      description: 'Provides a summary of compliance based on either account ID or region. '
    Integer:
      type: integer
    InvalidNextTokenException: {}
    AggregateConformancePackComplianceSummaryGroupKey:
      type: string
      enum:
      - ACCOUNT_ID
      - AWS_REGION
    Limit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidLimitException: {}
    AggregateConformancePackComplianceSummaryFilters:
      type: object
      properties:
        AccountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: The 12-digit Amazon Web Services account ID of the source account.
        AwsRegion:
          allOf:
          - $ref: '#/components/schemas/AwsRegion'
          - description: The source Amazon Web Services Region from where the data is aggregated.
      description: 'Filters the results based on account ID and region. '
    ConfigurationAggregatorName:
      type: string
      pattern: '[\w\-]+'
      minLength: 1
      maxLength: 256
    AggregateConformancePackComplianceCount:
      type: object
      properties:
        CompliantConformancePackCount:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Number of compliant conformance packs.
        NonCompliantConformancePackCount:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Number of noncompliant conformance packs.
      description: The number of conformance packs that are compliant and noncompliant.
    GetAggregateConformancePackComplianceSummaryResponse:
      type: object
      properties:
        AggregateConformancePackComplianceSummaries:
          allOf:
          - $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryList'
          - description: Returns a list of <code>AggregateConformancePackComplianceSummary</code> object.
        GroupByKey:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
        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.
    AccountId:
      type: string
      pattern: \d{12}
    AggregateConformancePackComplianceSummaryList:
      type: array
      items:
        $ref: '#/components/schemas/AggregateConformancePackComplianceSummary'
    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