aws_sdk_deadline/client/
get_session_action.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 [`GetSessionAction`](crate::operation::get_session_action::builders::GetSessionActionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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>
7    ///   - [`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>
8    ///   - [`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>
9    ///   - [`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>
10    /// - On success, responds with [`GetSessionActionOutput`](crate::operation::get_session_action::GetSessionActionOutput) with field(s):
11    ///   - [`session_action_id(String)`](crate::operation::get_session_action::GetSessionActionOutput::session_action_id): <p>The session action ID.</p>
12    ///   - [`status(SessionActionStatus)`](crate::operation::get_session_action::GetSessionActionOutput::status): <p>The status of the session action.</p>
13    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_session_action::GetSessionActionOutput::started_at): <p>The date and time the resource started running.</p>
14    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_session_action::GetSessionActionOutput::ended_at): <p>The date and time the resource ended running.</p>
15    ///   - [`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>
16    ///   - [`progress_percent(Option<f32>)`](crate::operation::get_session_action::GetSessionActionOutput::progress_percent): <p>The percentage completed for a session action.</p>
17    ///   - [`session_id(String)`](crate::operation::get_session_action::GetSessionActionOutput::session_id): <p>The session ID for the session action.</p>
18    ///   - [`process_exit_code(Option<i32>)`](crate::operation::get_session_action::GetSessionActionOutput::process_exit_code): <p>The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.</p>
19    ///   - [`progress_message(Option<String>)`](crate::operation::get_session_action::GetSessionActionOutput::progress_message): <p>The message that communicates the progress of the session action.</p>
20    ///   - [`definition(Option<SessionActionDefinition>)`](crate::operation::get_session_action::GetSessionActionOutput::definition): <p>The session action definition.</p>
21    ///   - [`acquired_limits(Option<Vec::<AcquiredLimit>>)`](crate::operation::get_session_action::GetSessionActionOutput::acquired_limits): <p>The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.</p>
22    ///   - [`manifests(Option<Vec::<TaskRunManifestPropertiesResponse>>)`](crate::operation::get_session_action::GetSessionActionOutput::manifests): <p>The list of manifest properties that describe file attachments for the task run.</p>
23    /// - On failure, responds with [`SdkError<GetSessionActionError>`](crate::operation::get_session_action::GetSessionActionError)
24    pub fn get_session_action(&self) -> crate::operation::get_session_action::builders::GetSessionActionFluentBuilder {
25        crate::operation::get_session_action::builders::GetSessionActionFluentBuilder::new(self.handle.clone())
26    }
27}