aws_sdk_ec2/client/describe_spot_fleet_request_history.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 [`DescribeSpotFleetRequestHistory`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`dry_run(bool)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::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_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::spot_fleet_request_id) / [`set_spot_fleet_request_id(Option<String>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::set_spot_fleet_request_id):<br>required: **true**<br><p>The ID of the Spot Fleet request.</p><br>
8 /// - [`event_type(EventType)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::event_type) / [`set_event_type(Option<EventType>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::set_event_type):<br>required: **false**<br><p>The type of events to describe. By default, all events are described.</p><br>
9 /// - [`start_time(DateTime)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::set_start_time):<br>required: **true**<br><p>The starting date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::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>
11 /// - [`max_results(i32)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::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>
12 /// - On success, responds with [`DescribeSpotFleetRequestHistoryOutput`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput) with field(s):
13 /// - [`history_records(Option<Vec::<HistoryRecord>>)`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput::history_records): <p>Information about the events in the history of the Spot Fleet request.</p>
14 /// - [`last_evaluated_time(Option<DateTime>)`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput::last_evaluated_time): <p>The last date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). All records up to this time were retrieved.</p> <p>If <code>nextToken</code> indicates that there are more items, this value is not present.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput::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>
16 /// - [`spot_fleet_request_id(Option<String>)`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput::spot_fleet_request_id): <p>The ID of the Spot Fleet request.</p>
17 /// - [`start_time(Option<DateTime>)`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryOutput::start_time): <p>The starting date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p>
18 /// - On failure, responds with [`SdkError<DescribeSpotFleetRequestHistoryError>`](crate::operation::describe_spot_fleet_request_history::DescribeSpotFleetRequestHistoryError)
19 pub fn describe_spot_fleet_request_history(
20 &self,
21 ) -> crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder {
22 crate::operation::describe_spot_fleet_request_history::builders::DescribeSpotFleetRequestHistoryFluentBuilder::new(self.handle.clone())
23 }
24}