Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeVpcEndpoints

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

Request Syntax


POST /2021-01-01/opensearch/vpcEndpoints/describe HTTP/1.1
Content-type: application/json

{
   "VpcEndpointIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

VpcEndpointIds

The unique identifiers of the endpoints to get information about.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 256.

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "VpcEndpointErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "VpcEndpointId": "string"
      }
   ],
   "VpcEndpoints": [ 
      { 
         "DomainArn": "string",
         "Endpoint": "string",
         "Status": "string",
         "VpcEndpointId": "string",
         "VpcEndpointOwner": "string",
         "VpcOptions": { 
            "AvailabilityZones": [ "string" ],
            "SecurityGroupIds": [ "string" ],
            "SubnetIds": [ "string" ],
            "VPCId": "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.

VpcEndpointErrors

Any errors associated with the request.

Type: Array of VpcEndpointError objects

VpcEndpoints

Information about each requested VPC endpoint.

Type: Array of VpcEndpoint objects

Errors

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

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400