OpenSearchService / Client / list_vpc_endpoints_for_domain

list_vpc_endpoints_for_domain¶

OpenSearchService.Client.list_vpc_endpoints_for_domain(**kwargs)¶

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Request Syntax

response = client.list_vpc_endpoints_for_domain(
    DomainName='string',
    NextToken='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain to list associated VPC endpoints for.
NextToken (string) – If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'VpcEndpointSummaryList': [
        {
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'DomainArn': 'string',
            'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- VpcEndpointSummaryList (list) –
  
  Information about each endpoint associated with the domain.
  - (dict) –
    
    Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
    - VpcEndpointId (string) –
      
      The unique identifier of the endpoint.
    - VpcEndpointOwner (string) –
      
      The creator of the endpoint.
    - DomainArn (string) –
      
      The Amazon Resource Name (ARN) of the domain associated with the endpoint.
    - Status (string) –
      
      The current status of the endpoint.
- NextToken (string) –
  
  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.

Exceptions

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