NeptuneGraph / Client / get_graph

get_graph

NeptuneGraph.Client.get_graph(**kwargs)

Gets information about a specified graph.

See also: AWS API Documentation

Request Syntax

response = client.get_graph(
    graphIdentifier='string'
)

Parameters:

graphIdentifier (string) –

[REQUIRED]

The unique identifier of the Neptune Analytics graph.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED',
    'statusReason': 'string',
    'createTime': datetime(2015, 1, 1),
    'provisionedMemory': 123,
    'endpoint': 'string',
    'publicConnectivity': True|False,
    'vectorSearchConfiguration': {
        'dimension': 123
    },
    'replicaCount': 123,
    'kmsKeyIdentifier': 'string',
    'sourceSnapshotId': 'string',
    'deletionProtection': True|False,
    'buildNumber': 'string'
}

Response Structure

• (dict) –

  • 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.

  • statusReason (string) –

    The reason that the graph has this status.

  • createTime (datetime) –

    The time at which the graph was created.

  • provisionedMemory (integer) –

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

  • endpoint (string) –

    The graph endpoint.

  • publicConnectivity (boolean) –

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

  • vectorSearchConfiguration (dict) –

    Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535

    • dimension (integer) –

      The number of dimensions.

  • replicaCount (integer) –

    The number of replicas for the graph.

  • kmsKeyIdentifier (string) –

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

  • sourceSnapshotId (string) –

    The ID of the snapshot from which the graph was created, if it was created from a snapshot.

  • deletionProtection (boolean) –

    If true, deletion protection is enabled for the graph.

  • buildNumber (string) –

    The build number of the graph.

Exceptions

• NeptuneGraph.Client.exceptions.ThrottlingException

• NeptuneGraph.Client.exceptions.ValidationException

• NeptuneGraph.Client.exceptions.InternalServerException

• NeptuneGraph.Client.exceptions.ResourceNotFoundException