NeptuneGraph / Client / create_graph

create_graph

NeptuneGraph.Client.create_graph(**kwargs)

Creates a new Neptune Analytics graph.

See also: AWS API Documentation

Request Syntax

response = client.create_graph(
    graphName='string',
    tags={
        'string': 'string'
    },
    publicConnectivity=True|False,
    kmsKeyIdentifier='string',
    vectorSearchConfiguration={
        'dimension': 123
    },
    replicaCount=123,
    deletionProtection=True|False,
    provisionedMemory=123
)

Parameters:

• graphName (string) –

  [REQUIRED]

  A name for the new Neptune Analytics graph to be created.

  The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

• tags (dict) –

  Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

  • (string) –

    • (string) –

• publicConnectivity (boolean) – Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. ( true to enable, or false to disable.

• kmsKeyIdentifier (string) – Specifies a KMS key to use to encrypt data in the new graph.

• vectorSearchConfiguration (dict) –

  Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as ``dimension=``value. Max = 65,535

  • dimension (integer) – [REQUIRED]

    The number of dimensions.

• replicaCount (integer) – The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

• deletionProtection (boolean) – Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. ( true or false).

• provisionedMemory (integer) –

  [REQUIRED]

  The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128

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 ID of the graph.

  • name (string) –

    The graph name. For example: my-graph-1.

    The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

  • arn (string) –

    The ARN of the graph.

  • status (string) –

    The current status of the graph.

  • statusReason (string) –

    The reason the status was given.

  • createTime (datetime) –

    The time when the graph was created.

  • provisionedMemory (integer) –

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128

  • endpoint (string) –

    The graph endpoint.

  • publicConnectivity (boolean) –

    Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

  • vectorSearchConfiguration (dict) –

    The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

    • dimension (integer) –

      The number of dimensions.

  • replicaCount (integer) –

    The number of replicas in other AZs.

  • kmsKeyIdentifier (string) –

    Specifies the KMS key used to encrypt data in the new graph.

  • sourceSnapshotId (string) –

    The ID of the source graph.

  • deletionProtection (boolean) –

    A value that indicates whether the graph has deletion protection enabled. The graph can’t be deleted when deletion protection is enabled.

  • buildNumber (string) –

    The build number of the graph software.

Exceptions

• NeptuneGraph.Client.exceptions.ServiceQuotaExceededException

• NeptuneGraph.Client.exceptions.ThrottlingException

• NeptuneGraph.Client.exceptions.ValidationException

• NeptuneGraph.Client.exceptions.ConflictException

• NeptuneGraph.Client.exceptions.InternalServerException