Amazon Network Firewall Network Firewall Proxy Rule Group API

openapi: 3.2.0
info:
  title: AWS Network Firewall Proxy Rule Group API
  version: '2020-11-12'
  description: Generated from AWS's published Smithy model for AWS Network Firewall. 4 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://network-firewall.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Proxy Rule Group
paths:
  /#CreateProxyRuleGroup:
    post:
      operationId: CreateProxyRuleGroup
      summary: Create Proxy Rule Group
      description: Creates an Network Firewall ProxyRuleGroup Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations. To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateProxyRuleGroupResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; LimitExceededException; ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.CreateProxyRuleGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateProxyRuleGroupRequest'
      tags:
      - Proxy Rule Group
  /#DeleteProxyRuleGroup:
    post:
      operationId: DeleteProxyRuleGroup
      summary: Delete Proxy Rule Group
      description: Deletes the specified ProxyRuleGroup.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteProxyRuleGroupResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; ResourceNotFoundException; ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.DeleteProxyRuleGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteProxyRuleGroupRequest'
      tags:
      - Proxy Rule Group
  /#DescribeProxyRuleGroup:
    post:
      operationId: DescribeProxyRuleGroup
      summary: Describe Proxy Rule Group
      description: Returns the data objects for the specified proxy rule group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeProxyRuleGroupResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; ResourceNotFoundException; ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.DescribeProxyRuleGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeProxyRuleGroupRequest'
      tags:
      - Proxy Rule Group
  /#ListProxyRuleGroups:
    post:
      operationId: ListProxyRuleGroups
      summary: List Proxy Rule Groups
      description: Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListProxyRuleGroupsResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; ResourceNotFoundException; ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.ListProxyRuleGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListProxyRuleGroupsRequest'
      tags:
      - Proxy Rule Group
components:
  schemas:
    ProxyRuleGroup:
      type: object
      properties:
        ProxyRuleGroupName:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
        ProxyRuleGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy rule group.
        CreateTime:
          type: string
          format: date-time
          description: Time the Proxy Rule Group was created.
        DeleteTime:
          type: string
          format: date-time
          description: Time the Proxy Rule Group was deleted.
        Rules:
          $ref: '#/components/schemas/ProxyRulesByRequestPhase'
        Description:
          type: string
          description: A description of the proxy rule group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
    ProxyRulesByRequestPhase:
      type: object
      properties:
        PreDNS:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRule'
          description: Before domain resolution.
        PreREQUEST:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRule'
          description: After DNS, before request.
        PostRESPONSE:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRule'
          description: After receiving response.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
        Value:
          type: string
          description: The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
      required:
      - Key
      - Value
    ProxyRuleGroupMetadata:
      type: object
      properties:
        Name:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy rule group.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DeleteProxyRuleGroupRequest:
      type: object
      properties:
        ProxyRuleGroupName:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyRuleGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy rule group. You must specify the ARN or the name, and you can specify both.
    CreateProxyRuleGroupRequest:
      type: object
      properties:
        ProxyRuleGroupName:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
        Description:
          type: string
          description: A description of the proxy rule group.
        Rules:
          $ref: '#/components/schemas/ProxyRulesByRequestPhase'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
      required:
      - ProxyRuleGroupName
    DeleteProxyRuleGroupResponse:
      type: object
      properties:
        ProxyRuleGroupName:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
        ProxyRuleGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy rule group.
    ListProxyRuleGroupsResponse:
      type: object
      properties:
        ProxyRuleGroups:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRuleGroupMetadata'
          description: The metadata for the proxy rule groups. Depending on your setting for max results and the number of proxy rule groups that you have, this might not be the full list.
        NextToken:
          type: string
          description: When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
    CreateProxyRuleGroupResponse:
      type: object
      properties:
        ProxyRuleGroup:
          $ref: '#/components/schemas/ProxyRuleGroup'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request. To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as nee
    ProxyRuleCondition:
      type: object
      properties:
        ConditionOperator:
          type: string
          description: Defines how to perform a match.
        ConditionKey:
          type: string
          description: Defines what is to be matched.
        ConditionValues:
          type: array
          items:
            type: string
          description: Specifes the exact value that needs to be matched against.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    ListProxyRuleGroupsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
        MaxResults:
          type: integer
          description: The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
    DescribeProxyRuleGroupResponse:
      type: object
      properties:
        ProxyRuleGroup:
          $ref: '#/components/schemas/ProxyRuleGroup'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request. To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as nee
    ProxyRule:
      type: object
      properties:
        ProxyRuleName:
          type: string
          description: The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
        Description:
          type: string
          description: A description of the proxy rule.
        Action:
          type: string
          enum:
          - ALLOW
          - DENY
          - ALERT
          description: Action to take.
        Conditions:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRuleCondition'
          description: Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
    DescribeProxyRuleGroupRequest:
      type: object
      properties:
        ProxyRuleGroupName:
          type: string
          description: The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyRuleGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy rule group. You must specify the ARN or the name, and you can specify both.
  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: network-firewall
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/network-firewall/service/2020-11-12/network-firewall-2020-11-12.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)