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.

See also: AWS API Documentation

Request Syntax

response = client.list_vpc_endpoint_access(
  • DomainName (string) --


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

  • NextToken (string) -- 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.
Return type



Response Syntax

    'AuthorizedPrincipalList': [
            'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE',
            'Principal': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) --

    • AuthorizedPrincipalList (list) --

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

      • (dict) --

        Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

        • PrincipalType (string) --

          The type of principal.

        • Principal (string) --

          The IAM principal that is allowed access to the domain.

    • NextToken (string) --

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


  • OpenSearchService.Client.exceptions.ResourceNotFoundException
  • OpenSearchService.Client.exceptions.DisabledOperationException
  • OpenSearchService.Client.exceptions.InternalException
  • OpenSearchService.Client.exceptions.BaseException