aws_sdk_ec2/operation/create_image_usage_report/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_image_usage_report::_create_image_usage_report_output::CreateImageUsageReportOutputBuilder;
3
4pub use crate::operation::create_image_usage_report::_create_image_usage_report_input::CreateImageUsageReportInputBuilder;
5
6impl crate::operation::create_image_usage_report::builders::CreateImageUsageReportInputBuilder {
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::create_image_usage_report::CreateImageUsageReportOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_image_usage_report::CreateImageUsageReportError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_image_usage_report();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateImageUsageReport`.
24///
25/// <p>Creates a report that shows how your image is used across other Amazon Web Services accounts. The report provides visibility into which accounts are using the specified image, and how many resources (EC2 instances or launch templates) are referencing it.</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 CreateImageUsageReportFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_image_usage_report::builders::CreateImageUsageReportInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_image_usage_report::CreateImageUsageReportOutput,
36        crate::operation::create_image_usage_report::CreateImageUsageReportError,
37    > for CreateImageUsageReportFluentBuilder
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::create_image_usage_report::CreateImageUsageReportOutput,
45            crate::operation::create_image_usage_report::CreateImageUsageReportError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateImageUsageReportFluentBuilder {
52    /// Creates a new `CreateImageUsageReportFluentBuilder`.
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 CreateImageUsageReport as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_image_usage_report::builders::CreateImageUsageReportInputBuilder {
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::create_image_usage_report::CreateImageUsageReportOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_image_usage_report::CreateImageUsageReportError,
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::create_image_usage_report::CreateImageUsageReport::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_image_usage_report::CreateImageUsageReport::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::create_image_usage_report::CreateImageUsageReportOutput,
98        crate::operation::create_image_usage_report::CreateImageUsageReportError,
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    /// <p>The ID of the image to report on.</p>
113    pub fn image_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.image_id(input.into());
115        self
116    }
117    /// <p>The ID of the image to report on.</p>
118    pub fn set_image_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_image_id(input);
120        self
121    }
122    /// <p>The ID of the image to report on.</p>
123    pub fn get_image_id(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_image_id()
125    }
126    /// <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>
127    pub fn dry_run(mut self, input: bool) -> Self {
128        self.inner = self.inner.dry_run(input);
129        self
130    }
131    /// <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>
132    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
133        self.inner = self.inner.set_dry_run(input);
134        self
135    }
136    /// <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>
137    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
138        self.inner.get_dry_run()
139    }
140    ///
141    /// Appends an item to `ResourceTypes`.
142    ///
143    /// To override the contents of this collection use [`set_resource_types`](Self::set_resource_types).
144    ///
145    /// <p>The resource types to include in the report.</p>
146    pub fn resource_types(mut self, input: crate::types::ImageUsageResourceTypeRequest) -> Self {
147        self.inner = self.inner.resource_types(input);
148        self
149    }
150    /// <p>The resource types to include in the report.</p>
151    pub fn set_resource_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ImageUsageResourceTypeRequest>>) -> Self {
152        self.inner = self.inner.set_resource_types(input);
153        self
154    }
155    /// <p>The resource types to include in the report.</p>
156    pub fn get_resource_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ImageUsageResourceTypeRequest>> {
157        self.inner.get_resource_types()
158    }
159    ///
160    /// Appends an item to `AccountIds`.
161    ///
162    /// To override the contents of this collection use [`set_account_ids`](Self::set_account_ids).
163    ///
164    /// <p>The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.</p>
165    pub fn account_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166        self.inner = self.inner.account_ids(input.into());
167        self
168    }
169    /// <p>The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.</p>
170    pub fn set_account_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
171        self.inner = self.inner.set_account_ids(input);
172        self
173    }
174    /// <p>The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.</p>
175    pub fn get_account_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
176        self.inner.get_account_ids()
177    }
178    /// <p>A unique, case-sensitive identifier that you provide to ensure idempotency of the request.</p>
179    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180        self.inner = self.inner.client_token(input.into());
181        self
182    }
183    /// <p>A unique, case-sensitive identifier that you provide to ensure idempotency of the request.</p>
184    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185        self.inner = self.inner.set_client_token(input);
186        self
187    }
188    /// <p>A unique, case-sensitive identifier that you provide to ensure idempotency of the request.</p>
189    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
190        self.inner.get_client_token()
191    }
192    ///
193    /// Appends an item to `TagSpecifications`.
194    ///
195    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
196    ///
197    /// <p>The tags to apply to the report on creation. The <code>ResourceType</code> must be set to <code>image-usage-report</code>; any other value will cause the report creation to fail.</p>
198    /// <p>To tag a report after it has been created, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html">CreateTags</a>.</p>
199    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
200        self.inner = self.inner.tag_specifications(input);
201        self
202    }
203    /// <p>The tags to apply to the report on creation. The <code>ResourceType</code> must be set to <code>image-usage-report</code>; any other value will cause the report creation to fail.</p>
204    /// <p>To tag a report after it has been created, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html">CreateTags</a>.</p>
205    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
206        self.inner = self.inner.set_tag_specifications(input);
207        self
208    }
209    /// <p>The tags to apply to the report on creation. The <code>ResourceType</code> must be set to <code>image-usage-report</code>; any other value will cause the report creation to fail.</p>
210    /// <p>To tag a report after it has been created, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html">CreateTags</a>.</p>
211    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
212        self.inner.get_tag_specifications()
213    }
214}