[ aws . ec2 ]

describe-vpc-endpoint-connection-notifications

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-vpc-endpoint-connection-notifications is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ConnectionNotificationSet

Synopsis

  describe-vpc-endpoint-connection-notifications
[--dry-run | --no-dry-run]
[--connection-notification-id <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--dry-run | --no-dry-run (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 .

--connection-notification-id (string)

The ID of the notification.

--filters (list)

One or more 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.

(structure)

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.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe endpoint connection notifications

The following describe-vpc-endpoint-connection-notifications example describes all of your endpoint connection notifications.

aws ec2 describe-vpc-endpoint-connection-notifications

Output:

{
   "ConnectionNotificationSet": [
       {
           "ConnectionNotificationState": "Enabled",
           "ConnectionNotificationType": "Topic",
           "ConnectionEvents": [
               "Accept",
               "Reject",
               "Delete",
               "Connect"
           ],
           "ConnectionNotificationId": "vpce-nfn-04bcb952bc8af7abc",
           "ConnectionNotificationArn": "arn:aws:sns:us-east-1:123456789012:VpceNotification",
           "VpcEndpointId": "vpce-0324151a02f327123"
       }
   ]
 }

Output

ConnectionNotificationSet -> (list)

One or more notifications.

(structure)

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.

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.