Amazon Config #X Amz Target=StarlingDoveService.ListResourceEvaluations 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.ListResourceEvaluations 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.ListResourceEvaluations'
paths:
  /#X-Amz-Target=StarlingDoveService.ListResourceEvaluations:
    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: ListResourceEvaluations
      description: Returns a list of proactive resource evaluations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResourceEvaluationsResponse'
              examples:
                ListResourceEvaluations200Example:
                  summary: Default ListResourceEvaluations 200
                  x-microcks-default: true
                  value:
                    ResourceEvaluations: example
                    NextToken: example
        '480':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListResourceEvaluations480Example:
                  summary: Default ListResourceEvaluations 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                ListResourceEvaluations481Example:
                  summary: Default ListResourceEvaluations 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidTimeRangeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidTimeRangeException'
              examples:
                ListResourceEvaluations482Example:
                  summary: Default ListResourceEvaluations 482
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListResourceEvaluationsRequest'
      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.ListResourceEvaluations
      summary: Amazon Config List Resource Evaluations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.ListResourceEvaluations'
components:
  schemas:
    ListResourceEvaluationsResponse:
      type: object
      properties:
        ResourceEvaluations:
          allOf:
          - $ref: '#/components/schemas/ResourceEvaluations'
          - description: Returns a <code>ResourceEvaluations</code> object.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - 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.
    ResourceEvaluation:
      type: object
      properties:
        ResourceEvaluationId:
          allOf:
          - $ref: '#/components/schemas/ResourceEvaluationId'
          - description: The ResourceEvaluationId of a evaluation.
        EvaluationMode:
          allOf:
          - $ref: '#/components/schemas/EvaluationMode'
          - description: The mode of an evaluation. The valid values are Detective or Proactive.
        EvaluationStartTimestamp:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The starting time of an execution.
      description: Returns details of a resource evaluation.
    InvalidTimeRangeException: {}
    ResourceEvaluationFilters:
      type: object
      properties:
        EvaluationMode:
          allOf:
          - $ref: '#/components/schemas/EvaluationMode'
          - description: Filters all resource evaluations results based on an evaluation mode. the valid value for this API is <code>Proactive</code>.
        TimeWindow:
          allOf:
          - $ref: '#/components/schemas/TimeWindow'
          - description: Returns a <code>TimeWindow</code> object.
        EvaluationContextIdentifier:
          allOf:
          - $ref: '#/components/schemas/EvaluationContextIdentifier'
          - description: 'Filters evaluations for a given infrastructure deployment. For example: CFN Stack.'
      description: Returns details of a resource evaluation based on the selected filter.
    Date:
      type: string
      format: date-time
    ListResourceEvaluationsPageItemLimit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidNextTokenException: {}
    InvalidParameterValueException: {}
    ListResourceEvaluationsRequest:
      type: object
      title: ListResourceEvaluationsRequest
      properties:
        Filters:
          allOf:
          - $ref: '#/components/schemas/ResourceEvaluationFilters'
          - description: Returns a <code>ResourceEvaluationFilters</code> object.
        Limit:
          allOf:
          - $ref: '#/components/schemas/ListResourceEvaluationsPageItemLimit'
          - description: The maximum number of evaluations 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/String'
          - 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.
    EvaluationContextIdentifier:
      type: string
      minLength: 1
      maxLength: 128
    ResourceEvaluationId:
      type: string
      minLength: 1
      maxLength: 128
    String:
      type: string
    ResourceEvaluations:
      type: array
      items:
        $ref: '#/components/schemas/ResourceEvaluation'
    EvaluationMode:
      type: string
      enum:
      - DETECTIVE
      - PROACTIVE
    TimeWindow:
      type: object
      properties:
        StartTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The start time of an execution.
        EndTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The end time of an execution. The end time must be after the start date.
      description: Filters evaluation results based on start and end times.
  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