aws_sdk_ec2/client/describe_spot_fleet_instances.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 [`DescribeSpotFleetInstances`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`dry_run(bool)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
7 /// - [`spot_fleet_request_id(impl Into<String>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::spot_fleet_request_id) / [`set_spot_fleet_request_id(Option<String>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::set_spot_fleet_request_id):<br>required: **true**<br><p>The ID of the Spot Fleet request.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p><br>
9 /// - [`max_results(i32)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p><br>
10 /// - On success, responds with [`DescribeSpotFleetInstancesOutput`](crate::operation::describe_spot_fleet_instances::DescribeSpotFleetInstancesOutput) with field(s):
11 /// - [`active_instances(Option<Vec::<ActiveInstance>>)`](crate::operation::describe_spot_fleet_instances::DescribeSpotFleetInstancesOutput::active_instances): <p>The running instances. This list is refreshed periodically and might be out of date.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::describe_spot_fleet_instances::DescribeSpotFleetInstancesOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
13 /// - [`spot_fleet_request_id(Option<String>)`](crate::operation::describe_spot_fleet_instances::DescribeSpotFleetInstancesOutput::spot_fleet_request_id): <p>The ID of the Spot Fleet request.</p>
14 /// - On failure, responds with [`SdkError<DescribeSpotFleetInstancesError>`](crate::operation::describe_spot_fleet_instances::DescribeSpotFleetInstancesError)
15 pub fn describe_spot_fleet_instances(
16 &self,
17 ) -> crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder {
18 crate::operation::describe_spot_fleet_instances::builders::DescribeSpotFleetInstancesFluentBuilder::new(self.handle.clone())
19 }
20}