aws_sdk_sagemaker/client/
describe_reserved_capacity.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 [`DescribeReservedCapacity`](crate::operation::describe_reserved_capacity::builders::DescribeReservedCapacityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`reserved_capacity_arn(impl Into<String>)`](crate::operation::describe_reserved_capacity::builders::DescribeReservedCapacityFluentBuilder::reserved_capacity_arn) / [`set_reserved_capacity_arn(Option<String>)`](crate::operation::describe_reserved_capacity::builders::DescribeReservedCapacityFluentBuilder::set_reserved_capacity_arn):<br>required: **true**<br><p>ARN of the reserved capacity to describe.</p><br>
7    /// - On success, responds with [`DescribeReservedCapacityOutput`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput) with field(s):
8    ///   - [`reserved_capacity_arn(Option<String>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::reserved_capacity_arn): <p>ARN of the reserved capacity.</p>
9    ///   - [`reserved_capacity_type(Option<ReservedCapacityType>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::reserved_capacity_type): <p>The type of reserved capacity.</p>
10    ///   - [`status(Option<ReservedCapacityStatus>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::status): <p>The current status of the reserved capacity.</p>
11    ///   - [`availability_zone(Option<String>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::availability_zone): <p>The Availability Zone where the reserved capacity is provisioned.</p>
12    ///   - [`duration_hours(Option<i64>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::duration_hours): <p>The total duration of the reserved capacity in hours.</p>
13    ///   - [`duration_minutes(Option<i64>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::duration_minutes): <p>The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.</p>
14    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::start_time): <p>The timestamp when the reserved capacity becomes active.</p>
15    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::end_time): <p>The timestamp when the reserved capacity expires.</p>
16    ///   - [`instance_type(Option<ReservedCapacityInstanceType>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::instance_type): <p>The Amazon EC2 instance type used in the reserved capacity.</p>
17    ///   - [`total_instance_count(Option<i32>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::total_instance_count): <p>The total number of instances allocated to this reserved capacity.</p>
18    ///   - [`available_instance_count(Option<i32>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::available_instance_count): <p>The number of instances currently available for use in this reserved capacity.</p>
19    ///   - [`in_use_instance_count(Option<i32>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::in_use_instance_count): <p>The number of instances currently in use from this reserved capacity.</p>
20    ///   - [`ultra_server_summary(Option<UltraServerSummary>)`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityOutput::ultra_server_summary): <p>A summary of the UltraServer associated with this reserved capacity.</p>
21    /// - On failure, responds with [`SdkError<DescribeReservedCapacityError>`](crate::operation::describe_reserved_capacity::DescribeReservedCapacityError)
22    pub fn describe_reserved_capacity(&self) -> crate::operation::describe_reserved_capacity::builders::DescribeReservedCapacityFluentBuilder {
23        crate::operation::describe_reserved_capacity::builders::DescribeReservedCapacityFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_sagemaker/client/describe_reserved_capacity.rs

aws_sdk_sagemaker/client/
describe_reserved_capacity.rs
