aws_sdk_batch/client/
describe_consumable_resource.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 [`DescribeConsumableResource`](crate::operation::describe_consumable_resource::builders::DescribeConsumableResourceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`consumable_resource(impl Into<String>)`](crate::operation::describe_consumable_resource::builders::DescribeConsumableResourceFluentBuilder::consumable_resource) / [`set_consumable_resource(Option<String>)`](crate::operation::describe_consumable_resource::builders::DescribeConsumableResourceFluentBuilder::set_consumable_resource):<br>required: **true**<br><p>The name or ARN of the consumable resource whose description will be returned.</p><br>
7    /// - On success, responds with [`DescribeConsumableResourceOutput`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput) with field(s):
8    ///   - [`consumable_resource_name(Option<String>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::consumable_resource_name): <p>The name of the consumable resource.</p>
9    ///   - [`consumable_resource_arn(Option<String>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::consumable_resource_arn): <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
10    ///   - [`total_quantity(Option<i64>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::total_quantity): <p>The total amount of the consumable resource that is available.</p>
11    ///   - [`in_use_quantity(Option<i64>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::in_use_quantity): <p>The amount of the consumable resource that is currently in use.</p>
12    ///   - [`available_quantity(Option<i64>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::available_quantity): <p>The amount of the consumable resource that is currently available to use.</p>
13    ///   - [`resource_type(Option<String>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::resource_type): <p>Indicates whether the resource is available to be re-used after a job completes. Can be one of:</p> <ul>  <li>   <p><code>REPLENISHABLE</code></p></li>  <li>   <p><code>NON_REPLENISHABLE</code></p></li> </ul>
14    ///   - [`created_at(Option<i64>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::created_at): <p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>
15    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_consumable_resource::DescribeConsumableResourceOutput::tags): <p>The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
16    /// - On failure, responds with [`SdkError<DescribeConsumableResourceError>`](crate::operation::describe_consumable_resource::DescribeConsumableResourceError)
17    pub fn describe_consumable_resource(&self) -> crate::operation::describe_consumable_resource::builders::DescribeConsumableResourceFluentBuilder {
18        crate::operation::describe_consumable_resource::builders::DescribeConsumableResourceFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_batch/client/describe_consumable_resource.rs

aws_sdk_batch/client/
describe_consumable_resource.rs
