Amazon Config #X Amz Target=StarlingDoveService.GetComplianceDetailsByConfigRule 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.GetComplianceDetailsByConfigRule 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.GetComplianceDetailsByConfigRule'
paths:
  /#X-Amz-Target=StarlingDoveService.GetComplianceDetailsByConfigRule:
    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: GetComplianceDetailsByConfigRule
      description: Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComplianceDetailsByConfigRuleResponse'
              examples:
                GetComplianceDetailsByConfigRule200Example:
                  summary: Default GetComplianceDetailsByConfigRule 200
                  x-microcks-default: true
                  value:
                    EvaluationResults: example
                    NextToken: example
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                GetComplianceDetailsByConfigRule480Example:
                  summary: Default GetComplianceDetailsByConfigRule 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                GetComplianceDetailsByConfigRule481Example:
                  summary: Default GetComplianceDetailsByConfigRule 481
                  x-microcks-default: true
                  value: example
        '482':
          description: NoSuchConfigRuleException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigRuleException'
              examples:
                GetComplianceDetailsByConfigRule482Example:
                  summary: Default GetComplianceDetailsByConfigRule 482
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetComplianceDetailsByConfigRuleRequest'
      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.GetComplianceDetailsByConfigRule
      summary: Amazon Config Get Compliance Details by Config Rule
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.GetComplianceDetailsByConfigRule'
components:
  schemas:
    BaseResourceId:
      type: string
      minLength: 1
      maxLength: 768
    ComplianceTypes:
      type: array
      items:
        $ref: '#/components/schemas/ComplianceType'
      minItems: 0
      maxItems: 3
    StringWithCharLimit64:
      type: string
      minLength: 1
      maxLength: 64
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    EvaluationResultIdentifier:
      type: object
      properties:
        EvaluationResultQualifier:
          allOf:
          - $ref: '#/components/schemas/EvaluationResultQualifier'
          - description: Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
        OrderingTimestamp:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
        ResourceEvaluationId:
          allOf:
          - $ref: '#/components/schemas/ResourceEvaluationId'
          - description: A Unique ID for an evaluation result.
      description: Uniquely identifies an evaluation result.
    GetComplianceDetailsByConfigRuleResponse:
      type: object
      properties:
        EvaluationResults:
          allOf:
          - $ref: '#/components/schemas/EvaluationResults'
          - description: Indicates whether the Amazon Web Services resource complies with the specified Config rule.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The string that you use in a subsequent request to get the next page of results in a paginated response.
      description: <p/>
    Date:
      type: string
      format: date-time
    InvalidNextTokenException: {}
    InvalidParameterValueException: {}
    Limit:
      type: integer
      minimum: 0
      maximum: 100
    ComplianceType:
      type: string
      enum:
      - COMPLIANT
      - NON_COMPLIANT
      - NOT_APPLICABLE
      - INSUFFICIENT_DATA
    EvaluationResults:
      type: array
      items:
        $ref: '#/components/schemas/EvaluationResult'
    ConfigRuleName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 128
    GetComplianceDetailsByConfigRuleRequest:
      type: object
      required:
      - ConfigRuleName
      title: GetComplianceDetailsByConfigRuleRequest
      properties:
        ConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit64'
          - description: The name of the Config rule for which you want compliance information.
        ComplianceTypes:
          allOf:
          - $ref: '#/components/schemas/ComplianceTypes'
          - description: <p>Filters the results by compliance.</p> <p> <code>INSUFFICIENT_DATA</code> is a valid <code>ComplianceType</code> that is returned when an Config rule cannot be evaluated. However, <code>INSUFFICIENT_DATA</code> cannot be used as a <code>ComplianceType</code> for filtering results.</p>
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. 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.
      description: <p/>
    NoSuchConfigRuleException: {}
    String:
      type: string
    ResourceEvaluationId:
      type: string
      minLength: 1
      maxLength: 128
    EvaluationMode:
      type: string
      enum:
      - DETECTIVE
      - PROACTIVE
    EvaluationResultQualifier:
      type: object
      properties:
        ConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleName'
          - description: The name of the Config rule that was used in the evaluation.
        ResourceType:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: The type of Amazon Web Services resource that was evaluated.
        ResourceId:
          allOf:
          - $ref: '#/components/schemas/BaseResourceId'
          - description: The ID of the evaluated Amazon Web Services resource.
        EvaluationMode:
          allOf:
          - $ref: '#/components/schemas/EvaluationMode'
          - description: The mode of an evaluation. The valid values are Detective or Proactive.
      description: Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.
    EvaluationResult:
      type: object
      properties:
        EvaluationResultIdentifier:
          allOf:
          - $ref: '#/components/schemas/EvaluationResultIdentifier'
          - description: Uniquely identifies the evaluation result.
        ComplianceType:
          allOf:
          - $ref: '#/components/schemas/ComplianceType'
          - description: <p>Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.</p> <p>For the <code>EvaluationResult</code> data type, Config supports only the <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code> values. Config does not support the <code>INSUFFICIENT_DATA</code> value for the <code>EvaluationResult</code> data type.</p>
        ResultRecordedTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time when Config recorded the evaluation result.
        ConfigRuleInvokedTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time when the Config rule evaluated the Amazon Web Services resource.
        Annotation:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Supplementary information about how the evaluation determined the compliance.
        ResultToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
      description: The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
    NextToken:
      type: string
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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