aws_sdk_ec2/operation/describe_image_usage_reports/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_image_usage_reports::_describe_image_usage_reports_output::DescribeImageUsageReportsOutputBuilder;
3
4pub use crate::operation::describe_image_usage_reports::_describe_image_usage_reports_input::DescribeImageUsageReportsInputBuilder;
5
6impl crate::operation::describe_image_usage_reports::builders::DescribeImageUsageReportsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_image_usage_reports::DescribeImageUsageReportsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_image_usage_reports();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeImageUsageReports`.
24///
25/// <p>Describes the configuration and status of image usage reports, filtered by report IDs or image IDs.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html">View your AMI usage</a> in the <i>Amazon EC2 User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeImageUsageReportsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_image_usage_reports::builders::DescribeImageUsageReportsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsOutput,
36        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsError,
37    > for DescribeImageUsageReportsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::describe_image_usage_reports::DescribeImageUsageReportsOutput,
45            crate::operation::describe_image_usage_reports::DescribeImageUsageReportsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeImageUsageReportsFluentBuilder {
52    /// Creates a new `DescribeImageUsageReportsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the DescribeImageUsageReports as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_image_usage_reports::builders::DescribeImageUsageReportsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_image_usage_reports::DescribeImageUsageReportsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::describe_image_usage_reports::DescribeImageUsageReports::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_image_usage_reports::DescribeImageUsageReports::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsOutput,
98        crate::operation::describe_image_usage_reports::DescribeImageUsageReportsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::describe_image_usage_reports::paginator::DescribeImageUsageReportsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_image_usage_reports::paginator::DescribeImageUsageReportsPaginator {
116        crate::operation::describe_image_usage_reports::paginator::DescribeImageUsageReportsPaginator::new(self.handle, self.inner)
117    }
118    ///
119    /// Appends an item to `ImageIds`.
120    ///
121    /// To override the contents of this collection use [`set_image_ids`](Self::set_image_ids).
122    ///
123    /// <p>The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.</p>
124    pub fn image_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125        self.inner = self.inner.image_ids(input.into());
126        self
127    }
128    /// <p>The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.</p>
129    pub fn set_image_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
130        self.inner = self.inner.set_image_ids(input);
131        self
132    }
133    /// <p>The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.</p>
134    pub fn get_image_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
135        self.inner.get_image_ids()
136    }
137    ///
138    /// Appends an item to `ReportIds`.
139    ///
140    /// To override the contents of this collection use [`set_report_ids`](Self::set_report_ids).
141    ///
142    /// <p>The IDs of the image usage reports.</p>
143    pub fn report_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.report_ids(input.into());
145        self
146    }
147    /// <p>The IDs of the image usage reports.</p>
148    pub fn set_report_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
149        self.inner = self.inner.set_report_ids(input);
150        self
151    }
152    /// <p>The IDs of the image usage reports.</p>
153    pub fn get_report_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
154        self.inner.get_report_ids()
155    }
156    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
157    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158        self.inner = self.inner.next_token(input.into());
159        self
160    }
161    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
162    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.inner = self.inner.set_next_token(input);
164        self
165    }
166    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
167    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
168        self.inner.get_next_token()
169    }
170    ///
171    /// Appends an item to `Filters`.
172    ///
173    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
174    ///
175    /// <p>The filters.</p>
176    /// <ul>
177    /// <li>
178    /// <p><code>creation-time</code> - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2025-11-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2025-11-29T*</code>, which matches an entire day.</p></li>
179    /// <li>
180    /// <p><code>state</code> - The state of the report (<code>available</code> | <code>pending</code> | <code>error</code>).</p></li>
181    /// <li>
182    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
183    /// <li>
184    /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
185    /// </ul>
186    pub fn filters(mut self, input: crate::types::Filter) -> Self {
187        self.inner = self.inner.filters(input);
188        self
189    }
190    /// <p>The filters.</p>
191    /// <ul>
192    /// <li>
193    /// <p><code>creation-time</code> - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2025-11-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2025-11-29T*</code>, which matches an entire day.</p></li>
194    /// <li>
195    /// <p><code>state</code> - The state of the report (<code>available</code> | <code>pending</code> | <code>error</code>).</p></li>
196    /// <li>
197    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
198    /// <li>
199    /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
200    /// </ul>
201    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
202        self.inner = self.inner.set_filters(input);
203        self
204    }
205    /// <p>The filters.</p>
206    /// <ul>
207    /// <li>
208    /// <p><code>creation-time</code> - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, <code>2025-11-29T11:04:43.305Z</code>. You can use a wildcard (<code>*</code>), for example, <code>2025-11-29T*</code>, which matches an entire day.</p></li>
209    /// <li>
210    /// <p><code>state</code> - The state of the report (<code>available</code> | <code>pending</code> | <code>error</code>).</p></li>
211    /// <li>
212    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
213    /// <li>
214    /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
215    /// </ul>
216    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
217        self.inner.get_filters()
218    }
219    /// <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>
220    pub fn dry_run(mut self, input: bool) -> Self {
221        self.inner = self.inner.dry_run(input);
222        self
223    }
224    /// <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>
225    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
226        self.inner = self.inner.set_dry_run(input);
227        self
228    }
229    /// <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>
230    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
231        self.inner.get_dry_run()
232    }
233    /// <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>
234    pub fn max_results(mut self, input: i32) -> Self {
235        self.inner = self.inner.max_results(input);
236        self
237    }
238    /// <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>
239    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
240        self.inner = self.inner.set_max_results(input);
241        self
242    }
243    /// <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>
244    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
245        self.inner.get_max_results()
246    }
247}