Amazon Config #X Amz Target=StarlingDoveService.PutRemediationExceptions 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.PutRemediationExceptions 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.PutRemediationExceptions'
paths:
  /#X-Amz-Target=StarlingDoveService.PutRemediationExceptions:
    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: PutRemediationExceptions
      description: <p>A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule. </p> <note> <p>Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.</p> </note> <note> <p>When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as <code>NON_COMPLIANT</code>. Once the resource has been evaluated as <code>NON_COMPLIANT</code>, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a <code>NON_COMPLIANT</code> evaluation result can delete resources before the exception is applied.</p> </note> <note> <p>Placing an exception can only be performed on resources that are <code>NON_COMPLIANT</code>. If you use this API for <code>COMPLIANT</code> resources or resources that are <code>NOT_APPLICABLE</code>, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules">Concepts | Config Rules</a> in the <i>Config Developer Guide</i>.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutRemediationExceptionsResponse'
              examples:
                PutRemediationExceptions200Example:
                  summary: Default PutRemediationExceptions 200
                  x-microcks-default: true
                  value:
                    FailedBatches: example
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                PutRemediationExceptions480Example:
                  summary: Default PutRemediationExceptions 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InsufficientPermissionsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientPermissionsException'
              examples:
                PutRemediationExceptions481Example:
                  summary: Default PutRemediationExceptions 481
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutRemediationExceptionsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.PutRemediationExceptions
      summary: Amazon Config Put Remediation Exceptions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.PutRemediationExceptions'
components:
  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
  schemas:
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    PutRemediationExceptionsResponse:
      type: object
      properties:
        FailedBatches:
          allOf:
          - $ref: '#/components/schemas/FailedRemediationExceptionBatches'
          - description: Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
    StringWithCharLimit1024:
      type: string
      minLength: 1
      maxLength: 1024
    RemediationExceptionResourceKey:
      type: object
      properties:
        ResourceType:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: The type of a resource.
        ResourceId:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit1024'
          - description: The ID of the resource (for example., sg-xxxxxx).
      description: 'The details that identify a resource within Config, including the resource type and resource ID. '
    Date:
      type: string
      format: date-time
    InsufficientPermissionsException: {}
    PutRemediationExceptionsRequest:
      type: object
      required:
      - ConfigRuleName
      - ResourceKeys
      title: PutRemediationExceptionsRequest
      properties:
        ConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleName'
          - description: The name of the Config rule for which you want to create remediation exception.
        ResourceKeys:
          allOf:
          - $ref: '#/components/schemas/RemediationExceptionResourceKeys'
          - description: 'An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. '
        Message:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit1024'
          - description: The message contains an explanation of the exception.
        ExpirationTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The exception is automatically deleted after the expiration date.
    RemediationException:
      type: object
      required:
      - ConfigRuleName
      - ResourceType
      - ResourceId
      properties:
        ConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/ConfigRuleName'
          - description: The name of the Config rule.
        ResourceType:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: The type of a resource.
        ResourceId:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit1024'
          - description: The ID of the resource (for example., sg-xxxxxx).
        Message:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit1024'
          - description: An explanation of an remediation exception.
        ExpirationTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time when the remediation exception will be deleted.
      description: 'An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type. '
    RemediationExceptions:
      type: array
      items:
        $ref: '#/components/schemas/RemediationException'
      minItems: 0
      maxItems: 25
    InvalidParameterValueException: {}
    FailedRemediationExceptionBatch:
      type: object
      properties:
        FailureMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Returns a failure message. For example, the auto-remediation has failed.
        FailedItems:
          allOf:
          - $ref: '#/components/schemas/RemediationExceptions'
          - description: Returns remediation exception resource key object of the failed items.
      description: List of each of the failed remediation exceptions with specific reasons.
    ConfigRuleName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 128
    RemediationExceptionResourceKeys:
      type: array
      items:
        $ref: '#/components/schemas/RemediationExceptionResourceKey'
      minItems: 1
      maxItems: 100
    String:
      type: string
    FailedRemediationExceptionBatches:
      type: array
      items:
        $ref: '#/components/schemas/FailedRemediationExceptionBatch'
  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