Amazon EC2 Ec2 Vpc Endpoint Service Configuration API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Vpc Endpoint Service…
  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 Endpoint Service Configuration
paths:
  /?Action=CreateVpcEndpointServiceConfiguration:
    post:
      operationId: CreateVpcEndpointServiceConfiguration
      summary: Create Vpc Endpoint Service Configuration
      description: 'Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect. Before you create an endpoint service, you must create one of the following for your service: A Network Load Balancer. Service consumers connect to your service using an interface endpoint. A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint. If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see the Amazon Web Services PrivateLink Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVpcEndpointServiceConfiguration
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationRequest'
      tags:
      - Vpc Endpoint Service Configuration
  /?Action=DeleteVpcEndpointServiceConfigurations:
    post:
      operationId: DeleteVpcEndpointServiceConfigurations
      summary: Delete Vpc Endpoint Service Configurations
      description: Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVpcEndpointServiceConfigurations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsRequest'
      tags:
      - Vpc Endpoint Service Configuration
  /?Action=DescribeVpcEndpointServiceConfigurations:
    post:
      operationId: DescribeVpcEndpointServiceConfigurations
      summary: Describe Vpc Endpoint Service Configurations
      description: Describes the VPC endpoint service configurations in your account (your services).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeVpcEndpointServiceConfigurations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsRequest'
      tags:
      - Vpc Endpoint Service Configuration
  /?Action=ModifyVpcEndpointServiceConfiguration:
    post:
      operationId: ModifyVpcEndpointServiceConfiguration
      summary: Modify Vpc Endpoint Service Configuration
      description: Modifies the attributes of the specified VPC endpoint service configuration. If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyVpcEndpointServiceConfiguration
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationRequest'
      tags:
      - Vpc Endpoint Service Configuration
components:
  schemas:
    PrivateDnsNameConfiguration:
      type: object
      properties:
        State:
          type: string
          enum:
          - pendingVerification
          - verified
          - failed
          description: The verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
        Type:
          type: string
          description: The endpoint service verification type, for example TXT.
        Value:
          type: string
          description: The value the service provider adds to the private DNS name domain record before verification.
        Name:
          type: string
          description: The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.
    UnsuccessfulItem:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/UnsuccessfulItemError'
        ResourceId:
          type: string
          description: The ID of the resource.
    CreateVpcEndpointServiceConfigurationResult:
      type: object
      properties:
        ServiceConfiguration:
          $ref: '#/components/schemas/ServiceConfiguration'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    DeleteVpcEndpointServiceConfigurationsResult:
      type: object
      properties:
        Unsuccessful:
          type: array
          items:
            $ref: '#/components/schemas/UnsuccessfulItem'
          description: Information about the service configurations that were not deleted, if applicable.
    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.'
    ModifyVpcEndpointServiceConfigurationResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Returns true if the request succeeds; otherwise, it returns an error.
    UnsuccessfulItemError:
      type: object
      properties:
        Code:
          type: string
          description: The error code.
        Message:
          type: string
          description: The error message accompanying the error code.
    ServiceTypeDetail:
      type: object
      properties:
        ServiceType:
          type: string
          enum:
          - Interface
          - Gateway
          - GatewayLoadBalancer
          description: The type of service.
    SupportedRegionDetail:
      type: object
      properties:
        Region:
          type: string
          description: The Region code.
        ServiceState:
          type: string
          description: The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
    ModifyVpcEndpointServiceConfigurationRequest:
      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.
        ServiceId:
          type: string
          description: The ID of the service.
        PrivateDnsName:
          type: string
          description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service.
        RemovePrivateDnsName:
          type: boolean
          description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
        AcceptanceRequired:
          type: boolean
          description: Indicates whether requests to create an endpoint to the service must be accepted.
        AddNetworkLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.
        RemoveNetworkLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.
        AddGatewayLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.
        RemoveGatewayLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.
        AddSupportedIpAddressTypes:
          type: array
          items:
            type: string
          description: The IP address types to add to the service configuration.
        RemoveSupportedIpAddressTypes:
          type: array
          items:
            type: string
          description: The IP address types to remove from the service configuration.
        AddSupportedRegions:
          type: array
          items:
            type: string
          description: The supported Regions to add to the service configuration.
        RemoveSupportedRegions:
          type: array
          items:
            type: string
          description: The supported Regions to remove from the service configuration.
      required:
      - ServiceId
    ServiceConfiguration:
      type: object
      properties:
        ServiceType:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTypeDetail'
          description: The type of service.
        ServiceId:
          type: string
          description: The ID of the service.
        ServiceName:
          type: string
          description: The name of the service.
        ServiceState:
          type: string
          enum:
          - Pending
          - Available
          - Deleting
          - Deleted
          - Failed
          description: The service state.
        AvailabilityZoneIds:
          type: array
          items:
            type: string
          description: The IDs of the Availability Zones in which the service is available. Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
        AvailabilityZones:
          type: array
          items:
            type: string
          description: The Availability Zones in which the service is available. Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
        AcceptanceRequired:
          type: boolean
          description: Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
        ManagesVpcEndpoints:
          type: boolean
          description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
        NetworkLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
        GatewayLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
        SupportedIpAddressTypes:
          type: array
          items:
            type: string
            enum:
            - ipv4
            - ipv6
          description: The supported IP address types.
        BaseEndpointDnsNames:
          type: array
          items:
            type: string
          description: The DNS names for the service.
        PrivateDnsName:
          type: string
          description: The private DNS name for the service.
        PrivateDnsNameConfiguration:
          $ref: '#/components/schemas/PrivateDnsNameConfiguration'
        PayerResponsibility:
          type: string
          enum:
          - ServiceOwner
          description: The payer responsibility.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the service.
        SupportedRegions:
          type: array
          items:
            $ref: '#/components/schemas/SupportedRegionDetail'
          description: The supported Regions.
        RemoteAccessEnabled:
          type: boolean
          description: Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
    DescribeVpcEndpointServiceConfigurationsRequest:
      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.
        ServiceIds:
          type: array
          items:
            type: string
          description: The IDs of the endpoint services.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed). supported-ip-address-types - The IP address type (ipv4 | ipv6). 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. tag-key - The key of a tag assigned to the resourc'
        MaxResults:
          type: integer
          description: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
        NextToken:
          type: string
          description: The token to retrieve the next page of results.
    DeleteVpcEndpointServiceConfigurationsRequest:
      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.
        ServiceIds:
          type: array
          items:
            type: string
          description: The IDs of the services.
      required:
      - ServiceIds
    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.
    DescribeVpcEndpointServiceConfigurationsResult:
      type: object
      properties:
        ServiceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ServiceConfiguration'
          description: Information about the services.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    CreateVpcEndpointServiceConfigurationRequest:
      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.
        AcceptanceRequired:
          type: boolean
          description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
        PrivateDnsName:
          type: string
          description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
        NetworkLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Network Load Balancers.
        GatewayLoadBalancerArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
        SupportedIpAddressTypes:
          type: array
          items:
            type: string
          description: The supported IP address types. The possible values are ipv4 and ipv6.
        SupportedRegions:
          type: array
          items:
            type: string
          description: The Regions from which service consumers can access the service.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to associate with the service.
  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)