describe_vpc_endpoints
(**kwargs)¶Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoints(
VpcEndpointIds=[
'string',
]
)
[REQUIRED]
The unique identifiers of the endpoints to get information about.
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'VpcOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Endpoint': 'string'
},
],
'VpcEndpointErrors': [
{
'VpcEndpointId': 'string',
'ErrorCode': 'ENDPOINT_NOT_FOUND'|'SERVER_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about each requested VPC endpoint.
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
The unique identifier of the endpoint.
The creator of the endpoint.
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
The current status of the endpoint.
The connection endpoint ID for connecting to the domain.
Any errors associated with the request.
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
The unique identifier of the endpoint.
The code associated with the error.
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.DisabledOperationException
OpenSearchService.Client.exceptions.BaseException