Skip to content

Describe Vpc Endpoint Services

ec2_describe_vpc_endpoint_services R Documentation

Describes available services to which you can create a VPC endpoint

Description

Describes available services to which you can create a VPC endpoint.

When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses ⁠us-east-1a⁠ and ⁠us-east-1c⁠ and the consumer uses ⁠us-east-1a⁠ and ⁠us-east-1b⁠, the response includes the VPC endpoint services in the common Availability Zone, ⁠us-east-1a⁠.

Usage

ec2_describe_vpc_endpoint_services(DryRun, ServiceNames, 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.

ServiceNames

The service names.

Filters

The filters.

  • owner - The ID or alias of the Amazon Web Services account that owns the service.

  • service-name - The name of the service.

  • service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).

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

  • 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.

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(
  ServiceNames = list(
    "string"
  ),
  ServiceDetails = list(
    list(
      ServiceName = "string",
      ServiceId = "string",
      ServiceType = list(
        list(
          ServiceType = "Interface"|"Gateway"|"GatewayLoadBalancer"
        )
      ),
      AvailabilityZones = list(
        "string"
      ),
      Owner = "string",
      BaseEndpointDnsNames = list(
        "string"
      ),
      PrivateDnsName = "string",
      PrivateDnsNames = list(
        list(
          PrivateDnsName = "string"
        )
      ),
      VpcEndpointPolicySupported = TRUE|FALSE,
      AcceptanceRequired = TRUE|FALSE,
      ManagesVpcEndpoints = TRUE|FALSE,
      PayerResponsibility = "ServiceOwner",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      PrivateDnsNameVerificationState = "pendingVerification"|"verified"|"failed",
      SupportedIpAddressTypes = list(
        "ipv4"|"ipv6"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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