aws_sdk_bedrockagentcore/client/stop_runtime_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 [`StopRuntimeSession`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`runtime_session_id(impl Into<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::runtime_session_id) / [`set_runtime_session_id(Option<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::set_runtime_session_id):<br>required: **true**<br><p>The ID of the session that you want to stop.</p><br>
7 /// - [`agent_runtime_arn(impl Into<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::agent_runtime_arn) / [`set_agent_runtime_arn(Option<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::set_agent_runtime_arn):<br>required: **true**<br><p>The ARN of the agent that contains the session that you want to stop.</p><br>
8 /// - [`qualifier(impl Into<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::qualifier) / [`set_qualifier(Option<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::set_qualifier):<br>required: **false**<br><p>Optional qualifier to specify an agent alias, such as <code>prod</code>code> or <code>dev</code>. If you don't provide a value, the DEFAULT alias is used.</p><br>
9 /// - [`client_token(impl Into<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::set_client_token):<br>required: **false**<br><p>Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.</p><br>
10 /// - On success, responds with [`StopRuntimeSessionOutput`](crate::operation::stop_runtime_session::StopRuntimeSessionOutput) with field(s):
11 /// - [`runtime_session_id(Option<String>)`](crate::operation::stop_runtime_session::StopRuntimeSessionOutput::runtime_session_id): <p>The ID of the session that you requested to stop.</p>
12 /// - [`status_code(Option<i32>)`](crate::operation::stop_runtime_session::StopRuntimeSessionOutput::status_code): <p>The status code of the request to stop the session.</p>
13 /// - On failure, responds with [`SdkError<StopRuntimeSessionError>`](crate::operation::stop_runtime_session::StopRuntimeSessionError)
14 pub fn stop_runtime_session(&self) -> crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder {
15 crate::operation::stop_runtime_session::builders::StopRuntimeSessionFluentBuilder::new(self.handle.clone())
16 }
17}