NeptuneGraph / Client / list_private_graph_endpoints

list_private_graph_endpoints#

NeptuneGraph.Client.list_private_graph_endpoints(**kwargs)#

Lists private endpoints for a specified Neptune Analytics graph.

Request Syntax

response = client.list_private_graph_endpoints(
    graphIdentifier='string',
    nextToken='string',
    maxResults=123
)

Parameters:

graphIdentifier (string) –
[REQUIRED]

The unique identifier of the Neptune Analytics graph.
nextToken (string) –
Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.
maxResults (integer) –
The total number of records to return in the command’s output.

If the total number of records available is more than the value specified, nextToken is provided in the command’s output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- privateGraphEndpoints (list) –
  
  A list of private endpoints for the specified Neptune Analytics graph.
  - (dict) –
    
    Details about a private graph endpoint.
    - vpcId (string) –
      
      The ID of the VPC in which the private graph endpoint is located.
    - subnetIds (list) –
      
      The subnet IDs associated with the private graph endpoint.
      - (string) –
    - status (string) –
      
      The status of the private graph endpoint.
    - vpcEndpointId (string) –
      
      The ID of the VPC endpoint.
- nextToken (string) –
  
  Pagination token used to paginate output.
  
  When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

Exceptions

NeptuneGraph.Client.exceptions.ThrottlingException
NeptuneGraph.Client.exceptions.ValidationException
NeptuneGraph.Client.exceptions.InternalServerException
NeptuneGraph.Client.exceptions.ResourceNotFoundException