Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DescribeVpcEndpointServicesCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeVpcEndpointServicesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeVpcEndpointServicesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeVpcEndpointServicesRequest
DryRun: true || false,
ServiceNames: [ // ValueStringList
"STRING_VALUE",
],
Filters: [ // FilterList
{ // Filter
Name: "STRING_VALUE",
Values: [
"STRING_VALUE",
],
},
],
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new DescribeVpcEndpointServicesCommand(input);
const response = await client.send(command);
// { // DescribeVpcEndpointServicesResult
// ServiceNames: [ // ValueStringList
// "STRING_VALUE",
// ],
// ServiceDetails: [ // ServiceDetailSet
// { // ServiceDetail
// ServiceName: "STRING_VALUE",
// ServiceId: "STRING_VALUE",
// ServiceType: [ // ServiceTypeDetailSet
// { // ServiceTypeDetail
// ServiceType: "Interface" || "Gateway" || "GatewayLoadBalancer",
// },
// ],
// AvailabilityZones: [
// "STRING_VALUE",
// ],
// Owner: "STRING_VALUE",
// BaseEndpointDnsNames: [
// "STRING_VALUE",
// ],
// PrivateDnsName: "STRING_VALUE",
// PrivateDnsNames: [ // PrivateDnsDetailsSet
// { // PrivateDnsDetails
// PrivateDnsName: "STRING_VALUE",
// },
// ],
// VpcEndpointPolicySupported: true || false,
// AcceptanceRequired: true || false,
// ManagesVpcEndpoints: true || false,
// PayerResponsibility: "ServiceOwner",
// Tags: [ // TagList
// { // Tag
// Key: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// PrivateDnsNameVerificationState: "pendingVerification" || "verified" || "failed",
// SupportedIpAddressTypes: [ // SupportedIpAddressTypes
// "ipv4" || "ipv6",
// ],
// },
// ],
// NextToken: "STRING_VALUE",
// };

Param

DescribeVpcEndpointServicesCommandInput

Returns

DescribeVpcEndpointServicesCommandOutput

See

Throws

EC2ServiceException

Base exception class for all service exceptions from EC2 service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods