EC2 / Client / describe_vpc_endpoint_connection_notifications

describe_vpc_endpoint_connection_notifications#

EC2.Client.describe_vpc_endpoint_connection_notifications(**kwargs)#

Describes the connection notifications for VPC endpoints and VPC endpoint services.

Request Syntax

response = client.describe_vpc_endpoint_connection_notifications(
    DryRun=True|False,
    ConnectionNotificationId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='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.
ConnectionNotificationId (string) – The ID of the notification.
Filters (list) –
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.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    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.
    - (string) –
MaxResults (integer) – 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 (string) – The token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ConnectionNotificationSet (list) –
  
  The notifications.
  - (dict) –
    
    Describes a connection notification for a VPC endpoint or VPC endpoint service.
    - 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.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.