aws_sdk_bedrockagentcore/client/
get_browser_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 [`GetBrowserSession`](crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`browser_identifier(impl Into<String>)`](crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder::browser_identifier) / [`set_browser_identifier(Option<String>)`](crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder::set_browser_identifier):<br>required: **true**<br><p>The unique identifier of the browser associated with the session.</p><br>
7    ///   - [`session_id(impl Into<String>)`](crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The unique identifier of the browser session to retrieve.</p><br>
8    /// - On success, responds with [`GetBrowserSessionOutput`](crate::operation::get_browser_session::GetBrowserSessionOutput) with field(s):
9    ///   - [`browser_identifier(String)`](crate::operation::get_browser_session::GetBrowserSessionOutput::browser_identifier): <p>The identifier of the browser.</p>
10    ///   - [`session_id(String)`](crate::operation::get_browser_session::GetBrowserSessionOutput::session_id): <p>The identifier of the browser session.</p>
11    ///   - [`name(Option<String>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::name): <p>The name of the browser session.</p>
12    ///   - [`created_at(DateTime)`](crate::operation::get_browser_session::GetBrowserSessionOutput::created_at): <p>The time at which the browser session was created.</p>
13    ///   - [`view_port(Option<ViewPort>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::view_port): <p>The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent's browsing tasks.</p>
14    ///   - [`session_timeout_seconds(Option<i32>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::session_timeout_seconds): <p>The timeout period for the browser session in seconds.</p>
15    ///   - [`status(Option<BrowserSessionStatus>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::status): <p>The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.</p>
16    ///   - [`streams(Option<BrowserSessionStream>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::streams): <p>The streams associated with this browser session. These include the automation stream and live view stream.</p>
17    ///   - [`session_replay_artifact(Option<String>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::session_replay_artifact): <p>The artifact containing the session replay information.</p>
18    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_browser_session::GetBrowserSessionOutput::last_updated_at): <p>The time at which the browser session was last updated.</p>
19    /// - On failure, responds with [`SdkError<GetBrowserSessionError>`](crate::operation::get_browser_session::GetBrowserSessionError)
20    pub fn get_browser_session(&self) -> crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder {
21        crate::operation::get_browser_session::builders::GetBrowserSessionFluentBuilder::new(self.handle.clone())
22    }
23}