aws_sdk_bedrockagentruntime/client/
get_session.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 [`GetSession`](crate::operation::get_session::builders::GetSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`session_identifier(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::session_identifier) / [`set_session_identifier(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_session_identifier):<br>required: **true**<br><p>A unique identifier for the session to retrieve. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p><br>
7    /// - On success, responds with [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput) with field(s):
8    ///   - [`session_id(String)`](crate::operation::get_session::GetSessionOutput::session_id): <p>The unique identifier for the session in UUID format.</p>
9    ///   - [`session_arn(String)`](crate::operation::get_session::GetSessionOutput::session_arn): <p>The Amazon Resource Name (ARN) of the session.</p>
10    ///   - [`session_status(SessionStatus)`](crate::operation::get_session::GetSessionOutput::session_status): <p>The current status of the session.</p>
11    ///   - [`created_at(DateTime)`](crate::operation::get_session::GetSessionOutput::created_at): <p>The timestamp for when the session was created.</p>
12    ///   - [`last_updated_at(DateTime)`](crate::operation::get_session::GetSessionOutput::last_updated_at): <p>The timestamp for when the session was last modified.</p>
13    ///   - [`session_metadata(Option<HashMap::<String, String>>)`](crate::operation::get_session::GetSessionOutput::session_metadata): <p>A map of key-value pairs containing attributes persisted across the session.</p>
14    ///   - [`encryption_key_arn(Option<String>)`](crate::operation::get_session::GetSessionOutput::encryption_key_arn): <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
15    /// - On failure, responds with [`SdkError<GetSessionError>`](crate::operation::get_session::GetSessionError)
16    pub fn get_session(&self) -> crate::operation::get_session::builders::GetSessionFluentBuilder {
17        crate::operation::get_session::builders::GetSessionFluentBuilder::new(self.handle.clone())
18    }
19}