Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.AssociateSubnets API

openapi: 3.2.0
info:
  version: 2020-11-12
  x-release: v4
  title: 'AWS Network Firewall #X Amz Target=NetworkFirewall…'
  description: This is the API Reference for Network Firewall.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: network-firewall
  x-aws-signingName: network-firewall
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/network-firewall-2020-11-12.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://network-firewall.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Network Firewall multi-region endpoint
- url: https://network-firewall.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Network Firewall multi-region endpoint
- url: http://network-firewall.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
- url: https://network-firewall.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=NetworkFirewall 20201112.AssociateSubnets'
paths:
  /#X-Amz-Target=NetworkFirewall_20201112.AssociateSubnets:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: AssociateSubnets
      description: 'Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.


        This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall''s protections, you must also modify the VPC''s route tables for each subnet''s Availability Zone, to redirect the traffic that''s coming into and going out of the zone through the firewall endpoint.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateSubnetsResponse'
              examples:
                AssociateSubnets200Example:
                  summary: Default AssociateSubnets 200 response
                  x-microcks-default: true
                  value:
                    FirewallArn: arn:aws:service:us-east-1:123456789012:resource/example
                    FirewallName: my-resource
                    SubnetMappings: example-string
                    UpdateToken: example-string
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: InvalidTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidTokenException'
        '485':
          description: InvalidOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidOperationException'
        '486':
          description: InsufficientCapacityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientCapacityException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateSubnetsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.AssociateSubnets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Network Firewall Associate Subnets
      tags:
      - '#X Amz Target=NetworkFirewall 20201112.AssociateSubnets'
components:
  schemas:
    InsufficientCapacityException: {}
    ThrottlingException: {}
    SubnetMappings:
      type: array
      items:
        $ref: '#/components/schemas/SubnetMapping'
    CollectionMember_String:
      type: string
    AssociateSubnetsRequest:
      type: object
      required:
      - SubnetMappings
      title: AssociateSubnetsRequest
      properties:
        UpdateToken:
          allOf:
          - $ref: '#/components/schemas/UpdateToken'
          - description: <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p> <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p> <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
        FirewallArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: <p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        FirewallName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        SubnetMappings:
          allOf:
          - $ref: '#/components/schemas/SubnetMappings'
          - description: 'The IDs of the subnets that you want to associate with the firewall. '
    InternalServerError: {}
    UpdateToken:
      type: string
      pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
      minLength: 1
      maxLength: 1024
    ResourceArn:
      type: string
      pattern: ^arn:aws.*
      minLength: 1
      maxLength: 256
    SubnetMapping:
      type: object
      required:
      - SubnetId
      properties:
        SubnetId:
          allOf:
          - $ref: '#/components/schemas/CollectionMember_String'
          - description: 'The unique identifier for the subnet. '
        IPAddressType:
          allOf:
          - $ref: '#/components/schemas/IPAddressType'
          - description: The subnet's IP address type. You can't change the IP address type after you create the subnet.
      description: The ID for a subnet that you want to associate with the firewall. This is used with <a>CreateFirewall</a> and <a>AssociateSubnets</a>. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
    ResourceName:
      type: string
      pattern: ^[a-zA-Z0-9-]+$
      minLength: 1
      maxLength: 128
    InvalidRequestException: {}
    ResourceNotFoundException: {}
    InvalidTokenException: {}
    IPAddressType:
      type: string
      enum:
      - DUALSTACK
      - IPV4
      - IPV6
    InvalidOperationException: {}
    AssociateSubnetsResponse:
      type: object
      properties:
        FirewallArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: The Amazon Resource Name (ARN) of the firewall.
        FirewallName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The descriptive name of the firewall. You can't change the name of a firewall after you create it.
        SubnetMappings:
          allOf:
          - $ref: '#/components/schemas/SubnetMappings'
          - description: 'The IDs of the subnets that are associated with the firewall. '
        UpdateToken:
          allOf:
          - $ref: '#/components/schemas/UpdateToken'
          - description: <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p> <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p> <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/network-firewall/
x-hasEquivalentPaths: true