Amazon EC2 Ec2 Vpc Endpoint Connection Notification API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Vpc Endpoint Connection…
  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 Connection Notification
paths:
  /?Action=CreateVpcEndpointConnectionNotification:
    post:
      operationId: CreateVpcEndpointConnectionNotification
      summary: Create Vpc Endpoint Connection Notification
      description: Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. You can create a connection notification for interface endpoints only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVpcEndpointConnectionNotification
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationRequest'
      tags:
      - Vpc Endpoint Connection Notification
  /?Action=DeleteVpcEndpointConnectionNotifications:
    post:
      operationId: DeleteVpcEndpointConnectionNotifications
      summary: Delete Vpc Endpoint Connection Notifications
      description: Deletes the specified VPC endpoint connection notifications.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVpcEndpointConnectionNotifications
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsRequest'
      tags:
      - Vpc Endpoint Connection Notification
  /?Action=DescribeVpcEndpointConnectionNotifications:
    post:
      operationId: DescribeVpcEndpointConnectionNotifications
      summary: Describe Vpc Endpoint Connection Notifications
      description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeVpcEndpointConnectionNotifications
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsRequest'
      tags:
      - Vpc Endpoint Connection Notification
  /?Action=ModifyVpcEndpointConnectionNotification:
    post:
      operationId: ModifyVpcEndpointConnectionNotification
      summary: Modify Vpc Endpoint Connection Notification
      description: Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyVpcEndpointConnectionNotification
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest'
      tags:
      - Vpc Endpoint Connection Notification
components:
  schemas:
    DeleteVpcEndpointConnectionNotificationsResult:
      type: object
      properties:
        Unsuccessful:
          type: array
          items:
            $ref: '#/components/schemas/UnsuccessfulItem'
          description: Information about the notifications that could not be deleted successfully.
    CreateVpcEndpointConnectionNotificationResult:
      type: object
      properties:
        ConnectionNotification:
          $ref: '#/components/schemas/ConnectionNotification'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    DeleteVpcEndpointConnectionNotificationsRequest:
      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.
        ConnectionNotificationIds:
          type: array
          items:
            type: string
          description: The IDs of the notifications.
      required:
      - ConnectionNotificationIds
    UnsuccessfulItemError:
      type: object
      properties:
        Code:
          type: string
          description: The error code.
        Message:
          type: string
          description: The error message accompanying the error code.
    ModifyVpcEndpointConnectionNotificationRequest:
      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.
        ConnectionNotificationId:
          type: string
          description: The ID of the notification.
        ConnectionNotificationArn:
          type: string
          description: The ARN for the SNS topic for the notification.
        ConnectionEvents:
          type: array
          items:
            type: string
          description: The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.
      required:
      - ConnectionNotificationId
    DescribeVpcEndpointConnectionNotificationsRequest:
      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.
        ConnectionNotificationId:
          type: string
          description: The ID of the notification.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The filters. connection-notification-arn - The ARN of the SNS topic for the notification. connection-notification-id - The ID of the notification. connection-notification-state - The state of the notification (Enabled | Disabled). connection-notification-type - The type of notification (Topic). service-id - The ID of the endpoint service. vpc-endpoint-id - The ID of the VPC endpoint.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.
        NextToken:
          type: string
          description: The token to request the next page of results.
    CreateVpcEndpointConnectionNotificationRequest:
      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 endpoint service.
        VpcEndpointId:
          type: string
          description: The ID of the endpoint.
        ConnectionNotificationArn:
          type: string
          description: The ARN of the SNS topic for the notifications.
        ConnectionEvents:
          type: array
          items:
            type: string
          description: The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
        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.
      required:
      - ConnectionNotificationArn
      - ConnectionEvents
    ModifyVpcEndpointConnectionNotificationResult:
      type: object
      properties:
        ReturnValue:
          type: boolean
          description: Returns true if the request succeeds; otherwise, it returns an error.
    UnsuccessfulItem:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/UnsuccessfulItemError'
        ResourceId:
          type: string
          description: The ID of the resource.
    DescribeVpcEndpointConnectionNotificationsResult:
      type: object
      properties:
        ConnectionNotificationSet:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionNotification'
          description: The notifications.
        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.
    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.
    ConnectionNotification:
      type: object
      properties:
        ConnectionNotificationId:
          type: string
          description: The ID of the notification.
        ServiceId:
          type: string
          description: The ID of the endpoint service.
        VpcEndpointId:
          type: string
          description: The ID of the VPC endpoint.
        ConnectionNotificationType:
          type: string
          enum:
          - Topic
          description: The type of notification.
        ConnectionNotificationArn:
          type: string
          description: The ARN of the SNS topic for the notification.
        ConnectionEvents:
          type: array
          items:
            type: string
          description: The events for the notification. Valid values are Accept, Connect, Delete, and Reject.
        ConnectionNotificationState:
          type: string
          enum:
          - Enabled
          - Disabled
          description: The state of the notification.
        ServiceRegion:
          type: string
          description: The Region for the endpoint 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)