Skip to content

Describe Vpc Endpoints

ec2_describe_vpc_endpoints R Documentation

Describes your VPC endpoints

Description

Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.

Usage

ec2_describe_vpc_endpoints(DryRun, VpcEndpointIds, Filters, MaxResults,
  NextToken)

Arguments

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.

VpcEndpointIds

The IDs of the VPC endpoints.

Filters

The filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).

  • service-name - The name of the service.

  • tag:\<key\> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id - The ID of the endpoint.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

MaxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1,000, we return only 1,000 items.

NextToken

The token for the next set of items to return. (You received this token from a prior call.)

Value

A list with the following syntax: 

list(
  VpcEndpoints = list(
    list(
      VpcEndpointId = "string",
      VpcEndpointType = "Interface"|"Gateway"|"GatewayLoadBalancer",
      VpcId = "string",
      ServiceName = "string",
      State = "PendingAcceptance"|"Pending"|"Available"|"Deleting"|"Deleted"|"Rejected"|"Failed"|"Expired",
      PolicyDocument = "string",
      RouteTableIds = list(
        "string"
      ),
      SubnetIds = list(
        "string"
      ),
      Groups = list(
        list(
          GroupId = "string",
          GroupName = "string"
        )
      ),
      IpAddressType = "ipv4"|"dualstack"|"ipv6",
      DnsOptions = list(
        DnsRecordIpType = "ipv4"|"dualstack"|"ipv6"|"service-defined",
        PrivateDnsOnlyForInboundResolverEndpoint = TRUE|FALSE
      ),
      PrivateDnsEnabled = TRUE|FALSE,
      RequesterManaged = TRUE|FALSE,
      NetworkInterfaceIds = list(
        "string"
      ),
      DnsEntries = list(
        list(
          DnsName = "string",
          HostedZoneId = "string"
        )
      ),
      CreationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      OwnerId = "string",
      LastError = list(
        Message = "string",
        Code = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_vpc_endpoints(
  DryRun = TRUE|FALSE,
  VpcEndpointIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)