find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-network-firewall:amazon-network-firewall-proxy-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Network Firewall Proxy 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
paths:
  /#CreateProxy:
    post:
      operationId: CreateProxy
      summary: Create Proxy
      description: Creates an Network Firewall Proxy Attaches a Proxy configuration to a NAT Gateway. To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxies and DescribeProxy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateProxyResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; LimitExceededException; ResourceNotFoundException; ThrottlingException; UnsupportedOperationException
          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.CreateProxy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateProxyRequest'
      tags:
      - Proxy
  /#DeleteProxy:
    post:
      operationId: DeleteProxy
      summary: Delete Proxy
      description: Deletes the specified Proxy. Detaches a Proxy configuration from a NAT Gateway.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteProxyResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; ResourceNotFoundException; ThrottlingException; UnsupportedOperationException
          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.DeleteProxy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteProxyRequest'
      tags:
      - Proxy
  /#DescribeProxy:
    post:
      operationId: DescribeProxy
      summary: Describe Proxy
      description: Returns the data objects for the specified proxy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeProxyResponse'
        '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.DescribeProxy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeProxyRequest'
      tags:
      - Proxy
  /#ListProxies:
    post:
      operationId: ListProxies
      summary: List Proxies
      description: Retrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListProxiesResponse'
        '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.ListProxies
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListProxiesRequest'
      tags:
      - Proxy
  /#UpdateProxy:
    post:
      operationId: UpdateProxy
      summary: Update Proxy
      description: Updates the properties of the specified proxy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateProxyResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException; ResourceNotFoundException; ThrottlingException; UnsupportedOperationException
          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.UpdateProxy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateProxyRequest'
      tags:
      - Proxy
components:
  schemas:
    TlsInterceptPropertiesRequest:
      type: object
      properties:
        PcaArn:
          type: string
          description: Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
        TlsInterceptMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether to enable or disable TLS Intercept Mode.
    TlsInterceptProperties:
      type: object
      properties:
        PcaArn:
          type: string
          description: Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
        TlsInterceptMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether to enable or disable TLS Intercept Mode.
    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
    UpdateProxyResponse:
      type: object
      properties:
        Proxy:
          $ref: '#/components/schemas/Proxy'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request. To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
    ListProxiesResponse:
      type: object
      properties:
        Proxies:
          type: array
          items:
            $ref: '#/components/schemas/ProxyMetadata'
          description: The metadata for the proxies. Depending on your setting for max results and the number of proxies 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.
    ListenerPropertyRequest:
      type: object
      properties:
        Port:
          type: integer
          description: Port for processing traffic.
        Type:
          type: string
          enum:
          - HTTP
          - HTTPS
          description: Selection of HTTP or HTTPS traffic.
      required:
      - Port
      - Type
    CreateProxyRequest:
      type: object
      properties:
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it.
        NatGatewayId:
          type: string
          description: A unique identifier for the NAT gateway to use with proxy resources.
        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.
        ListenerProperties:
          type: array
          items:
            $ref: '#/components/schemas/ListenerPropertyRequest'
          description: Listener properties for HTTP and HTTPS traffic.
        TlsInterceptProperties:
          $ref: '#/components/schemas/TlsInterceptPropertiesRequest'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
      required:
      - ProxyName
      - NatGatewayId
      - TlsInterceptProperties
    DeleteProxyResponse:
      type: object
      properties:
        NatGatewayId:
          type: string
          description: The NAT Gateway the Proxy was attached to.
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy.
    DeleteProxyRequest:
      type: object
      properties:
        NatGatewayId:
          type: string
          description: The NAT Gateway the proxy is attached to.
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy. You must specify the ARN or the name, and you can specify both.
      required:
      - NatGatewayId
    ListProxiesRequest:
      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.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DescribeProxyRequest:
      type: object
      properties:
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy. You must specify the ARN or the name, and you can specify both.
    ProxyMetadata:
      type: object
      properties:
        Name:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy.
    CreateProxyResponse:
      type: object
      properties:
        Proxy:
          $ref: '#/components/schemas/Proxy'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request. To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
    DescribeProxyResponse:
      type: object
      properties:
        Proxy:
          $ref: '#/components/schemas/DescribeProxyResource'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request. To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
    Proxy:
      type: object
      properties:
        CreateTime:
          type: string
          format: date-time
          description: Time the Proxy was created.
        DeleteTime:
          type: string
          format: date-time
          description: Time the Proxy was deleted.
        UpdateTime:
          type: string
          format: date-time
          description: Time the Proxy was updated.
        FailureCode:
          type: string
          description: Failure code for cases when the Proxy fails to attach or update.
        FailureMessage:
          type: string
          description: Failure message for cases when the Proxy fails to attach or update.
        ProxyState:
          type: string
          enum:
          - ATTACHING
          - ATTACHED
          - DETACHING
          - DETACHED
          - ATTACH_FAILED
          - DETACH_FAILED
          description: Current attachment/detachment status of the Proxy.
        ProxyModifyState:
          type: string
          enum:
          - MODIFYING
          - COMPLETED
          - FAILED
          description: Current modification status of the Proxy.
        NatGatewayId:
          type: string
          description: The NAT Gateway for the proxy.
        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.
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy.
        ListenerProperties:
          type: array
          items:
            $ref: '#/components/schemas/ListenerProperty'
          description: Listener properties for HTTP and HTTPS traffic.
        TlsInterceptProperties:
          $ref: '#/components/schemas/TlsInterceptProperties'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
    UpdateProxyRequest:
      type: object
      properties:
        NatGatewayId:
          type: string
          description: The NAT Gateway the proxy is attached to.
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it. You must specify the ARN or the name, and you can specify both.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy. You must specify the ARN or the name, and you can specify both.
        ListenerPropertiesToAdd:
          type: array
          items:
            $ref: '#/components/schemas/ListenerPropertyRequest'
          description: Listener properties for HTTP and HTTPS traffic to add.
        ListenerPropertiesToRemove:
          type: array
          items:
            $ref: '#/components/schemas/ListenerPropertyRequest'
          description: Listener properties for HTTP and HTTPS traffic to remove.
        TlsInterceptProperties:
          $ref: '#/components/schemas/TlsInterceptPropertiesRequest'
        UpdateToken:
          type: string
          description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request. To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
      required:
      - NatGatewayId
      - UpdateToken
    DescribeProxyResource:
      type: object
      properties:
        ProxyName:
          type: string
          description: The descriptive name of the proxy. You can't change the name of a proxy after you create it.
        ProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a proxy.
        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.
        NatGatewayId:
          type: string
          description: The NAT Gateway for the proxy.
        ProxyState:
          type: string
          enum:
          - ATTACHING
          - ATTACHED
          - DETACHING
          - DETACHED
          - ATTACH_FAILED
          - DETACH_FAILED
          description: Current attachment/detachment status of the Proxy.
        ProxyModifyState:
          type: string
          enum:
          - MODIFYING
          - COMPLETED
          - FAILED
          description: Current modification status of the Proxy.
        ListenerProperties:
          type: array
          items:
            $ref: '#/components/schemas/ListenerProperty'
          description: Listener properties for HTTP and HTTPS traffic.
        TlsInterceptProperties:
          $ref: '#/components/schemas/TlsInterceptProperties'
        VpcEndpointServiceName:
          type: string
          description: The service endpoint created in the VPC.
        PrivateDNSName:
          type: string
          description: The private DNS name of the Proxy.
        CreateTime:
          type: string
          format: date-time
          description: Time the Proxy was created.
        DeleteTime:
          type: string
          format: date-time
          description: Time the Proxy was deleted.
        UpdateTime:
          type: string
          format: date-time
          description: Time the Proxy was updated.
        FailureCode:
          type: string
          description: Failure code for cases when the Proxy fails to attach or update.
        FailureMessage:
          type: string
          description: Failure message for cases when the Proxy fails to attach or update.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The key:value pairs to associate with the resource.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    ListenerProperty:
      type: object
      properties:
        Port:
          type: integer
          description: Port for processing traffic.
        Type:
          type: string
          enum:
          - HTTP
          - HTTPS
          description: Selection of HTTP or HTTPS traffic.
  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)