NeptuneGraph / Client / list_graphs

list_graphs#

NeptuneGraph.Client.list_graphs(**kwargs)#

Lists available Neptune Analytics graphs.

See also: AWS API Documentation

Request Syntax

response = client.list_graphs(
    nextToken='string',
    maxResults=123
)
Parameters:

  • 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

{
    'graphs': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED'|'IMPORTING',
            'provisionedMemory': 123,
            'publicConnectivity': True|False,
            'endpoint': 'string',
            'replicaCount': 123,
            'kmsKeyIdentifier': 'string',
            'deletionProtection': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • graphs (list) –

      A list of the graphs.

      • (dict) –

        Summary details about a graph.

        • id (string) –

          The unique identifier of the graph.

        • name (string) –

          The name of the graph.

        • arn (string) –

          The ARN associated with the graph.

        • status (string) –

          The status of the graph.

        • provisionedMemory (integer) –

          The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

        • publicConnectivity (boolean) –

          If true, the graph has a public endpoint, otherwise not.

        • endpoint (string) –

          The graph endpoint.

        • replicaCount (integer) –

          The number of replicas for the graph.

        • kmsKeyIdentifier (string) –

          The ID of the KMS key used to encrypt and decrypt graph data.

        • deletionProtection (boolean) –

          If true, deletion protection is enabled for the 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.

Exceptions