ListVpcEndpointAccess - Amazon OpenSearch Service


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

Request Syntax

GET /2021-01-01/opensearch/domain/DomainName/listVpcEndpointAccess?nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes


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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AuthorizedPrincipalList": [ { "Principal": "string", "PrincipalType": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A list of IAM principals that can currently access the domain.

Type: Array of AuthorizedPrincipal objects


When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String


For information about the errors that are common to all actions, see Common Errors.


An error occurred while processing the request.

HTTP Status Code: 400


An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409


Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: