BatchGetVpcEndpoint - Amazon OpenSearch Serverless


Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Request Syntax

{ "ids": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


A list of VPC endpoint identifiers.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^vpce-[0-9a-z]*$

Required: Yes

Response Syntax

{ "vpcEndpointDetails": [ { "createdDate": number, "id": "string", "name": "string", "securityGroupIds": [ "string" ], "status": "string", "subnetIds": [ "string" ], "vpcId": "string" } ], "vpcEndpointErrorDetails": [ { "errorCode": "string", "errorMessage": "string", "id": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Details about the specified VPC endpoint.

Type: Array of VpcEndpointDetail objects


Error information for a failed request.

Type: Array of VpcEndpointErrorDetail objects


For information about the errors that are common to all actions, see Common Errors.


Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500


Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: