/2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

GET

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/domain//listVpcEndpointAccess'

Response Example

200 - Example 1

{
    "AuthorizedPrincipalList": [],
    "NextToken": "string"
}

Request

Path Params

DomainName

string

required

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

Query Params

nextToken

string

optional

Provides an identifier to allow retrieval of paginated results.

Responses

🟢200Success

application/json

Body

Container for response parameters to the <code><a>ListVpcEndpointAccess</a></code> operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.

AuthorizedPrincipalList

array[object (AuthorizedPrincipal) {2}]

required

List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

PrincipalType

enum<string>

optional

The type of principal.

Allowed values:

AWS_ACCOUNTAWS_SERVICE

Principal

string

optional

The IAM principal that is allowed access to the domain.

NextToken

string

required

Provides an identifier to allow retrieval of paginated results.

🟠480ResourceNotFoundException

🟠481DisabledOperationException

🟠482InternalException

🟠483BaseException

Modified at 2023-08-15 04:15:52

/2015-01-01/tags/

/2015-01-01/es/domain/{DomainName}/vpcEndpoints