Skip to content

describe_vpc_endpoint_connection_notifications

describe_vpc_endpoint_connection_notifications(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    connection_notification_id: Optional[ConnectionNotificationId] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
) -> DescribeVpcEndpointConnectionNotificationsResult

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

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    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.

  • connection_notification_id (Optional[ConnectionNotificationId], default: None ) –

    The ID of the notification.

  • filters (Optional[FilterList], default: None ) –

    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.

  • max_results (Optional[Integer], default: None ) –

    The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.

  • next_token (Optional[String], default: None ) –

    The token to request the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_vpc_endpoint_connection_notifications(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    connection_notification_id: Optional[
        "capo_ec2.types.connection_notification_id.ConnectionNotificationId"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.describe_vpc_endpoint_connection_notifications_result.DescribeVpcEndpointConnectionNotificationsResult":
    """<p>Describes the connection notifications for VPC endpoints and VPC endpoint services.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        connection_notification_id: <p>The ID of the notification.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>connection-notification-arn</code> - The ARN of the SNS topic for the notification.</p> </li> <li> <p> <code>connection-notification-id</code> - The ID of the notification.</p> </li> <li> <p> <code>connection-notification-state</code> - The state of the notification (<code>Enabled</code> | <code>Disabled</code>).</p> </li> <li> <p> <code>connection-notification-type</code> - The type of notification (<code>Topic</code>).</p> </li> <li> <p> <code>service-id</code> - The ID of the endpoint service.</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the VPC endpoint.</p> </li> </ul>
        max_results: <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned <code>NextToken</code> value.</p>
        next_token: <p>The token to request the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_vpc_endpoint_connection_notifications_request.DescribeVpcEndpointConnectionNotificationsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_vpc_endpoint_connection_notifications_result.DescribeVpcEndpointConnectionNotificationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_vpc_endpoint_connection_notifications

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_vpc_endpoint_connection_notifications.describe_vpc_endpoint_connection_notifications(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeVpcEndpointConnectionNotifications"),
    )
    input_: capo_ec2.types.describe_vpc_endpoint_connection_notifications_request.DescribeVpcEndpointConnectionNotificationsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if connection_notification_id is not None:
        input_["connection_notification_id"] = connection_notification_id
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output