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 ]

delete-graph

Description

Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.

See also: AWS API Documentation

Synopsis

  delete-graph
--graph-identifier <value>
--skip-snapshot | --no-skip-snapshot
[--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-identifier (string)

The unique identifier of the Neptune Analytics graph.

--skip-snapshot | --no-skip-snapshot (boolean)

Determines whether a final graph snapshot is created before the graph is deleted. If true is specified, no graph snapshot is created. If false is specified, a graph snapshot is created before the graph is deleted.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

createTime -> (timestamp)

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

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 the graph was recovered from a snapshot.

deletionProtection -> (boolean)

If true , deletion protection was enabled for the graph.

buildNumber -> (string)

The build number associated with the graph.