Amazon Network Firewall Network Firewall Proxy Rule API

openapi: 3.2.0
info:
  title: AWS Network Firewall Proxy Rule 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
paths:
  /#CreateProxyRules:
    post:
      operationId: CreateProxyRules
      summary: Create Proxy Rules
      description: Creates Network Firewall ProxyRule resources. Attaches new proxy rule(s) to an existing proxy rule group. 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/CreateProxyRulesResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; 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.CreateProxyRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateProxyRulesRequest'
      tags:
      - Proxy Rule
  /#DeleteProxyRules:
    post:
      operationId: DeleteProxyRules
      summary: Delete Proxy Rules
      description: Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteProxyRulesResponse'
        '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.DeleteProxyRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteProxyRulesRequest'
      tags:
      - Proxy Rule
  /#DescribeProxyRule:
    post:
      operationId: DescribeProxyRule
      summary: Describe Proxy Rule
      description: Returns the data objects for the specified proxy configuration for the specified proxy rule group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeProxyRuleResponse'
        '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.DescribeProxyRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeProxyRuleRequest'
      tags:
      - Proxy Rule
  /#UpdateProxyRule:
    post:
      operationId: UpdateProxyRule
      summary: Update Proxy Rule
      description: Updates the properties of the specified proxy rule.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateProxyRuleResponse'
        '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.UpdateProxyRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateProxyRuleRequest'
      tags:
      - Proxy Rule
components:
  schemas:
    CreateProxyRule:
      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.
        InsertPosition:
          type: integer
          description: Where to insert a proxy rule in a proxy rule group.
    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
    DeleteProxyRulesRequest:
      type: object
      properties:
        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.
        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.
        Rules:
          type: array
          items:
            type: string
          description: The proxy rule(s) to remove from the existing proxy rule group.
      required:
      - Rules
    DescribeProxyRuleRequest:
      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.
        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.
      required:
      - ProxyRuleName
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    CreateProxyRulesByRequestPhase:
      type: object
      properties:
        PreDNS:
          type: array
          items:
            $ref: '#/components/schemas/CreateProxyRule'
          description: Before domain resolution.
        PreREQUEST:
          type: array
          items:
            $ref: '#/components/schemas/CreateProxyRule'
          description: After DNS, before request.
        PostRESPONSE:
          type: array
          items:
            $ref: '#/components/schemas/CreateProxyRule'
          description: After receiving response.
    UpdateProxyRuleResponse:
      type: object
      properties:
        ProxyRule:
          $ref: '#/components/schemas/ProxyRule'
        RemovedConditions:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRuleCondition'
          description: Proxy rule conditions removed from the rule.
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request. To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation ag
    UpdateProxyRuleRequest:
      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.
        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: Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.
        AddConditions:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRuleCondition'
          description: Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
        RemoveConditions:
          type: array
          items:
            $ref: '#/components/schemas/ProxyRuleCondition'
          description: Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request. To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation ag
      required:
      - ProxyRuleName
      - UpdateToken
    DeleteProxyRulesResponse:
      type: object
      properties:
        ProxyRuleGroup:
          $ref: '#/components/schemas/ProxyRuleGroup'
    DescribeProxyRuleResponse:
      type: object
      properties:
        ProxyRule:
          $ref: '#/components/schemas/ProxyRule'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request. To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation ag
    CreateProxyRulesResponse:
      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. The token marks the state of the proxy rule resource at the time of the request. To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation ag
    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
    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.
    CreateProxyRulesRequest:
      type: object
      properties:
        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.
        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.
        Rules:
          $ref: '#/components/schemas/CreateProxyRulesByRequestPhase'
      required:
      - Rules
  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)