aws_sdk_deadline/client/
get_session.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
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSession`](crate::operation::get_session::builders::GetSessionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID for the session.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the session.</p><br>
    ///   - [`job_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID for the session.</p><br>
    ///   - [`session_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The session ID.</p><br>
    /// - On success, responds with [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput) with field(s):
    ///   - [`session_id(String)`](crate::operation::get_session::GetSessionOutput::session_id): <p>The session ID.</p>
    ///   - [`fleet_id(String)`](crate::operation::get_session::GetSessionOutput::fleet_id): <p>The fleet ID for the session.</p>
    ///   - [`worker_id(String)`](crate::operation::get_session::GetSessionOutput::worker_id): <p>The worker ID for the session.</p>
    ///   - [`started_at(DateTime)`](crate::operation::get_session::GetSessionOutput::started_at): <p>The date and time the resource started running.</p>
    ///   - [`log(Option<LogConfiguration>)`](crate::operation::get_session::GetSessionOutput::log): <p>The session log.</p>
    ///   - [`lifecycle_status(SessionLifecycleStatus)`](crate::operation::get_session::GetSessionOutput::lifecycle_status): <p>The life cycle status of the session.</p>
    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_session::GetSessionOutput::ended_at): <p>The date and time the resource ended running.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_session::GetSessionOutput::updated_at): <p>The date and time the resource was updated.</p>
    ///   - [`updated_by(Option<String>)`](crate::operation::get_session::GetSessionOutput::updated_by): <p>The user or system that updated this resource.</p>
    ///   - [`target_lifecycle_status(Option<SessionLifecycleTargetStatus>)`](crate::operation::get_session::GetSessionOutput::target_lifecycle_status): <p>The life cycle status with which the session started.</p>
    ///   - [`host_properties(Option<HostPropertiesResponse>)`](crate::operation::get_session::GetSessionOutput::host_properties): <p>Provides the Amazon EC2 properties of the host.</p>
    ///   - [`worker_log(Option<LogConfiguration>)`](crate::operation::get_session::GetSessionOutput::worker_log): <p>The worker log for the session.</p>
    /// - On failure, responds with [`SdkError<GetSessionError>`](crate::operation::get_session::GetSessionError)
    pub fn get_session(&self) -> crate::operation::get_session::builders::GetSessionFluentBuilder {
        crate::operation::get_session::builders::GetSessionFluentBuilder::new(self.handle.clone())
    }
}