AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . neptune-graph ]

create-graph

Description

Creates a new Neptune Analytics graph.

See also: AWS API Documentation

Synopsis

  create-graph
--graph-name <value>
[--tags <value>]
[--public-connectivity | --no-public-connectivity]
[--kms-key-identifier <value>]
[--vector-search-configuration <value>]
[--replica-count <value>]
[--deletion-protection | --no-deletion-protection]
--provisioned-memory <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--graph-name (string)

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 (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--public-connectivity | --no-public-connectivity (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.

--kms-key-identifier (string)

Specifies a KMS key to use to encrypt data in the new graph.

--vector-search-configuration (structure)

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)

The number of dimensions.

Shorthand Syntax:

dimension=integer

JSON Syntax:

{
  "dimension": integer
}

--replica-count (integer)

The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

Warning

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

--deletion-protection | --no-deletion-protection (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 ).

--provisioned-memory (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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 -> (timestamp)

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.

Note

If enabling public connectivity for the first time, there will be a delay while it is enabled.

vectorSearchConfiguration -> (structure)

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.

Default: If not specified, the default value is 1.

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.