Struct aws_sdk_neptunegraph::client::Client

pub struct Client { /* private fields */ }

Client for Amazon Neptune Graph

Client for invoking operations on Amazon Neptune Graph. Each operation on Amazon Neptune Graph is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_neptunegraph::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_neptunegraph::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelQuery operation has a Client::cancel_query, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_query()
    .graph_identifier("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn cancel_import_task(&self) -> CancelImportTaskFluentBuilder

Constructs a fluent builder for the CancelImportTask operation.

• The fluent builder is configurable:
  • task_identifier(impl Into<String>) / set_task_identifier(Option<String>):
    required: true
    

    The unique identifier of the import task.

    
    
• On success, responds with CancelImportTaskOutput with field(s):
  • graph_id(Option<String>):

    The unique identifier of the Neptune Analytics graph.

  • task_id(String):

    The unique identifier of the import task.

  • source(String):

    A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

  • format(Option<Format>):

    Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

  • role_arn(String):

    The ARN of the IAM role that will allow access to the data that is to be imported.

  • status(ImportTaskStatus):

    Current status of the task. Status is CANCELLING when the import task is cancelled.

• On failure, responds with SdkError<CancelImportTaskError>

impl Client

pub fn cancel_query(&self) -> CancelQueryFluentBuilder

Constructs a fluent builder for the CancelQuery operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The unique identifier of the query to cancel.

    
    
• On success, responds with CancelQueryOutput
• On failure, responds with SdkError<CancelQueryError>

impl Client

pub fn create_graph(&self) -> CreateGraphFluentBuilder

Constructs a fluent builder for the CreateGraph operation.

• The fluent builder is configurable:
  • graph_name(impl Into<String>) / set_graph_name(Option<String>):
    required: true
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • public_connectivity(bool) / set_public_connectivity(Option<bool>):
    required: false
    

    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(impl Into<String>) / set_kms_key_identifier(Option<String>):
    required: false
    

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

    
    
  • vector_search_configuration(VectorSearchConfiguration) / set_vector_search_configuration(Option<VectorSearchConfiguration>):
    required: false
    

    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

    
    
  • replica_count(i32) / set_replica_count(Option<i32>):
    required: false
    

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

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

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    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(i32) / set_provisioned_memory(Option<i32>):
    required: true
    

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

    
    
• On success, responds with CreateGraphOutput with field(s):
  • 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(Option<GraphStatus>):

    The current status of the graph.

  • status_reason(Option<String>):

    The reason the status was given.

  • create_time(Option<DateTime>):

    The time when the graph was created.

  • provisioned_memory(Option<i32>):

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

    Min = 128

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas in other AZs.

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

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

    The ID of the source graph.

  • deletion_protection(Option<bool>):

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

  • build_number(Option<String>):

    The build number of the graph software.

• On failure, responds with SdkError<CreateGraphError>

impl Client

pub fn create_graph_snapshot(&self) -> CreateGraphSnapshotFluentBuilder

Constructs a fluent builder for the CreateGraphSnapshot operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: true
    

    The snapshot name. For example: my-snapshot-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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateGraphSnapshotOutput with field(s):
  • id(String):

    The ID of the snapshot created.

  • name(String):

    The name of the snapshot created.

  • arn(String):

    The ARN of the snapshot created.

  • source_graph_id(Option<String>):

    The Id of the Neptune Analytics graph from which the snapshot is created.

  • snapshot_create_time(Option<DateTime>):

    The snapshot creation time

  • status(Option<SnapshotStatus>):

    The current state of the snapshot.

  • kms_key_identifier(Option<String>):

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

• On failure, responds with SdkError<CreateGraphSnapshotError>

impl Client

pub fn create_graph_using_import_task( &self ) -> CreateGraphUsingImportTaskFluentBuilder

Constructs a fluent builder for the CreateGraphUsingImportTask operation.

• The fluent builder is configurable:
  • graph_name(impl Into<String>) / set_graph_name(Option<String>):
    required: true
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • public_connectivity(bool) / set_public_connectivity(Option<bool>):
    required: false
    

    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(impl Into<String>) / set_kms_key_identifier(Option<String>):
    required: false
    

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

    
    
  • vector_search_configuration(VectorSearchConfiguration) / set_vector_search_configuration(Option<VectorSearchConfiguration>):
    required: false
    

    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

    
    
  • replica_count(i32) / set_replica_count(Option<i32>):
    required: false
    

    The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

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

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

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

    
    
  • import_options(ImportOptions) / set_import_options(Option<ImportOptions>):
    required: false
    

    Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

    
    
  • max_provisioned_memory(i32) / set_max_provisioned_memory(Option<i32>):
    required: false
    

    The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.

    If both the minimum and maximum values are specified, the max of the min-provisioned-memory and max-provisioned memory is used to create the graph. If neither value is specified 128 m-NCUs are used.

    
    
  • min_provisioned_memory(i32) / set_min_provisioned_memory(Option<i32>):
    required: false
    

    The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128

    
    
  • fail_on_error(bool) / set_fail_on_error(Option<bool>):
    required: false
    

    If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: true
    

    A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

    
    
  • format(Format) / set_format(Option<Format>):
    required: false
    

    Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role that will allow access to the data that is to be imported.

    
    
• On success, responds with CreateGraphUsingImportTaskOutput with field(s):
  • graph_id(Option<String>):

    The unique identifier of the Neptune Analytics graph.

  • task_id(String):

    The unique identifier of the import task.

  • source(String):

    A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

  • format(Option<Format>):

    Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

  • role_arn(String):

    The ARN of the IAM role that will allow access to the data that is to be imported.

  • status(ImportTaskStatus):

    The status of the import task.

  • import_options(Option<ImportOptions>):

    Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

• On failure, responds with SdkError<CreateGraphUsingImportTaskError>

impl Client

pub fn create_private_graph_endpoint( &self ) -> CreatePrivateGraphEndpointFluentBuilder

Constructs a fluent builder for the CreatePrivateGraphEndpoint operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: false
    

    The VPC in which the private graph endpoint needs to be created.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    Subnets in which private graph endpoint ENIs are created.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

    Security groups to be attached to the private graph endpoint..

    
    
• On success, responds with CreatePrivateGraphEndpointOutput with field(s):
  • vpc_id(String):

    VPC in which the private graph endpoint is created.

  • subnet_ids(Vec::<String>):

    Subnets in which the private graph endpoint ENIs are created.

  • status(PrivateGraphEndpointStatus):

    Status of the private graph endpoint.

  • vpc_endpoint_id(Option<String>):

    Endpoint ID of the prviate grpah endpoint.

• On failure, responds with SdkError<CreatePrivateGraphEndpointError>

impl Client

pub fn delete_graph(&self) -> DeleteGraphFluentBuilder

Constructs a fluent builder for the DeleteGraph operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • skip_snapshot(bool) / set_skip_snapshot(Option<bool>):
    required: true
    

    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.

    
    
• On success, responds with DeleteGraphOutput with field(s):
  • id(String):

    The unique identifier of the graph.

  • name(String):

    The name of the graph.

  • arn(String):

    The ARN associated with the graph.

  • status(Option<GraphStatus>):

    The status of the graph.

  • status_reason(Option<String>):

    The reason for the status of the graph.

  • create_time(Option<DateTime>):

    The time at which the graph was created.

  • provisioned_memory(Option<i32>):

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

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas for the graph.

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

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

  • deletion_protection(Option<bool>):

    If true, deletion protection was enabled for the graph.

  • build_number(Option<String>):

    The build number associated with the graph.

• On failure, responds with SdkError<DeleteGraphError>

impl Client

pub fn delete_graph_snapshot(&self) -> DeleteGraphSnapshotFluentBuilder

Constructs a fluent builder for the DeleteGraphSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    ID of the graph snapshot to be deleted.

    
    
• On success, responds with DeleteGraphSnapshotOutput with field(s):
  • id(String):

    The unique identifier of the graph snapshot.

  • name(String):

    The snapshot name. For example: my-snapshot-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 snapshot.

  • source_graph_id(Option<String>):

    The graph identifier for the graph from which the snapshot was created.

  • snapshot_create_time(Option<DateTime>):

    The time when the snapshot was created.

  • status(Option<SnapshotStatus>):

    The status of the graph snapshot.

  • kms_key_identifier(Option<String>):

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

• On failure, responds with SdkError<DeleteGraphSnapshotError>

impl Client

pub fn delete_private_graph_endpoint( &self ) -> DeletePrivateGraphEndpointFluentBuilder

Constructs a fluent builder for the DeletePrivateGraphEndpoint operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The ID of the VPC where the private endpoint is located.

    
    
• On success, responds with DeletePrivateGraphEndpointOutput with field(s):
  • vpc_id(String):

    The ID of the VPC where the private endpoint was deleted.

  • subnet_ids(Vec::<String>):

    The subnet IDs involved.

  • status(PrivateGraphEndpointStatus):

    The status of the delete operation.

  • vpc_endpoint_id(Option<String>):

    The ID of the VPC endpoint that was deleted.

• On failure, responds with SdkError<DeletePrivateGraphEndpointError>

impl Client

pub fn execute_query(&self) -> ExecuteQueryFluentBuilder

Constructs a fluent builder for the ExecuteQuery operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The query string to be executed.

    
    
  • language(QueryLanguage) / set_language(Option<QueryLanguage>):
    required: true
    

    The query language the query is written in. Currently only openCypher is supported.

    
    
  • parameters(impl Into<String>, Document) / set_parameters(Option<HashMap::<String, Document>>):
    required: false
    

    The data parameters the query can use in JSON format. For example: {“name”: “john”, “age”: 20}. (optional)

    
    
  • plan_cache(PlanCacheType) / set_plan_cache(Option<PlanCacheType>):
    required: false
    

    Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

    
    
  • explain_mode(ExplainMode) / set_explain_mode(Option<ExplainMode>):
    required: false
    

    The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

    
    
  • query_timeout_milliseconds(i32) / set_query_timeout_milliseconds(Option<i32>):
    required: false
    

    Specifies the query timeout duration, in milliseconds. (optional)

    
    
• On success, responds with ExecuteQueryOutput with field(s):
  • payload(ByteStream):

    The query results.

• On failure, responds with SdkError<ExecuteQueryError>

impl Client

pub fn get_graph(&self) -> GetGraphFluentBuilder

Constructs a fluent builder for the GetGraph operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
• On success, responds with GetGraphOutput with field(s):
  • id(String):

    The unique identifier of the graph.

  • name(String):

    The name of the graph.

  • arn(String):

    The ARN associated with the graph.

  • status(Option<GraphStatus>):

    The status of the graph.

  • status_reason(Option<String>):

    The reason that the graph has this status.

  • create_time(Option<DateTime>):

    The time at which the graph was created.

  • provisioned_memory(Option<i32>):

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

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas for the graph.

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

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

  • deletion_protection(Option<bool>):

    If true, deletion protection is enabled for the graph.

  • build_number(Option<String>):

    The build number of the graph.

• On failure, responds with SdkError<GetGraphError>

impl Client

pub fn get_graph_snapshot(&self) -> GetGraphSnapshotFluentBuilder

Constructs a fluent builder for the GetGraphSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    The ID of the snapshot to retrieve.

    
    
• On success, responds with GetGraphSnapshotOutput with field(s):
  • id(String):

    The unique identifier of the graph snapshot.

  • name(String):

    The snapshot name. For example: my-snapshot-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 snapshot.

  • source_graph_id(Option<String>):

    The graph identifier for the graph for which a snapshot is to be created.

  • snapshot_create_time(Option<DateTime>):

    The time when the snapshot was created.

  • status(Option<SnapshotStatus>):

    The status of the graph snapshot.

  • kms_key_identifier(Option<String>):

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

• On failure, responds with SdkError<GetGraphSnapshotError>

impl Client

pub fn get_graph_summary(&self) -> GetGraphSummaryFluentBuilder

Constructs a fluent builder for the GetGraphSummary operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • mode(GraphSummaryMode) / set_mode(Option<GraphSummaryMode>):
    required: false
    

    The summary mode can take one of two values: basic (the default), and detailed.

    
    
• On success, responds with GetGraphSummaryOutput with field(s):
  • version(Option<String>):

    Display the version of this tool.

  • last_statistics_computation_time(Option<DateTime>):

    The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.

  • graph_summary(Option<GraphDataSummary>):

    The graph summary.

• On failure, responds with SdkError<GetGraphSummaryError>

impl Client

pub fn get_import_task(&self) -> GetImportTaskFluentBuilder

Constructs a fluent builder for the GetImportTask operation.

• The fluent builder is configurable:
  • task_identifier(impl Into<String>) / set_task_identifier(Option<String>):
    required: true
    

    The unique identifier of the import task.

    
    
• On success, responds with GetImportTaskOutput with field(s):
  • graph_id(Option<String>):

    The unique identifier of the Neptune Analytics graph.

  • task_id(String):

    The unique identifier of the import task.

  • source(String):

    A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot

  • format(Option<Format>):

    Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

  • role_arn(String):

    The ARN of the IAM role that will allow access to the data that is to be imported.

  • status(ImportTaskStatus):

    The status of the import task:

    • INITIALIZING   –   The necessary resources needed to create the graph are being prepared.

    • ANALYZING_DATA   –   The data is being analyzed to determine the optimal infrastructure configuration for the new graph.

    • RE_PROVISIONING   –   The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.

    • IMPORTING   –   The data is being loaded.

    • ERROR_ENCOUNTERED   –   An error has been encountered while trying to create the graph and import the data.

    • ERROR_ENCOUNTERED_ROLLING_BACK   –   Because of the error that was encountered, the graph is being rolled back and all its resources released.

    • SUCCEEDED   –   Graph creation and data loading succeeded.

    • FAILED   –   Graph creation or data loading failed. When the status is FAILED, you can use get-graphs to get more information about the state of the graph.

    • CANCELLING   –   Because you cancelled the import task, cancellation is in progress.

    • CANCELLED   –   You have successfully cancelled the import task.

  • import_options(Option<ImportOptions>):

    Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

  • import_task_details(Option<ImportTaskDetails>):

    Contains details about the specified import task.

  • attempt_number(Option<i32>):

    The number of the current attempt to execute the import task.

  • status_reason(Option<String>):

    The reason that the import task has this status value.

• On failure, responds with SdkError<GetImportTaskError>

impl Client

pub fn get_private_graph_endpoint(&self) -> GetPrivateGraphEndpointFluentBuilder

Constructs a fluent builder for the GetPrivateGraphEndpoint operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The ID of the VPC where the private endpoint is located.

    
    
• On success, responds with GetPrivateGraphEndpointOutput with field(s):
  • vpc_id(String):

    The ID of the VPC where the private endpoint is located.

  • subnet_ids(Vec::<String>):

    The subnet IDs involved.

  • status(PrivateGraphEndpointStatus):

    The current status of the private endpoint.

  • vpc_endpoint_id(Option<String>):

    The ID of the private endpoint.

• On failure, responds with SdkError<GetPrivateGraphEndpointError>

impl Client

pub fn get_query(&self) -> GetQueryFluentBuilder

Constructs a fluent builder for the GetQuery operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The ID of the query in question.

    
    
• On success, responds with GetQueryOutput with field(s):
  • id(Option<String>):

    The ID of the query in question.

  • query_string(Option<String>):

    The query in question.

  • waited(Option<i32>):

    Indicates how long the query waited, in milliseconds.

  • elapsed(Option<i32>):

    The number of milliseconds the query has been running.

  • state(Option<QueryState>):

    State of the query.

• On failure, responds with SdkError<GetQueryError>

impl Client

pub fn list_graph_snapshots(&self) -> ListGraphSnapshotsFluentBuilder

Constructs a fluent builder for the ListGraphSnapshots operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: false
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with ListGraphSnapshotsOutput with field(s):
  • graph_snapshots(Vec::<GraphSnapshotSummary>):

    The requested list of snapshots.

  • next_token(Option<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.

• On failure, responds with SdkError<ListGraphSnapshotsError>

impl Client

pub fn list_graphs(&self) -> ListGraphsFluentBuilder

Constructs a fluent builder for the ListGraphs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with ListGraphsOutput with field(s):
  • graphs(Vec::<GraphSummary>):

    A list of the graphs.

  • next_token(Option<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.

• On failure, responds with SdkError<ListGraphsError>

impl Client

pub fn list_import_tasks(&self) -> ListImportTasksFluentBuilder

Constructs a fluent builder for the ListImportTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with ListImportTasksOutput with field(s):
  • tasks(Vec::<ImportTaskSummary>):

    The requested list of import tasks.

  • next_token(Option<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.

• On failure, responds with SdkError<ListImportTasksError>

impl Client

pub fn list_private_graph_endpoints( &self ) -> ListPrivateGraphEndpointsFluentBuilder

Constructs a fluent builder for the ListPrivateGraphEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with ListPrivateGraphEndpointsOutput with field(s):
  • private_graph_endpoints(Vec::<PrivateGraphEndpointSummary>):

    A list of private endpoints for the specified Neptune Analytics graph.

  • next_token(Option<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.

• On failure, responds with SdkError<ListPrivateGraphEndpointsError>

impl Client

pub fn list_queries(&self) -> ListQueriesFluentBuilder

Constructs a fluent builder for the ListQueries operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: true
    

    The maximum number of results to be fetched by the API.

    
    
  • state(QueryStateInput) / set_state(Option<QueryStateInput>):
    required: false
    

    Filtered list of queries based on state.

    
    
• On success, responds with ListQueriesOutput with field(s):
  • queries(Vec::<QuerySummary>):

    A list of current openCypher queries.

• On failure, responds with SdkError<ListQueriesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The list of metadata tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn reset_graph(&self) -> ResetGraphFluentBuilder

Constructs a fluent builder for the ResetGraph operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    ID of the graph to reset.

    
    
  • skip_snapshot(bool) / set_skip_snapshot(Option<bool>):
    required: true
    

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

    
    
• On success, responds with ResetGraphOutput with field(s):
  • id(String):

    The unique identifier of the graph.

  • name(String):

    The name of the graph.

  • arn(String):

    The ARN associated with the graph.

  • status(Option<GraphStatus>):

    The status of the graph.

  • status_reason(Option<String>):

    The reason that the graph has this status.

  • create_time(Option<DateTime>):

    The time at which the graph was created.

  • provisioned_memory(Option<i32>):

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

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas for the graph.

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

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

  • deletion_protection(Option<bool>):

    If true, deletion protection is enabled for the graph.

  • build_number(Option<String>):

    The build number of the graph.

• On failure, responds with SdkError<ResetGraphError>

impl Client

pub fn restore_graph_from_snapshot( &self ) -> RestoreGraphFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreGraphFromSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    The ID of the snapshot in question.

    
    
  • graph_name(impl Into<String>) / set_graph_name(Option<String>):
    required: true
    

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

    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.

    
    
  • provisioned_memory(i32) / set_provisioned_memory(Option<i32>):
    required: false
    

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

    Min = 128

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
  • replica_count(i32) / set_replica_count(Option<i32>):
    required: false
    

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

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

    
    
  • public_connectivity(bool) / set_public_connectivity(Option<bool>):
    required: false
    

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

    
    
• On success, responds with RestoreGraphFromSnapshotOutput with field(s):
  • id(String):

    The unique identifier of the graph.

  • name(String):

    The name of the graph.

  • arn(String):

    The ARN associated with the graph.

  • status(Option<GraphStatus>):

    The status of the graph.

  • status_reason(Option<String>):

    The reason that the graph has this status.

  • create_time(Option<DateTime>):

    The time at which the graph was created.

  • provisioned_memory(Option<i32>):

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

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas for the graph.

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

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

  • deletion_protection(Option<bool>):

    If true, deletion protection is enabled for the graph.

  • build_number(Option<String>):

    The build number of the graph.

• On failure, responds with SdkError<RestoreGraphFromSnapshotError>

impl Client

pub fn start_import_task(&self) -> StartImportTaskFluentBuilder

Constructs a fluent builder for the StartImportTask operation.

• The fluent builder is configurable:
  • import_options(ImportOptions) / set_import_options(Option<ImportOptions>):
    required: false
    

    Options for how to perform an import.

    
    
  • fail_on_error(bool) / set_fail_on_error(Option<bool>):
    required: false
    

    If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: true
    

    A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

    
    
  • format(Format) / set_format(Option<Format>):
    required: false
    

    Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

    
    
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role that will allow access to the data that is to be imported.

    
    
• On success, responds with StartImportTaskOutput with field(s):
  • graph_id(Option<String>):

    The unique identifier of the Neptune Analytics graph.

  • task_id(String):

    The unique identifier of the import task.

  • source(String):

    A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

  • format(Option<Format>):

    Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

  • role_arn(String):

    The ARN of the IAM role that will allow access to the data that is to be imported.

  • status(ImportTaskStatus):

    The status of the import task.

  • import_options(Option<ImportOptions>):

    Options for how to perform an import.

• On failure, responds with SdkError<StartImportTaskError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    ARN of the resource for which tags need to be added.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to be assigned to the Neptune Analytics resource.

    The tags are metadata that are specified as a list of key-value pairs:

    Key (string)   –   A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length. It can’t be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: “^([\p{L}\p{Z}\p{N}.:/=+-]*)$”).

    Value (string)   –   A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length. It can’t be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: “^([\p{L}\p{Z}\p{N}.:/=+-]*)$”).

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    ARN of the resource whose tag needs to be removed.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Tag keys for the tags to be removed.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_graph(&self) -> UpdateGraphFluentBuilder

Constructs a fluent builder for the UpdateGraph operation.

• The fluent builder is configurable:
  • graph_identifier(impl Into<String>) / set_graph_identifier(Option<String>):
    required: true
    

    The unique identifier of the Neptune Analytics graph.

    
    
  • public_connectivity(bool) / set_public_connectivity(Option<bool>):
    required: false
    

    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.

    
    
  • provisioned_memory(i32) / set_provisioned_memory(Option<i32>):
    required: false
    

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

    Min = 128

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

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

    
    
• On success, responds with UpdateGraphOutput with field(s):
  • id(String):

    The unique identifier of the graph.

  • name(String):

    The name of the graph.

  • arn(String):

    The ARN associated with the graph.

  • status(Option<GraphStatus>):

    The status of the graph.

  • status_reason(Option<String>):

    The reason that the graph has this status.

  • create_time(Option<DateTime>):

    The time at which the graph was created.

  • provisioned_memory(Option<i32>):

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

  • endpoint(Option<String>):

    The graph endpoint.

  • public_connectivity(Option<bool>):

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

  • vector_search_configuration(Option<VectorSearchConfiguration>):

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

  • replica_count(Option<i32>):

    The number of replicas for the graph.

  • kms_key_identifier(Option<String>):

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

  • source_snapshot_id(Option<String>):

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

  • deletion_protection(Option<bool>):

    If true, deletion protection is enabled for the graph.

  • build_number(Option<String>):

    The build number of the graph.

• On failure, responds with SdkError<UpdateGraphError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_graph_available(&self) -> GraphAvailableFluentBuilder

Wait until Graph is Available

fn wait_until_graph_deleted(&self) -> GraphDeletedFluentBuilder

Wait until Graph is Deleted

fn wait_until_graph_snapshot_available( &self ) -> GraphSnapshotAvailableFluentBuilder

Wait until GraphSnapshot is Available

fn wait_until_graph_snapshot_deleted(&self) -> GraphSnapshotDeletedFluentBuilder

Wait until GraphSnapshot is Deleted

fn wait_until_import_task_successful(&self) -> ImportTaskSuccessfulFluentBuilder

Wait until Import Task is Successful

fn wait_until_import_task_cancelled(&self) -> ImportTaskCancelledFluentBuilder

Wait until Import Task is Cancelled

fn wait_until_private_graph_endpoint_available( &self ) -> PrivateGraphEndpointAvailableFluentBuilder

Wait until PrivateGraphEndpoint is Available

fn wait_until_private_graph_endpoint_deleted( &self ) -> PrivateGraphEndpointDeletedFluentBuilder

Wait until PrivateGraphEndpoint is Deleted