/2015-01-01/es/vpcEndpoints/describe

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

POST

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/vpcEndpoints/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "VpcEndpointIds": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
  "VpcEndpoints": [],
  "VpcEndpointErrors": []
}

Request

Body Params application/json

VpcEndpointIds

array[string]

required

The unique identifiers of the endpoints to get information about.

Examples

Responses

🟢200Success

application/json

Body

Container for response parameters to the <code><a>DescribeVpcEndpoints</a></code> operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described

VpcEndpoints

array[object (VpcEndpoint) {6}]

required

Information about each requested VPC endpoint.

VpcEndpointId

string

optional

The unique identifier of the endpoint.

>= 5 characters<= 256 characters

Match pattern:

^aos-[a-zA-Z0-9]*$

VpcEndpointOwner

string

optional

The creator of the endpoint.

Match pattern:

^[0-9]+$

DomainArn

string

optional

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

>= 1 characters<= 512 characters

Match pattern:

arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

VpcOptions

object

optional

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Status

object

optional

The current status of the endpoint.

Endpoint

string

optional

The connection endpoint ID for connecting to the domain.

Match pattern:

^[A-Za-z0-9\-\.]+$

VpcEndpointErrors

array[object (VpcEndpointError) {3}]

required

Any errors associated with the request.

VpcEndpointId

string

optional

The unique identifier of the endpoint.

>= 5 characters<= 256 characters

Match pattern:

^aos-[a-zA-Z0-9]*$

ErrorCode

enum<string>

optional

The code associated with the error.

Allowed values:

ENDPOINT_NOT_FOUNDSERVER_ERROR

ErrorMessage

string

optional

A message describing the error.

🟠480ValidationException

🟠481InternalException

🟠482DisabledOperationException

🟠483BaseException

/2015-01-01/es/reservedInstances

/2015-01-01/packages/dissociate/{PackageID}/{DomainName}