Amazon PrivateLink Principals API

openapi: 3.0.3
info:
  title: Amazon PrivateLink Endpoint Connections Principals API
  description: AWS PrivateLink provides private connectivity between VPCs, AWS services, and on-premises networks without exposing traffic to the public internet. This API covers VPC endpoint services, VPC endpoints, and endpoint connections.
  version: '2016-11-15'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-generated-from: documentation
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Amazon EC2 regional endpoint (PrivateLink operations)
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- sigv4: []
tags:
- name: Principals
  description: Endpoint service principal management
paths:
  /?Action=ModifyVpcEndpointServicePermissions:
    post:
      operationId: ModifyVpcEndpointServicePermissions
      summary: Amazon PrivateLink Modify VPC Endpoint Service Permissions
      description: Modifies the permissions for a VPC endpoint service, adding or removing principal ARNs.
      tags:
      - Principals
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsRequest'
      responses:
        '200':
          description: Service permissions modified
  /?Action=DescribeVpcEndpointServicePermissions:
    get:
      operationId: DescribeVpcEndpointServicePermissions
      summary: Amazon PrivateLink Describe VPC Endpoint Service Permissions
      description: Describes the principals (service consumers) that are permitted to discover or connect to your endpoint service.
      tags:
      - Principals
      parameters:
      - name: ServiceId
        in: query
        required: true
        schema:
          type: string
        description: The ID of the endpoint service
      - name: MaxResults
        in: query
        schema:
          type: integer
        description: Maximum number of results
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
      responses:
        '200':
          description: Service permissions retrieved
components:
  schemas:
    ModifyVpcEndpointServicePermissionsRequest:
      type: object
      required:
      - ServiceId
      properties:
        ServiceId:
          type: string
          description: ID of the endpoint service
        AddAllowedPrincipals:
          type: array
          items:
            type: string
          description: Principal ARNs to allow
        RemoveAllowedPrincipals:
          type: array
          items:
            type: string
          description: Principal ARNs to remove
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4