List Vpc Endpoints

opensearchserviceserverless_list_vpc_endpoints

R Documentation

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account

Description

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Usage

opensearchserviceserverless_list_vpc_endpoints(vpcEndpointFilters,
  nextToken, maxResults)

Arguments

vpcEndpointFilters	Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
nextToken	If your initial list_vpc_endpoints operation returns a nextToken, you can include the returned nextToken in subsequent list_vpc_endpoints operations, which returns results in the next page.
maxResults	An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

Value

A list with the following syntax:

list(
  vpcEndpointSummaries = list(
    list(
      id = "string",
      name = "string",
      status = "PENDING"|"DELETING"|"ACTIVE"|"FAILED"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_vpc_endpoints(
  vpcEndpointFilters = list(
    status = "PENDING"|"DELETING"|"ACTIVE"|"FAILED"
  ),
  nextToken = "string",
  maxResults = 123
)