Request Parameters Response Elements Errors Examples See Also

CreateVpcEndpointConnectionNotification

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 Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Type: String

Required: No

ConnectionEvents.N

The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.

Type: Array of strings

Required: Yes

ConnectionNotificationArn

The ARN of the SNS topic for the notifications.

Type: String

Required: Yes

DryRun

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.

Type: Boolean

Required: No

ServiceId

The ID of the endpoint service.

Type: String

Required: No

VpcEndpointId

The ID of the endpoint.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

connectionNotification

Information about the notification.

Type: ConnectionNotification object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example creates a notification for the endpoint vpce-1234151a02f327123. The notification is sent when the endpoint is rejected or deleted.

Sample Request


https://ec2.amazonaws.com/?Action=CreateVpcEndpointConnectionNotification
&VpcEndpointId=vpce-1234151a02f327123
&ConnectionNotificationArn=arn:aws:sns:us-east-1:123456789012:endpointtopic
&ConnectionEvents.1=Reject
&ConnectionEvents.2=Delete
&AUTHPARAMS

Sample Response


<CreateVpcEndpointConnectionNotificationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>6bf51e2a-a99e-4839-af31-a0d72example</requestId>
    <connectionNotification>
        <connectionNotificationArn>arn:aws:sns:us-east-1:123456789012:endpointtopic</connectionNotificationArn>
        <connectionEvents>
            <item>Delete</item>
            <item>Reject</item>
        </connectionEvents>
        <connectionNotificationType>Topic</connectionNotificationType>
        <connectionNotificationState>Enabled</connectionNotificationState>
        <connectionNotificationId>vpce-nfn-04bcb952bc8af759b</connectionNotificationId>
        <vpcEndpointId>vpce-1234151a02f327123</vpcEndpointId>
    </connectionNotification>
</CreateVpcEndpointConnectionNotificationResponse>