Amazon Network Firewall Network Firewall Proxy Configuration API

openapi: 3.2.0
info:
  title: AWS Network Firewall Proxy Configuration API
  version: '2020-11-12'
  description: Generated from AWS's published Smithy model for AWS Network Firewall. 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://network-firewall.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Proxy Configuration
paths:
  /#CreateProxyConfiguration:
    post:
      operationId: CreateProxyConfiguration
      summary: Create Proxy Configuration
      description: Creates an Network Firewall ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration. To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateProxyConfigurationResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; LimitExceededException; 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.CreateProxyConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateProxyConfigurationRequest'
      tags:
      - Proxy Configuration
  /#DeleteProxyConfiguration:
    post:
      operationId: DeleteProxyConfiguration
      summary: Delete Proxy Configuration
      description: Deletes the specified ProxyConfiguration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteProxyConfigurationResponse'
        '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.DeleteProxyConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteProxyConfigurationRequest'
      tags:
      - Proxy Configuration
  /#DescribeProxyConfiguration:
    post:
      operationId: DescribeProxyConfiguration
      summary: Describe Proxy Configuration
      description: Returns the data objects for the specified proxy configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeProxyConfigurationResponse'
        '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.DescribeProxyConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeProxyConfigurationRequest'
      tags:
      - Proxy Configuration
  /#ListProxyConfigurations:
    post:
      operationId: ListProxyConfigurations
      summary: List Proxy Configurations
      description: Retrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListProxyConfigurationsResponse'
        '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.ListProxyConfigurations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListProxyConfigurationsRequest'
      tags:
      - Proxy Configuration
  /#UpdateProxyConfiguration:
    post:
      operationId: UpdateProxyConfiguration
      summary: Update Proxy Configuration
      description: Updates the properties of the specified proxy configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateProxyConfigurationResponse'
        '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.UpdateProxyConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateProxyConfigurationRequest'
      tags:
      - Proxy Configuration
components:
  schemas:
    ProxyConfigDefaultRulePhaseActionsRequest:
      type: object
      properties:
        PreDNS:
          type: string
          enum:
          - ALLOW
          - DENY
          - ALERT
          description: Before domain resolution.
        PreREQUEST:
          type: string
          enum:
          - ALLOW
          - DENY
          - ALERT
          description: After DNS, before request.
        PostRESPONSE:
          type: string
          enum:
          - ALLOW
          - DENY
          - ALERT
          description: After receiving response.
    ProxyConfiguration:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
        ProxyConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration.
        Description:
          type: string
          description: A description of the proxy configuration.
        CreateTime:
          type: string
          format: date-time
          description: Time the Proxy Configuration was created.
        DeleteTime:
          type: string
          format: date-time
          description: Time the Proxy Configuration was deleted.
        RuleGroups:
          type: array
          items:
            $ref: '#/components/schemas/ProxyConfigRuleGroup'
          description: Proxy rule groups within the proxy configuration.
        DefaultRulePhaseActions:
          $ref: '#/components/schemas/ProxyConfigDefaultRulePhaseActionsRequest'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
    ProxyConfigRuleGroup:
      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.
        Type:
          type: string
          description: Proxy rule group type.
        Priority:
          type: integer
          description: Priority of the proxy rule group in the proxy configuration.
    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
    DeleteProxyConfigurationRequest:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration. You must specify the ARN or the name, and you can specify both.
    DeleteProxyConfigurationResponse:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
        ProxyConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    ProxyConfigurationMetadata:
      type: object
      properties:
        Name:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration.
    DescribeProxyConfigurationRequest:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration. You must specify the ARN or the name, and you can specify both.
    ListProxyConfigurationsRequest:
      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.
    UpdateProxyConfigurationResponse:
      type: object
      properties:
        ProxyConfiguration:
          $ref: '#/components/schemas/ProxyConfiguration'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request. To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your
    CreateProxyConfigurationRequest:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
        Description:
          type: string
          description: A description of the proxy configuration.
        RuleGroupNames:
          type: array
          items:
            type: string
          description: The proxy rule group name(s) to attach to the proxy configuration. You must specify the ARNs or the names, and you can specify both.
        RuleGroupArns:
          type: array
          items:
            type: string
          description: The proxy rule group arn(s) to attach to the proxy configuration. You must specify the ARNs or the names, and you can specify both.
        DefaultRulePhaseActions:
          $ref: '#/components/schemas/ProxyConfigDefaultRulePhaseActionsRequest'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
      required:
      - ProxyConfigurationName
      - DefaultRulePhaseActions
    CreateProxyConfigurationResponse:
      type: object
      properties:
        ProxyConfiguration:
          $ref: '#/components/schemas/ProxyConfiguration'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request. To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your
    ListProxyConfigurationsResponse:
      type: object
      properties:
        ProxyConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ProxyConfigurationMetadata'
          description: The metadata for the proxy configurations. Depending on your setting for max results and the number of proxy configurations 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.
    DescribeProxyConfigurationResponse:
      type: object
      properties:
        ProxyConfiguration:
          $ref: '#/components/schemas/ProxyConfiguration'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request. To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    UpdateProxyConfigurationRequest:
      type: object
      properties:
        ProxyConfigurationName:
          type: string
          description: The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy configuration. You must specify the ARN or the name, and you can specify both.
        DefaultRulePhaseActions:
          $ref: '#/components/schemas/ProxyConfigDefaultRulePhaseActionsRequest'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request. To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your
      required:
      - DefaultRulePhaseActions
      - UpdateToken
  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)