aws_sdk_deadline/client/
get_fleet.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 [`GetFleet`](crate::operation::get_fleet::builders::GetFleetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_fleet::builders::GetFleetFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_fleet::builders::GetFleetFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the farm in the fleet.</p><br>
7    ///   - [`fleet_id(impl Into<String>)`](crate::operation::get_fleet::builders::GetFleetFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::get_fleet::builders::GetFleetFluentBuilder::set_fleet_id):<br>required: **true**<br><p>The fleet ID of the fleet to get.</p><br>
8    /// - On success, responds with [`GetFleetOutput`](crate::operation::get_fleet::GetFleetOutput) with field(s):
9    ///   - [`fleet_id(String)`](crate::operation::get_fleet::GetFleetOutput::fleet_id): <p>The fleet ID.</p>
10    ///   - [`farm_id(String)`](crate::operation::get_fleet::GetFleetOutput::farm_id): <p>The farm ID of the farm in the fleet.</p>
11    ///   - [`display_name(String)`](crate::operation::get_fleet::GetFleetOutput::display_name): <p>The display name of the fleet.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
12    ///   - [`description(Option<String>)`](crate::operation::get_fleet::GetFleetOutput::description): <p>The description of the fleet.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
13    ///   - [`status(FleetStatus)`](crate::operation::get_fleet::GetFleetOutput::status): <p>The status of the fleet.</p>
14    ///   - [`status_message(Option<String>)`](crate::operation::get_fleet::GetFleetOutput::status_message): <p>A message that communicates a suspended status of the fleet.</p>
15    ///   - [`auto_scaling_status(Option<AutoScalingStatus>)`](crate::operation::get_fleet::GetFleetOutput::auto_scaling_status): <p>The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or <code>SHRINKING</code>.</p>
16    ///   - [`target_worker_count(Option<i32>)`](crate::operation::get_fleet::GetFleetOutput::target_worker_count): <p>The number of target workers in the fleet.</p>
17    ///   - [`worker_count(i32)`](crate::operation::get_fleet::GetFleetOutput::worker_count): <p>The number of workers in the fleet.</p>
18    ///   - [`min_worker_count(i32)`](crate::operation::get_fleet::GetFleetOutput::min_worker_count): <p>The minimum number of workers specified in the fleet.</p>
19    ///   - [`max_worker_count(i32)`](crate::operation::get_fleet::GetFleetOutput::max_worker_count): <p>The maximum number of workers specified in the fleet.</p>
20    ///   - [`configuration(Option<FleetConfiguration>)`](crate::operation::get_fleet::GetFleetOutput::configuration): <p>The configuration setting for the fleet.</p>
21    ///   - [`host_configuration(Option<HostConfiguration>)`](crate::operation::get_fleet::GetFleetOutput::host_configuration): <p>The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>
22    ///   - [`capabilities(Option<FleetCapabilities>)`](crate::operation::get_fleet::GetFleetOutput::capabilities): <p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.</p>
23    ///   - [`role_arn(String)`](crate::operation::get_fleet::GetFleetOutput::role_arn): <p>The IAM role ARN.</p>
24    ///   - [`created_at(DateTime)`](crate::operation::get_fleet::GetFleetOutput::created_at): <p>The date and time the resource was created.</p>
25    ///   - [`created_by(String)`](crate::operation::get_fleet::GetFleetOutput::created_by): <p>The user or system that created this resource.</p>
26    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_fleet::GetFleetOutput::updated_at): <p>The date and time the resource was updated.</p>
27    ///   - [`updated_by(Option<String>)`](crate::operation::get_fleet::GetFleetOutput::updated_by): <p>The user or system that updated this resource.</p>
28    /// - On failure, responds with [`SdkError<GetFleetError>`](crate::operation::get_fleet::GetFleetError)
29    pub fn get_fleet(&self) -> crate::operation::get_fleet::builders::GetFleetFluentBuilder {
30        crate::operation::get_fleet::builders::GetFleetFluentBuilder::new(self.handle.clone())
31    }
32}
aws_sdk_deadline/client/get_fleet.rs

aws_sdk_deadline/client/
get_fleet.rs
