ElasticsearchService / Client / list_vpc_endpoint_access

list_vpc_endpoint_access#

ElasticsearchService.Client.list_vpc_endpoint_access(**kwargs)#

Retrieves information about each 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',
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

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

  • NextToken (string) – Provides an identifier to allow retrieval of paginated results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

    • AuthorizedPrincipalList (list) –

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

      • (dict) –

        Information about an 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) –

      Provides an identifier to allow retrieval of paginated results.

Exceptions