[ aws . ec2 ]

describe-vpc-endpoint-services

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-vpc-endpoint-services 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: ServiceDetails, ServiceNames

Synopsis

  describe-vpc-endpoint-services
[--dry-run | --no-dry-run]
[--service-names <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 .

--service-names (list)

One or more service names.

(string)

Syntax:

"string" "string" ...

--filters (list)

One or more filters.

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

(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. The filters supported by a describe operation are documented with the describe operation. For example:

• DescribeAvailabilityZones

• DescribeImages

• DescribeInstances

• DescribeKeyPairs

• DescribeSecurityGroups

• DescribeSnapshots

• DescribeSubnets

• DescribeTags

• DescribeVolumes

• DescribeVpcs

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

ServiceId -> (string)

The ID of the endpoint 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.

PrivateDnsNames -> (list)

The private DNS names assigned to the VPC endpoint service.

(structure)

Information about the Private DNS name for interface endpoints.

PrivateDnsName -> (string)

The private DNS name assigned to the VPC endpoint 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.

ManagesVpcEndpoints -> (boolean)

Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

Tags -> (list)

Any tags assigned to the service.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

PrivateDnsNameVerificationState -> (string)

The verification state of the VPC endpoint service.

Consumers of the endpoint service cannot use the private name when the state is not verified .

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.