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.
Parameters:
-
domain_name
(DomainName)
–
The name of the OpenSearch Service domain to retrieve access information for.
-
next_token
(Optional[NextToken], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_opensearch/_services/open_search.py
| def list_vpc_endpoint_access(
self,
domain_name: "capo_opensearch.types.domain_name.DomainName",
*,
config_overrides: Optional[OpenSearchClientConfig] = None,
next_token: Optional["capo_opensearch.types.next_token.NextToken"] = None,
) -> "capo_opensearch.types.list_vpc_endpoint_access_response.ListVpcEndpointAccessResponse":
"""<p>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.</p>
Args:
domain_name: <p>The name of the OpenSearch Service domain to retrieve access information for.</p>
next_token: <p>If your initial <code>ListVpcEndpointAccess</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpointAccess</code> operations, which returns results in the next page.</p>
Raises:
capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_opensearch.types.list_vpc_endpoint_access_request.ListVpcEndpointAccessRequest]",
) -> OperationResponse[
"capo_opensearch.types.list_vpc_endpoint_access_response.ListVpcEndpointAccessResponse"
]:
import capo_opensearch._operations.amazon_open_search_service.list_vpc_endpoint_access
output, http_response = (
capo_opensearch._operations.amazon_open_search_service.list_vpc_endpoint_access.list_vpc_endpoint_access(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListVpcEndpointAccess")
)
input_: capo_opensearch.types.list_vpc_endpoint_access_request.ListVpcEndpointAccessRequest = {
"domain_name": domain_name
}
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|