Amazon Shield Shield Application Layer Automatic Response API

openapi: 3.2.0
info:
  title: AWS Shield Application Layer Automatic Response API
  version: '2016-06-02'
  description: Generated from AWS's published Smithy model for AWS Shield. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://shield.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Application Layer Automatic Response
paths:
  /#DisableApplicationLayerAutomaticResponse:
    post:
      operationId: DisableApplicationLayerAutomaticResponse
      summary: Disable Application Layer Automatic Response
      description: Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisableApplicationLayerAutomaticResponseResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidOperationException; InvalidParameterException; OptimisticLockException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.DisableApplicationLayerAutomaticResponse
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisableApplicationLayerAutomaticResponseRequest'
      tags:
      - Application Layer Automatic Response
  /#EnableApplicationLayerAutomaticResponse:
    post:
      operationId: EnableApplicationLayerAutomaticResponse
      summary: Enable Application Layer Automatic Response
      description: Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. This feature is available for Amazon CloudFront distributions and Application Load Balancers only. This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation. Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield A
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EnableApplicationLayerAutomaticResponseResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidOperationException; InvalidParameterException; LimitsExceededException; OptimisticLockException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.EnableApplicationLayerAutomaticResponse
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/EnableApplicationLayerAutomaticResponseRequest'
      tags:
      - Application Layer Automatic Response
  /#UpdateApplicationLayerAutomaticResponse:
    post:
      operationId: UpdateApplicationLayerAutomaticResponse
      summary: Update Application Layer Automatic Response
      description: Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateApplicationLayerAutomaticResponseResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidOperationException; InvalidParameterException; OptimisticLockException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidOperationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.UpdateApplicationLayerAutomaticResponse
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateApplicationLayerAutomaticResponseRequest'
      tags:
      - Application Layer Automatic Response
components:
  schemas:
    InvalidOperationException:
      type: object
      properties:
        message:
          type: string
    DisableApplicationLayerAutomaticResponseResponse:
      type: object
      properties: {}
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
    UpdateApplicationLayerAutomaticResponseRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The ARN (Amazon Resource Name) of the resource.
        Action:
          $ref: '#/components/schemas/ResponseAction'
      required:
      - ResourceArn
      - Action
    EnableApplicationLayerAutomaticResponseResponse:
      type: object
      properties: {}
    EnableApplicationLayerAutomaticResponseRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The ARN (Amazon Resource Name) of the protected resource.
        Action:
          $ref: '#/components/schemas/ResponseAction'
      required:
      - ResourceArn
      - Action
    CountAction:
      type: object
      properties: {}
    ResponseAction:
      type: object
      properties:
        Block:
          $ref: '#/components/schemas/BlockAction'
        Count:
          $ref: '#/components/schemas/CountAction'
    UpdateApplicationLayerAutomaticResponseResponse:
      type: object
      properties: {}
    DisableApplicationLayerAutomaticResponseRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The ARN (Amazon Resource Name) of the protected resource.
      required:
      - ResourceArn
    BlockAction:
      type: object
      properties: {}
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: shield
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/shield/service/2016-06-02/shield-2016-06-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)