aws_sdk_deadline/client/
get_session_action.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSessionAction`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID for the session action.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the session action.</p><br>
    ///   - [`job_id(impl Into<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID for the session.</p><br>
    ///   - [`session_action_id(impl Into<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::session_action_id) / [`set_session_action_id(Option<String>)`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::set_session_action_id):<br>required: **true**<br><p>The session action ID for the session.</p><br>
    /// - On success, responds with [`GetSessionActionOutput`](crate::operation::get_session_action::GetSessionActionOutput) with field(s):
    ///   - [`session_action_id(String)`](crate::operation::get_session_action::GetSessionActionOutput::session_action_id): <p>The session action ID.</p>
    ///   - [`status(SessionActionStatus)`](crate::operation::get_session_action::GetSessionActionOutput::status): <p>The status of the session action.</p>
    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_session_action::GetSessionActionOutput::started_at): <p>The date and time the resource started running.</p>
    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_session_action::GetSessionActionOutput::ended_at): <p>The date and time the resource ended running.</p>
    ///   - [`worker_updated_at(Option<DateTime>)`](crate::operation::get_session_action::GetSessionActionOutput::worker_updated_at): <p>The Linux timestamp of the date and time the session action was last updated.</p>
    ///   - [`progress_percent(Option<f32>)`](crate::operation::get_session_action::GetSessionActionOutput::progress_percent): <p>The percentage completed for a session action.</p>
    ///   - [`session_id(String)`](crate::operation::get_session_action::GetSessionActionOutput::session_id): <p>The session ID for the session action.</p>
    ///   - [`process_exit_code(Option<i32>)`](crate::operation::get_session_action::GetSessionActionOutput::process_exit_code): <p>The exit code to exit the session.</p>
    ///   - [`progress_message(Option<String>)`](crate::operation::get_session_action::GetSessionActionOutput::progress_message): <p>The message that communicates the progress of the session action.</p>
    ///   - [`definition(Option<SessionActionDefinition>)`](crate::operation::get_session_action::GetSessionActionOutput::definition): <p>The session action definition.</p>
    /// - On failure, responds with [`SdkError<GetSessionActionError>`](crate::operation::get_session_action::GetSessionActionError)
    pub fn get_session_action(&self) -> crate::operation::get_session_action::builders::GetSessionActionFluentBuilder {
        crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::new(self.handle.clone())
    }
}