EC2 / Client / create_vpc_endpoint_connection_notification

create_vpc_endpoint_connection_notification#

EC2.Client.create_vpc_endpoint_connection_notification(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_endpoint_connection_notification(
    DryRun=True|False,
    ServiceId='string',
    VpcEndpointId='string',
    ConnectionNotificationArn='string',
    ConnectionEvents=[
        'string',
    ],
    ClientToken='string'
)
Parameters:

  • DryRun (boolean) – 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 (string) – The ID of the endpoint service.

  • VpcEndpointId (string) – The ID of the endpoint.

  • ConnectionNotificationArn (string) –

    [REQUIRED]

    The ARN of the SNS topic for the notifications.

  • ConnectionEvents (list) –

    [REQUIRED]

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

    • (string) –

  • ClientToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionNotification': {
        'ConnectionNotificationId': 'string',
        'ServiceId': 'string',
        'VpcEndpointId': 'string',
        'ConnectionNotificationType': 'Topic',
        'ConnectionNotificationArn': 'string',
        'ConnectionEvents': [
            'string',
        ],
        'ConnectionNotificationState': 'Enabled'|'Disabled',
        'ServiceRegion': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

  • (dict) –

    • ConnectionNotification (dict) –

      Information about the notification.

      • ConnectionNotificationId (string) –

        The ID of the notification.

      • ServiceId (string) –

        The ID of the endpoint service.

      • VpcEndpointId (string) –

        The ID of the VPC endpoint.

      • ConnectionNotificationType (string) –

        The type of notification.

      • ConnectionNotificationArn (string) –

        The ARN of the SNS topic for the notification.

      • ConnectionEvents (list) –

        The events for the notification. Valid values are Accept, Connect, Delete, and Reject.

        • (string) –

      • ConnectionNotificationState (string) –

        The state of the notification.

      • ServiceRegion (string) –

        The Region for the endpoint service.

    • ClientToken (string) –

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