NeptuneGraph / Client / create_private_graph_endpoint

create_private_graph_endpoint#

NeptuneGraph.Client.create_private_graph_endpoint(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_private_graph_endpoint(
    graphIdentifier='string',
    vpcId='string',
    subnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ]
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The unique identifier of the Neptune Analytics graph.

  • vpcId (string) – The VPC in which the private graph endpoint needs to be created.

  • subnetIds (list) –

    Subnets in which private graph endpoint ENIs are created.

    • (string) –

  • vpcSecurityGroupIds (list) –

    Security groups to be attached to the private graph endpoint..

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'vpcId': 'string',
    'subnetIds': [
        'string',
    ],
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
    'vpcEndpointId': 'string'
}

Response Structure

  • (dict) –

    • vpcId (string) –

      VPC in which the private graph endpoint is created.

    • subnetIds (list) –

      Subnets in which the private graph endpoint ENIs are created.

      • (string) –

    • status (string) –

      Status of the private graph endpoint.

    • vpcEndpointId (string) –

      Endpoint ID of the prviate grpah endpoint.

Exceptions

  • NeptuneGraph.Client.exceptions.ServiceQuotaExceededException

  • NeptuneGraph.Client.exceptions.ThrottlingException

  • NeptuneGraph.Client.exceptions.ValidationException

  • NeptuneGraph.Client.exceptions.ConflictException

  • NeptuneGraph.Client.exceptions.InternalServerException

  • NeptuneGraph.Client.exceptions.ResourceNotFoundException