aws_sdk_neptunegraph/client/
get_graph_snapshot.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetGraphSnapshot`](crate::operation::get_graph_snapshot::builders::GetGraphSnapshotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`snapshot_identifier(impl Into<String>)`](crate::operation::get_graph_snapshot::builders::GetGraphSnapshotFluentBuilder::snapshot_identifier) / [`set_snapshot_identifier(Option<String>)`](crate::operation::get_graph_snapshot::builders::GetGraphSnapshotFluentBuilder::set_snapshot_identifier):<br>required: **true**<br><p>The ID of the snapshot to retrieve.</p><br>
7    /// - On success, responds with [`GetGraphSnapshotOutput`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput) with field(s):
8    ///   - [`id(String)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::id): <p>The unique identifier of the graph snapshot.</p>
9    ///   - [`name(String)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::name): <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>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. Only lowercase letters are allowed.</p>
10    ///   - [`arn(String)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::arn): <p>The ARN of the graph snapshot.</p>
11    ///   - [`source_graph_id(Option<String>)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::source_graph_id): <p>The graph identifier for the graph for which a snapshot is to be created.</p>
12    ///   - [`snapshot_create_time(Option<DateTime>)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::snapshot_create_time): <p>The time when the snapshot was created.</p>
13    ///   - [`status(Option<SnapshotStatus>)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::status): <p>The status of the graph snapshot.</p>
14    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::get_graph_snapshot::GetGraphSnapshotOutput::kms_key_identifier): <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
15    /// - On failure, responds with [`SdkError<GetGraphSnapshotError>`](crate::operation::get_graph_snapshot::GetGraphSnapshotError)
16    pub fn get_graph_snapshot(&self) -> crate::operation::get_graph_snapshot::builders::GetGraphSnapshotFluentBuilder {
17        crate::operation::get_graph_snapshot::builders::GetGraphSnapshotFluentBuilder::new(self.handle.clone())
18    }
19}