NeptuneGraph / Client / get_private_graph_endpoint

get_private_graph_endpoint#

NeptuneGraph.Client.get_private_graph_endpoint(**kwargs)#

Retrieves information about a specified private endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_private_graph_endpoint(
    graphIdentifier='string',
    vpcId='string'
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The unique identifier of the Neptune Analytics graph.

  • vpcId (string) –

    [REQUIRED]

    The ID of the VPC where the private endpoint is located.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • vpcId (string) –

      The ID of the VPC where the private endpoint is located.

    • subnetIds (list) –

      The subnet IDs involved.

      • (string) –

    • status (string) –

      The current status of the private endpoint.

    • vpcEndpointId (string) –

      The ID of the private endpoint.

Exceptions