GetPrivateGraphEndpoint
Retrieves information about a specified private endpoint.
Request Syntax
GET /graphs/graphIdentifier/endpoints/vpcId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- graphIdentifier
-
The unique identifier of the Neptune Analytics graph.
Pattern:
g-[a-z0-9]{10}Required: Yes
- vpcId
-
The ID of the VPC where the private endpoint is located.
Pattern:
vpc-[a-z0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"status": "string",
"subnetIds": [ "string" ],
"vpcEndpointId": "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.
- status
-
The current status of the private endpoint.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | FAILED - subnetIds
-
The subnet IDs involved.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Pattern:
subnet-[a-z0-9]+ - vpcEndpointId
-
The ID of the private endpoint.
Type: String
Pattern:
vpce-[0-9a-f]{17} - vpcId
-
The ID of the VPC where the private endpoint is located.
Type: String
Pattern:
vpc-[a-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
A failure occurred on the server.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
HTTP Status Code: 404
- ThrottlingException
-
The exception was interrupted by throttling.
HTTP Status Code: 429
- ValidationException
-
A resource could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
