Amazon EC2 Ec2 Vpc Block Public Access Exclusion API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Vpc Block Public Access…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Vpc Block Public Access Exclusion
paths:
  /?Action=CreateVpcBlockPublicAccessExclusion:
    post:
      operationId: CreateVpcBlockPublicAccessExclusion
      summary: Create Vpc Block Public Access Exclusion
      description: Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVpcBlockPublicAccessExclusionResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVpcBlockPublicAccessExclusion
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateVpcBlockPublicAccessExclusionRequest'
      tags:
      - Vpc Block Public Access Exclusion
  /?Action=DeleteVpcBlockPublicAccessExclusion:
    post:
      operationId: DeleteVpcBlockPublicAccessExclusion
      summary: Delete Vpc Block Public Access Exclusion
      description: Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteVpcBlockPublicAccessExclusionResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVpcBlockPublicAccessExclusion
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteVpcBlockPublicAccessExclusionRequest'
      tags:
      - Vpc Block Public Access Exclusion
  /?Action=DescribeVpcBlockPublicAccessExclusions:
    post:
      operationId: DescribeVpcBlockPublicAccessExclusions
      summary: Describe Vpc Block Public Access Exclusions
      description: Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeVpcBlockPublicAccessExclusionsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeVpcBlockPublicAccessExclusions
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeVpcBlockPublicAccessExclusionsRequest'
      tags:
      - Vpc Block Public Access Exclusion
  /?Action=ModifyVpcBlockPublicAccessExclusion:
    post:
      operationId: ModifyVpcBlockPublicAccessExclusion
      summary: Modify Vpc Block Public Access Exclusion
      description: Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyVpcBlockPublicAccessExclusionResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyVpcBlockPublicAccessExclusion
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyVpcBlockPublicAccessExclusionRequest'
      tags:
      - Vpc Block Public Access Exclusion
components:
  schemas:
    CreateVpcBlockPublicAccessExclusionRequest:
      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.
        SubnetId:
          type: string
          description: A subnet ID.
        VpcId:
          type: string
          description: A VPC ID.
        InternetGatewayExclusionMode:
          type: string
          enum:
          - allow-bidirectional
          - allow-egress
          description: 'The exclusion mode for internet gateway traffic. allow-bidirectional: Allow all internet traffic to and from the excluded VPCs and subnets. allow-egress: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional.'
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
      required:
      - InternetGatewayExclusionMode
    DeleteVpcBlockPublicAccessExclusionRequest:
      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.
        ExclusionId:
          type: string
          description: The ID of the exclusion.
      required:
      - ExclusionId
    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.'
    ModifyVpcBlockPublicAccessExclusionResult:
      type: object
      properties:
        VpcBlockPublicAccessExclusion:
          $ref: '#/components/schemas/VpcBlockPublicAccessExclusion'
    DescribeVpcBlockPublicAccessExclusionsRequest:
      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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'Filters for the request: resource-arn - The Amazon Resource Name (ARN) of a exclusion. internet-gateway-exclusion-mode - The mode of a VPC BPA exclusion. Possible values: allow-bidirectional | allow-egress. state - The state of VPC BPA. Possible values: create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | deleted-complete | disable-in-progress | disable-complete tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a t'
        ExclusionIds:
          type: array
          items:
            type: string
          description: IDs of exclusions.
        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.
    ModifyVpcBlockPublicAccessExclusionRequest:
      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.
        ExclusionId:
          type: string
          description: The ID of an exclusion.
        InternetGatewayExclusionMode:
          type: string
          enum:
          - allow-bidirectional
          - allow-egress
          description: 'The exclusion mode for internet gateway traffic. allow-bidirectional: Allow all internet traffic to and from the excluded VPCs and subnets. allow-egress: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional.'
      required:
      - ExclusionId
      - InternetGatewayExclusionMode
    DescribeVpcBlockPublicAccessExclusionsResult:
      type: object
      properties:
        VpcBlockPublicAccessExclusions:
          type: array
          items:
            $ref: '#/components/schemas/VpcBlockPublicAccessExclusion'
          description: Details related to the exclusions.
        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.
    CreateVpcBlockPublicAccessExclusionResult:
      type: object
      properties:
        VpcBlockPublicAccessExclusion:
          $ref: '#/components/schemas/VpcBlockPublicAccessExclusion'
    VpcBlockPublicAccessExclusion:
      type: object
      properties:
        ExclusionId:
          type: string
          description: The ID of the exclusion.
        InternetGatewayExclusionMode:
          type: string
          enum:
          - allow-bidirectional
          - allow-egress
          description: 'The exclusion mode for internet gateway traffic. allow-bidirectional: Allow all internet traffic to and from the excluded VPCs and subnets. allow-egress: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional.'
        ResourceArn:
          type: string
          description: The ARN of the exclusion.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - update-in-progress
          - update-complete
          - update-failed
          - delete-in-progress
          - delete-complete
          - disable-in-progress
          - disable-complete
          description: The state of the exclusion.
        Reason:
          type: string
          description: The reason for the current exclusion state.
        CreationTimestamp:
          type: string
          format: date-time
          description: When the exclusion was created.
        LastUpdateTimestamp:
          type: string
          format: date-time
          description: When the exclusion was last updated.
        DeletionTimestamp:
          type: string
          format: date-time
          description: When the exclusion was deleted.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    DeleteVpcBlockPublicAccessExclusionResult:
      type: object
      properties:
        VpcBlockPublicAccessExclusion:
          $ref: '#/components/schemas/VpcBlockPublicAccessExclusion'
    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.
    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)