Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-vpc-endpoint-services

Description

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

See also: AWS API Documentation

Synopsis

  describe-vpc-endpoint-services
[--dry-run | --no-dry-run]
[--service-names <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <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 .

--service-names (list)

One or more service names.

Syntax:

"string" "string" ...

--filters (list)

One or more filters.

  • service-name : The name of the service.

Shorthand Syntax:

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

JSON Syntax:

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

--max-results (integer)

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 1000, we return only 1000 items.

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Examples

To describe VPC endpoint services

This example describes all available endpoint services for the region.

Command:

aws ec2 describe-vpc-endpoint-services

Output:

{
  "ServiceDetails": [
      {
          "ServiceType": [
              {
                  "ServiceType": "Gateway"
              }
          ],
          "AcceptanceRequired": false,
          "ServiceName": "com.amazonaws.us-east-1.dynamodb",
          "VpcEndpointPolicySupported": true,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "BaseEndpointDnsNames": [
              "dynamodb.us-east-1.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Interface"
              }
          ],
          "PrivateDnsName": "ec2.us-east-1.amazonaws.com",
          "ServiceName": "com.amazonaws.us-east-1.ec2",
          "VpcEndpointPolicySupported": false,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "AcceptanceRequired": false,
          "BaseEndpointDnsNames": [
              "ec2.us-east-1.vpce.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Interface"
              }
          ],
          "PrivateDnsName": "ec2messages.us-east-1.amazonaws.com",
          "ServiceName": "com.amazonaws.us-east-1.ec2messages",
          "VpcEndpointPolicySupported": false,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "AcceptanceRequired": false,
          "BaseEndpointDnsNames": [
              "ec2messages.us-east-1.vpce.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Interface"
              }
          ],
          "PrivateDnsName": "elasticloadbalancing.us-east-1.amazonaws.com",
          "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing",
          "VpcEndpointPolicySupported": false,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "AcceptanceRequired": false,
          "BaseEndpointDnsNames": [
              "elasticloadbalancing.us-east-1.vpce.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Interface"
              }
          ],
          "PrivateDnsName": "kinesis.us-east-1.amazonaws.com",
          "ServiceName": "com.amazonaws.us-east-1.kinesis-streams",
          "VpcEndpointPolicySupported": false,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "AcceptanceRequired": false,
          "BaseEndpointDnsNames": [
              "kinesis.us-east-1.vpce.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Gateway"
              }
          ],
          "AcceptanceRequired": false,
          "ServiceName": "com.amazonaws.us-east-1.s3",
          "VpcEndpointPolicySupported": true,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e",
              "us-east-1f"
          ],
          "BaseEndpointDnsNames": [
              "s3.us-east-1.amazonaws.com"
          ]
      },
      {
          "ServiceType": [
              {
                  "ServiceType": "Interface"
              }
          ],
          "PrivateDnsName": "ssm.us-east-1.amazonaws.com",
          "ServiceName": "com.amazonaws.us-east-1.ssm",
          "VpcEndpointPolicySupported": true,
          "Owner": "amazon",
          "AvailabilityZones": [
              "us-east-1a",
              "us-east-1b",
              "us-east-1c",
              "us-east-1d",
              "us-east-1e"
          ],
          "AcceptanceRequired": false,
          "BaseEndpointDnsNames": [
              "ssm.us-east-1.vpce.amazonaws.com"
          ]
      }
  ],
  "ServiceNames": [
      "com.amazonaws.us-east-1.dynamodb",
      "com.amazonaws.us-east-1.ec2",
      "com.amazonaws.us-east-1.ec2messages",
      "com.amazonaws.us-east-1.elasticloadbalancing",
      "com.amazonaws.us-east-1.kinesis-streams",
      "com.amazonaws.us-east-1.s3",
      "com.amazonaws.us-east-1.ssm"
  ]
}

Output

ServiceNames -> (list)

A list of supported services.

(string)

ServiceDetails -> (list)

Information about the service.

(structure)

Describes a VPC endpoint service.

ServiceName -> (string)

The Amazon Resource Name (ARN) of the service.

ServiceType -> (list)

The type of service.

(structure)

Describes the type of service for a VPC endpoint.

ServiceType -> (string)

The type of service.

AvailabilityZones -> (list)

The Availability Zones in which the service is available.

(string)

Owner -> (string)

The AWS account ID of the service owner.

BaseEndpointDnsNames -> (list)

The DNS names for the service.

(string)

PrivateDnsName -> (string)

The private DNS name for the service.

VpcEndpointPolicySupported -> (boolean)

Indicates whether the service supports endpoint policies.

AcceptanceRequired -> (boolean)

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.