Amazon Config #X Amz Target=StarlingDoveService.GetConformancePackComplianceDetails 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.GetConformancePackComplianceDetails 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.GetConformancePackComplianceDetails'
paths:
  /#X-Amz-Target=StarlingDoveService.GetConformancePackComplianceDetails:
    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: GetConformancePackComplianceDetails
      description: Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConformancePackComplianceDetailsResponse'
              examples:
                GetConformancePackComplianceDetails200Example:
                  summary: Default GetConformancePackComplianceDetails 200
                  x-microcks-default: true
                  value:
                    ConformancePackName: example
                    ConformancePackRuleEvaluationResults: example
                    NextToken: example
        '480':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                GetConformancePackComplianceDetails480Example:
                  summary: Default GetConformancePackComplianceDetails 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                GetConformancePackComplianceDetails481Example:
                  summary: Default GetConformancePackComplianceDetails 481
                  x-microcks-default: true
                  value: example
        '482':
          description: NoSuchConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConformancePackException'
              examples:
                GetConformancePackComplianceDetails482Example:
                  summary: Default GetConformancePackComplianceDetails 482
                  x-microcks-default: true
                  value: example
        '483':
          description: NoSuchConfigRuleInConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigRuleInConformancePackException'
              examples:
                GetConformancePackComplianceDetails483Example:
                  summary: Default GetConformancePackComplianceDetails 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                GetConformancePackComplianceDetails484Example:
                  summary: Default GetConformancePackComplianceDetails 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConformancePackComplianceDetailsRequest'
      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.GetConformancePackComplianceDetails
      summary: Amazon Config Get Conformance Pack Compliance Details
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.GetConformancePackComplianceDetails'
components:
  schemas:
    BaseResourceId:
      type: string
      minLength: 1
      maxLength: 768
    GetConformancePackComplianceDetailsRequest:
      type: object
      required:
      - ConformancePackName
      title: GetConformancePackComplianceDetailsRequest
      properties:
        ConformancePackName:
          allOf:
          - $ref: '#/components/schemas/ConformancePackName'
          - description: Name of the conformance pack.
        Filters:
          allOf:
          - $ref: '#/components/schemas/ConformancePackEvaluationFilters'
          - description: A <code>ConformancePackEvaluationFilters</code> object.
        Limit:
          allOf:
          - $ref: '#/components/schemas/GetConformancePackComplianceDetailsLimit'
          - description: The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.
        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.
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    StringWithCharLimit64:
      type: string
      minLength: 1
      maxLength: 64
    Annotation:
      type: string
      minLength: 0
      maxLength: 256
    ConformancePackEvaluationResult:
      type: object
      required:
      - ComplianceType
      - EvaluationResultIdentifier
      - ConfigRuleInvokedTime
      - ResultRecordedTime
      properties:
        ComplianceType:
          allOf:
          - $ref: '#/components/schemas/ConformancePackComplianceType'
          - description: The compliance type. The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. <code>INSUFFICIENT_DATA</code> is not supported.
        EvaluationResultIdentifier:
          $ref: '#/components/schemas/EvaluationResultIdentifier'
        ConfigRuleInvokedTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time when Config rule evaluated Amazon Web Services resource.
        ResultRecordedTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: 'The time when Config recorded the evaluation result. '
        Annotation:
          allOf:
          - $ref: '#/components/schemas/Annotation'
          - description: 'Supplementary information about how the evaluation determined the compliance. '
      description: 'The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information. '
    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.
    GetConformancePackComplianceDetailsResponse:
      type: object
      required:
      - ConformancePackName
      properties:
        ConformancePackName:
          allOf:
          - $ref: '#/components/schemas/ConformancePackName'
          - description: Name of the conformance pack.
        ConformancePackRuleEvaluationResults:
          allOf:
          - $ref: '#/components/schemas/ConformancePackRuleEvaluationResultsList'
          - description: Returns a list of <code>ConformancePackEvaluationResult</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.
    NoSuchConformancePackException: {}
    Date:
      type: string
      format: date-time
    NoSuchConfigRuleInConformancePackException: {}
    ConformancePackEvaluationFilters:
      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>
        ResourceType:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: 'Filters the results by the resource type (for example, <code>"AWS::EC2::Instance"</code>). '
        ResourceIds:
          allOf:
          - $ref: '#/components/schemas/ConformancePackComplianceResourceIds'
          - description: <p>Filters the results by resource IDs.</p> <note> <p>This is valid only when you provide resource type. If there is no resource type, you will see an error.</p> </note>
      description: Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.
    InvalidNextTokenException: {}
    InvalidParameterValueException: {}
    ConformancePackName:
      type: string
      pattern: '[a-zA-Z][-a-zA-Z0-9]*'
      minLength: 1
      maxLength: 256
    GetConformancePackComplianceDetailsLimit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidLimitException: {}
    ConformancePackRuleEvaluationResultsList:
      type: array
      items:
        $ref: '#/components/schemas/ConformancePackEvaluationResult'
      minItems: 0
      maxItems: 100
    ConformancePackComplianceResourceIds:
      type: array
      items:
        $ref: '#/components/schemas/StringWithCharLimit256'
      minItems: 0
      maxItems: 5
    ConfigRuleName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 128
    ResourceEvaluationId:
      type: string
      minLength: 1
      maxLength: 128
    ConformancePackConfigRuleNames:
      type: array
      items:
        $ref: '#/components/schemas/StringWithCharLimit64'
      minItems: 0
      maxItems: 10
    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.
    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