Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListVpcEndpointAccess

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.

DomainName

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

NextToken

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.

AuthorizedPrincipalList

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

Type: Array of AuthorizedPrincipal objects

NextToken

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

Errors

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

BaseException

An error occurred while processing the request.

message: A description of the error.

HTTP Status Code: 400

DisabledOperationException

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

HTTP Status Code: 409

InternalException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 409