Skip to main content

aws_sdk_devopsagent/client/
end_chat_for_case.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 [`EndChatForCase`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::set_agent_space_id):<br>required: **true**<br>The unique identifier for the agent space containing the task<br>
7    ///   - [`task_id(impl Into<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::set_task_id):<br>required: **true**<br>The unique identifier for the task execution to end<br>
8    ///   - [`reason(impl Into<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::reason) / [`set_reason(Option<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::set_reason):<br>required: **false**<br>Reason for ending the chat session (optional, defaults to 'Chat Ended by CloudSmith')<br>
9    ///   - [`requester(impl Into<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::requester) / [`set_requester(Option<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::set_requester):<br>required: **false**<br>Who initiated the chat end request (optional, defaults to 'CloudSmith')<br>
10    ///   - [`client_token(impl Into<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::set_client_token):<br>required: **false**<br>Client-provided token for idempotent operations<br>
11    /// - On success, responds with [`EndChatForCaseOutput`](crate::operation::end_chat_for_case::EndChatForCaseOutput) with field(s):
12    ///   - [`is_disconnected(bool)`](crate::operation::end_chat_for_case::EndChatForCaseOutput::is_disconnected): Whether the chat session was successfully ended
13    ///   - [`execution_id(Option<String>)`](crate::operation::end_chat_for_case::EndChatForCaseOutput::execution_id): The execution ID that was ended
14    ///   - [`error_message(Option<String>)`](crate::operation::end_chat_for_case::EndChatForCaseOutput::error_message): Error message if the disconnect failed
15    /// - On failure, responds with [`SdkError<EndChatForCaseError>`](crate::operation::end_chat_for_case::EndChatForCaseError)
16    pub fn end_chat_for_case(&self) -> crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder {
17        crate::operation::end_chat_for_case::builders::EndChatForCaseFluentBuilder::new(self.handle.clone())
18    }
19}