Amazon EC2 Ec2 Network Acl API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Network Acl API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Network Acl
paths:
  /?Action=CreateNetworkAcl:
    post:
      operationId: CreateNetworkAcl
      summary: Create Network Acl
      description: Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateNetworkAclResult'
              example:
                NetworkAcl:
                  Associations: []
                  NetworkAclId: acl-5fb85d36
                  VpcId: vpc-a01106c2
                  Tags: []
                  Entries:
                  - CidrBlock: 0.0.0.0/0
                    RuleNumber: 32767
                    Protocol: '-1'
                    Egress: true
                    RuleAction: deny
                  - CidrBlock: 0.0.0.0/0
                    RuleNumber: 32767
                    Protocol: '-1'
                    Egress: false
                    RuleAction: deny
                  IsDefault: false
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateNetworkAcl
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateNetworkAclRequest'
            example:
              VpcId: vpc-a01106c2
      tags:
      - Network Acl
  /?Action=DeleteNetworkAcl:
    post:
      operationId: DeleteNetworkAcl
      summary: Delete Network Acl
      description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteNetworkAcl
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteNetworkAclRequest'
            example:
              NetworkAclId: acl-5fb85d36
      tags:
      - Network Acl
  /?Action=DescribeNetworkAcls:
    post:
      operationId: DescribeNetworkAcls
      summary: Describe Network Acls
      description: Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria. For more information, see Network ACLs in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeNetworkAclsResult'
              example:
                NetworkAcls:
                - Associations:
                  - SubnetId: subnet-65ea5f08
                    NetworkAclId: acl-9aeb5ef7
                    NetworkAclAssociationId: aclassoc-66ea5f0b
                  NetworkAclId: acl-5fb85d36
                  VpcId: vpc-a01106c2
                  Tags: []
                  Entries:
                  - CidrBlock: 0.0.0.0/0
                    RuleNumber: 32767
                    Protocol: '-1'
                    Egress: true
                    RuleAction: deny
                  - CidrBlock: 0.0.0.0/0
                    RuleNumber: 32767
                    Protocol: '-1'
                    Egress: false
                    RuleAction: deny
                  IsDefault: false
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeNetworkAcls
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeNetworkAclsRequest'
            example:
              NetworkAclIds:
              - acl-5fb85d36
      tags:
      - Network Acl
components:
  schemas:
    DeleteNetworkAclRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        NetworkAclId:
          type: string
          description: The ID of the network ACL.
      required:
      - NetworkAclId
    PortRange:
      type: object
      properties:
        From:
          type: integer
          description: The first port in the range.
        To:
          type: integer
          description: The last port in the range.
    CreateNetworkAclRequest:
      type: object
      properties:
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the network ACL.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        VpcId:
          type: string
          description: The ID of the VPC.
      required:
      - VpcId
    IcmpTypeCode:
      type: object
      properties:
        Code:
          type: integer
          description: The ICMP code. A value of -1 means all codes for the specified ICMP type.
        Type:
          type: integer
          description: The ICMP type. A value of -1 means all types.
    DescribeNetworkAclsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        NetworkAclIds:
          type: array
          items:
            type: string
          description: The IDs of the network ACLs.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The filters. association.association-id - The ID of an association ID for the ACL. association.network-acl-id - The ID of the network ACL involved in the association. association.subnet-id - The ID of the subnet involved in the association. default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr - The IPv4 CIDR range specified in the entry. entry.icmp.code - The ICMP code specified in the entry, if any. entry.icmp.type - The ICMP type specified in the entry, if any. entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. entry.port-range.from - The start of
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    DescribeNetworkAclsResult:
      type: object
      properties:
        NetworkAcls:
          type: array
          items:
            $ref: '#/components/schemas/NetworkAcl'
          description: Information about the network ACLs.
        NextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
    NetworkAcl:
      type: object
      properties:
        Associations:
          type: array
          items:
            $ref: '#/components/schemas/NetworkAclAssociation'
          description: Any associations between the network ACL and your subnets
        Entries:
          type: array
          items:
            $ref: '#/components/schemas/NetworkAclEntry'
          description: The entries (rules) in the network ACL.
        IsDefault:
          type: boolean
          description: Indicates whether this is the default network ACL for the VPC.
        NetworkAclId:
          type: string
          description: The ID of the network ACL.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the network ACL.
        VpcId:
          type: string
          description: The ID of the VPC for the network ACL.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the network ACL.
    CreateNetworkAclResult:
      type: object
      properties:
        NetworkAcl:
          $ref: '#/components/schemas/NetworkAcl'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
    NetworkAclEntry:
      type: object
      properties:
        CidrBlock:
          type: string
          description: The IPv4 network range to allow or deny, in CIDR notation.
        Egress:
          type: boolean
          description: Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
        IcmpTypeCode:
          $ref: '#/components/schemas/IcmpTypeCode'
        Ipv6CidrBlock:
          type: string
          description: The IPv6 network range to allow or deny, in CIDR notation.
        PortRange:
          $ref: '#/components/schemas/PortRange'
        Protocol:
          type: string
          description: The protocol number. A value of "-1" means all protocols.
        RuleAction:
          type: string
          enum:
          - allow
          - deny
          description: Indicates whether to allow or deny the traffic that matches the rule.
        RuleNumber:
          type: integer
          description: The rule number for the entry. ACL entries are processed in ascending order by rule number.
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    NetworkAclAssociation:
      type: object
      properties:
        NetworkAclAssociationId:
          type: string
          description: The ID of the association between a network ACL and a subnet.
        NetworkAclId:
          type: string
          description: The ID of the network ACL.
        SubnetId:
          type: string
          description: The ID of the subnet.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)