Amazon Shield Shield Protection Group API

openapi: 3.2.0
info:
  title: AWS Shield Protection Group API
  version: '2016-06-02'
  description: Generated from AWS's published Smithy model for AWS Shield. 5 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: Protection Group
paths:
  /#DeleteProtectionGroup:
    post:
      operationId: DeleteProtectionGroup
      summary: Delete Protection Group
      description: Removes the specified protection group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteProtectionGroupResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: OptimisticLockException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OptimisticLockException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.DeleteProtectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProtectionGroupRequest'
      tags:
      - Protection Group
  /#DescribeProtectionGroup:
    post:
      operationId: DescribeProtectionGroup
      summary: Describe Protection Group
      description: Returns the specification for the specified protection group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProtectionGroupResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.DescribeProtectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProtectionGroupRequest'
      tags:
      - Protection Group
  /#ListProtectionGroups:
    post:
      operationId: ListProtectionGroups
      summary: List Protection Groups
      description: Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProtectionGroupsResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidPaginationTokenException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidPaginationTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.ListProtectionGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProtectionGroupsRequest'
      tags:
      - Protection Group
  /#UpdateProtectionGroup:
    post:
      operationId: UpdateProtectionGroup
      summary: Update Protection Group
      description: Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateProtectionGroupResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OptimisticLockException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShield_20160616.UpdateProtectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateProtectionGroupRequest'
      tags:
      - Protection Group
components:
  schemas:
    DeleteProtectionGroupRequest:
      type: object
      properties:
        ProtectionGroupId:
          type: string
          description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
      required:
      - ProtectionGroupId
    ListProtectionGroupsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request. You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available. W
        MaxResults:
          type: integer
          description: The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response. The default setting is 20.
        InclusionFilters:
          $ref: '#/components/schemas/InclusionProtectionGroupFilters'
    ListProtectionGroupsResponse:
      type: object
      properties:
        ProtectionGroups:
          type: array
          items:
            $ref: '#/components/schemas/ProtectionGroup'
        NextToken:
          type: string
          description: When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request. You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available. W
      required:
      - ProtectionGroups
    OptimisticLockException:
      type: object
      properties:
        message:
          type: string
    DescribeProtectionGroupResponse:
      type: object
      properties:
        ProtectionGroup:
          $ref: '#/components/schemas/ProtectionGroup'
      required:
      - ProtectionGroup
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
    InclusionProtectionGroupFilters:
      type: object
      properties:
        ProtectionGroupIds:
          type: array
          items:
            type: string
          description: The ID of the protection group that you want to retrieve.
        Patterns:
          type: array
          items:
            type: string
            enum:
            - ALL
            - ARBITRARY
            - BY_RESOURCE_TYPE
          description: The pattern specification of the protection groups that you want to retrieve.
        ResourceTypes:
          type: array
          items:
            type: string
            enum:
            - CLOUDFRONT_DISTRIBUTION
            - ROUTE_53_HOSTED_ZONE
            - ELASTIC_IP_ALLOCATION
            - CLASSIC_LOAD_BALANCER
            - APPLICATION_LOAD_BALANCER
            - GLOBAL_ACCELERATOR
          description: The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.
        Aggregations:
          type: array
          items:
            type: string
            enum:
            - SUM
            - MEAN
            - MAX
          description: The aggregation setting of the protection groups that you want to retrieve.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceType:
          type: string
          description: Type of resource.
    UpdateProtectionGroupResponse:
      type: object
      properties: {}
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter that failed validation.
        message:
          type: string
          description: The message describing why the parameter failed validation.
      required:
      - name
      - message
    UpdateProtectionGroupRequest:
      type: object
      properties:
        ProtectionGroupId:
          type: string
          description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
        Aggregation:
          type: string
          enum:
          - SUM
          - MEAN
          - MAX
          description: Defines how Shield combines resource data for the group in order to detect, mitigate, and report events. Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically. Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers. Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic
        Pattern:
          type: string
          enum:
          - ALL
          - ARBITRARY
          - BY_RESOURCE_TYPE
          description: The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
        ResourceType:
          type: string
          enum:
          - CLOUDFRONT_DISTRIBUTION
          - ROUTE_53_HOSTED_ZONE
          - ELASTIC_IP_ALLOCATION
          - CLASSIC_LOAD_BALANCER
          - APPLICATION_LOAD_BALANCER
          - GLOBAL_ACCELERATOR
          description: The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
        Members:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
      required:
      - ProtectionGroupId
      - Aggregation
      - Pattern
    DescribeProtectionGroupRequest:
      type: object
      properties:
        ProtectionGroupId:
          type: string
          description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
      required:
      - ProtectionGroupId
    DeleteProtectionGroupResponse:
      type: object
      properties: {}
    ProtectionGroup:
      type: object
      properties:
        ProtectionGroupId:
          type: string
          description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
        Aggregation:
          type: string
          enum:
          - SUM
          - MEAN
          - MAX
          description: Defines how Shield combines resource data for the group in order to detect, mitigate, and report events. Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically. Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers. Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic
        Pattern:
          type: string
          enum:
          - ALL
          - ARBITRARY
          - BY_RESOURCE_TYPE
          description: The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
        ResourceType:
          type: string
          enum:
          - CLOUDFRONT_DISTRIBUTION
          - ROUTE_53_HOSTED_ZONE
          - ELASTIC_IP_ALLOCATION
          - CLASSIC_LOAD_BALANCER
          - APPLICATION_LOAD_BALANCER
          - GLOBAL_ACCELERATOR
          description: The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
        Members:
          type: array
          items:
            type: string
          description: The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
        ProtectionGroupArn:
          type: string
          description: The ARN (Amazon Resource Name) of the protection group.
      required:
      - ProtectionGroupId
      - Aggregation
      - Pattern
      - Members
    InvalidPaginationTokenException:
      type: object
      properties:
        message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: Additional information about the exception.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: Fields that caused the exception.
  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)