Skip to content

List Vpc Endpoint Access

opensearchservice_list_vpc_endpoint_access R Documentation

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint

Description

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Usage

opensearchservice_list_vpc_endpoint_access(DomainName, NextToken)

Arguments

DomainName

[required] The name of the OpenSearch Service domain to retrieve access information for.

NextToken

If your initial list_vpc_endpoint_access operation returns a nextToken, you can include the returned nextToken in subsequent list_vpc_endpoint_access operations, which returns results in the next page.

Value

A list with the following syntax:

list(
  AuthorizedPrincipalList = list(
    list(
      PrincipalType = "AWS_ACCOUNT"|"AWS_SERVICE",
      Principal = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_vpc_endpoint_access(
  DomainName = "string",
  NextToken = "string"
)