NeptuneGraph / Paginator / ListPrivateGraphEndpoints

ListPrivateGraphEndpoints

class NeptuneGraph.Paginator.ListPrivateGraphEndpoints

paginator = client.get_paginator('list_private_graph_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NeptuneGraph.Client.list_private_graph_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    graphIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• graphIdentifier (string) –

  [REQUIRED]

  The unique identifier of the Neptune Analytics graph.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.