CreatePrivateGraphEndpoint
Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.
Note
VPC endpoint charges apply.
Request Syntax
POST /graphs/graphIdentifier
/endpoints/ HTTP/1.1
Content-type: application/json
{
"subnetIds": [ "string
" ],
"vpcId": "string
",
"vpcSecurityGroupIds": [ "string
" ]
}
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
Request Body
The request accepts the following data in JSON format.
- subnetIds
-
Subnets in which private graph endpoint ENIs are created.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Pattern:
subnet-[a-z0-9]+
Required: No
- vpcId
-
The VPC in which the private graph endpoint needs to be created.
Type: String
Pattern:
vpc-[a-z0-9]+
Required: No
- vpcSecurityGroupIds
-
Security groups to be attached to the private graph endpoint..
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Pattern:
sg-[a-z0-9]+
Required: No
Response Syntax
HTTP/1.1 201
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 201 response.
The following data is returned in JSON format by the service.
- status
-
Status of the private graph endpoint.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | FAILED
- subnetIds
-
Subnets in which the private graph endpoint ENIs are created.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Pattern:
subnet-[a-z0-9]+
- vpcEndpointId
-
Endpoint ID of the prviate grpah endpoint.
Type: String
Pattern:
vpce-[0-9a-f]{17}
- vpcId
-
VPC in which the private graph endpoint is created.
Type: String
Pattern:
vpc-[a-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Raised when a conflict is encountered.
HTTP Status Code: 409
- InternalServerException
-
A failure occurred on the server.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
A service quota was exceeded.
HTTP Status Code: 402
- 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: