aws_sdk_ec2/operation/describe_flow_logs/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_flow_logs::_describe_flow_logs_output::DescribeFlowLogsOutputBuilder;
3
4pub use crate::operation::describe_flow_logs::_describe_flow_logs_input::DescribeFlowLogsInputBuilder;
5
6impl crate::operation::describe_flow_logs::builders::DescribeFlowLogsInputBuilder {
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_flow_logs::DescribeFlowLogsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_flow_logs::DescribeFlowLogsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_flow_logs();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeFlowLogs`.
24///
25/// <p>Describes one or more flow logs.</p>
26/// <p>To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeFlowLogsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_flow_logs::builders::DescribeFlowLogsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_flow_logs::DescribeFlowLogsOutput,
36        crate::operation::describe_flow_logs::DescribeFlowLogsError,
37    > for DescribeFlowLogsFluentBuilder
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_flow_logs::DescribeFlowLogsOutput,
45            crate::operation::describe_flow_logs::DescribeFlowLogsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeFlowLogsFluentBuilder {
52    /// Creates a new `DescribeFlowLogsFluentBuilder`.
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 DescribeFlowLogs as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_flow_logs::builders::DescribeFlowLogsInputBuilder {
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_flow_logs::DescribeFlowLogsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_flow_logs::DescribeFlowLogsError,
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_flow_logs::DescribeFlowLogs::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_flow_logs::DescribeFlowLogs::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_flow_logs::DescribeFlowLogsOutput,
98        crate::operation::describe_flow_logs::DescribeFlowLogsError,
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_flow_logs::paginator::DescribeFlowLogsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_flow_logs::paginator::DescribeFlowLogsPaginator {
116        crate::operation::describe_flow_logs::paginator::DescribeFlowLogsPaginator::new(self.handle, self.inner)
117    }
118    /// <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>
119    pub fn dry_run(mut self, input: bool) -> Self {
120        self.inner = self.inner.dry_run(input);
121        self
122    }
123    /// <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>
124    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
125        self.inner = self.inner.set_dry_run(input);
126        self
127    }
128    /// <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>
129    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
130        self.inner.get_dry_run()
131    }
132    ///
133    /// Appends an item to `Filter`.
134    ///
135    /// To override the contents of this collection use [`set_filter`](Self::set_filter).
136    ///
137    /// <p>One or more filters.</p>
138    /// <ul>
139    /// <li>
140    /// <p><code>deliver-log-status</code> - The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>).</p></li>
141    /// <li>
142    /// <p><code>log-destination-type</code> - The type of destination for the flow log data (<code>cloud-watch-logs</code> | <code>s3</code> | <code>kinesis-data-firehose</code>).</p></li>
143    /// <li>
144    /// <p><code>flow-log-id</code> - The ID of the flow log.</p></li>
145    /// <li>
146    /// <p><code>log-group-name</code> - The name of the log group.</p></li>
147    /// <li>
148    /// <p><code>resource-id</code> - The ID of the VPC, subnet, or network interface.</p></li>
149    /// <li>
150    /// <p><code>traffic-type</code> - The type of traffic (<code>ACCEPT</code> | <code>REJECT</code> | <code>ALL</code>).</p></li>
151    /// <li>
152    /// <p><code>tag</code>:<key>
153    /// - 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
154    /// <code>Owner</code> and the value
155    /// <code>TeamA</code>, specify
156    /// <code>tag:Owner</code> for the filter name and
157    /// <code>TeamA</code> for the filter value.
158    /// </key></p></li>
159    /// <li>
160    /// <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>
161    /// </ul>
162    pub fn filter(mut self, input: crate::types::Filter) -> Self {
163        self.inner = self.inner.filter(input);
164        self
165    }
166    /// <p>One or more filters.</p>
167    /// <ul>
168    /// <li>
169    /// <p><code>deliver-log-status</code> - The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>).</p></li>
170    /// <li>
171    /// <p><code>log-destination-type</code> - The type of destination for the flow log data (<code>cloud-watch-logs</code> | <code>s3</code> | <code>kinesis-data-firehose</code>).</p></li>
172    /// <li>
173    /// <p><code>flow-log-id</code> - The ID of the flow log.</p></li>
174    /// <li>
175    /// <p><code>log-group-name</code> - The name of the log group.</p></li>
176    /// <li>
177    /// <p><code>resource-id</code> - The ID of the VPC, subnet, or network interface.</p></li>
178    /// <li>
179    /// <p><code>traffic-type</code> - The type of traffic (<code>ACCEPT</code> | <code>REJECT</code> | <code>ALL</code>).</p></li>
180    /// <li>
181    /// <p><code>tag</code>:<key>
182    /// - 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
183    /// <code>Owner</code> and the value
184    /// <code>TeamA</code>, specify
185    /// <code>tag:Owner</code> for the filter name and
186    /// <code>TeamA</code> for the filter value.
187    /// </key></p></li>
188    /// <li>
189    /// <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>
190    /// </ul>
191    pub fn set_filter(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
192        self.inner = self.inner.set_filter(input);
193        self
194    }
195    /// <p>One or more filters.</p>
196    /// <ul>
197    /// <li>
198    /// <p><code>deliver-log-status</code> - The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>).</p></li>
199    /// <li>
200    /// <p><code>log-destination-type</code> - The type of destination for the flow log data (<code>cloud-watch-logs</code> | <code>s3</code> | <code>kinesis-data-firehose</code>).</p></li>
201    /// <li>
202    /// <p><code>flow-log-id</code> - The ID of the flow log.</p></li>
203    /// <li>
204    /// <p><code>log-group-name</code> - The name of the log group.</p></li>
205    /// <li>
206    /// <p><code>resource-id</code> - The ID of the VPC, subnet, or network interface.</p></li>
207    /// <li>
208    /// <p><code>traffic-type</code> - The type of traffic (<code>ACCEPT</code> | <code>REJECT</code> | <code>ALL</code>).</p></li>
209    /// <li>
210    /// <p><code>tag</code>:<key>
211    /// - 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
212    /// <code>Owner</code> and the value
213    /// <code>TeamA</code>, specify
214    /// <code>tag:Owner</code> for the filter name and
215    /// <code>TeamA</code> for the filter value.
216    /// </key></p></li>
217    /// <li>
218    /// <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>
219    /// </ul>
220    pub fn get_filter(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
221        self.inner.get_filter()
222    }
223    ///
224    /// Appends an item to `FlowLogIds`.
225    ///
226    /// To override the contents of this collection use [`set_flow_log_ids`](Self::set_flow_log_ids).
227    ///
228    /// <p>One or more flow log IDs.</p>
229    /// <p>Constraint: Maximum of 1000 flow log IDs.</p>
230    pub fn flow_log_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
231        self.inner = self.inner.flow_log_ids(input.into());
232        self
233    }
234    /// <p>One or more flow log IDs.</p>
235    /// <p>Constraint: Maximum of 1000 flow log IDs.</p>
236    pub fn set_flow_log_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
237        self.inner = self.inner.set_flow_log_ids(input);
238        self
239    }
240    /// <p>One or more flow log IDs.</p>
241    /// <p>Constraint: Maximum of 1000 flow log IDs.</p>
242    pub fn get_flow_log_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
243        self.inner.get_flow_log_ids()
244    }
245    /// <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>
246    pub fn max_results(mut self, input: i32) -> Self {
247        self.inner = self.inner.max_results(input);
248        self
249    }
250    /// <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>
251    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
252        self.inner = self.inner.set_max_results(input);
253        self
254    }
255    /// <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>
256    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
257        self.inner.get_max_results()
258    }
259    /// <p>The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.</p>
260    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
261        self.inner = self.inner.next_token(input.into());
262        self
263    }
264    /// <p>The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.</p>
265    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
266        self.inner = self.inner.set_next_token(input);
267        self
268    }
269    /// <p>The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.</p>
270    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
271        self.inner.get_next_token()
272    }
273}