aws_sdk_ec2/operation/describe_instance_event_windows/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_instance_event_windows::_describe_instance_event_windows_output::DescribeInstanceEventWindowsOutputBuilder;

pub use crate::operation::describe_instance_event_windows::_describe_instance_event_windows_input::DescribeInstanceEventWindowsInputBuilder;

impl crate::operation::describe_instance_event_windows::builders::DescribeInstanceEventWindowsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_instance_event_windows();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeInstanceEventWindows`.
///
/// <p>Describes the specified event windows or all event windows.</p>
/// <p>If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeInstanceEventWindowsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_instance_event_windows::builders::DescribeInstanceEventWindowsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsOutput,
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsError,
    > for DescribeInstanceEventWindowsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsOutput,
            crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeInstanceEventWindowsFluentBuilder {
    /// Creates a new `DescribeInstanceEventWindowsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the DescribeInstanceEventWindows as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_instance_event_windows::builders::DescribeInstanceEventWindowsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::describe_instance_event_windows::DescribeInstanceEventWindows::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindows::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsOutput,
        crate::operation::describe_instance_event_windows::DescribeInstanceEventWindowsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::describe_instance_event_windows::paginator::DescribeInstanceEventWindowsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_instance_event_windows::paginator::DescribeInstanceEventWindowsPaginator {
        crate::operation::describe_instance_event_windows::paginator::DescribeInstanceEventWindowsPaginator::new(self.handle, self.inner)
    }
    /// <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>
    pub fn dry_run(mut self, input: bool) -> Self {
        self.inner = self.inner.dry_run(input);
        self
    }
    /// <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>
    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_dry_run(input);
        self
    }
    /// <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>
    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
        self.inner.get_dry_run()
    }
    ///
    /// Appends an item to `InstanceEventWindowIds`.
    ///
    /// To override the contents of this collection use [`set_instance_event_window_ids`](Self::set_instance_event_window_ids).
    ///
    /// <p>The IDs of the event windows.</p>
    pub fn instance_event_window_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.instance_event_window_ids(input.into());
        self
    }
    /// <p>The IDs of the event windows.</p>
    pub fn set_instance_event_window_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_instance_event_window_ids(input);
        self
    }
    /// <p>The IDs of the event windows.</p>
    pub fn get_instance_event_window_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_instance_event_window_ids()
    }
    ///
    /// Appends an item to `Filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>dedicated-host-id</code> - The event windows associated with the specified Dedicated Host ID.</p></li>
    /// <li>
    /// <p><code>event-window-name</code> - The event windows associated with the specified names.</p></li>
    /// <li>
    /// <p><code>instance-id</code> - The event windows associated with the specified instance ID.</p></li>
    /// <li>
    /// <p><code>instance-tag</code> - The event windows associated with the specified tag and value.</p></li>
    /// <li>
    /// <p><code>instance-tag-key</code> - The event windows associated with the specified tag key, regardless of the value.</p></li>
    /// <li>
    /// <p><code>instance-tag-value</code> - The event windows associated with the specified tag value, regardless of the key.</p></li>
    /// <li>
    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the event window. 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>CMX</code>, specify <code>tag:Owner</code> for the filter name and <code>CMX</code> for the filter value.</p></li>
    /// <li>
    /// <p><code>tag-key</code> - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.</p></li>
    /// <li>
    /// <p><code>tag-value</code> - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.</p></li>
    /// </ul>
    pub fn filters(mut self, input: crate::types::Filter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>dedicated-host-id</code> - The event windows associated with the specified Dedicated Host ID.</p></li>
    /// <li>
    /// <p><code>event-window-name</code> - The event windows associated with the specified names.</p></li>
    /// <li>
    /// <p><code>instance-id</code> - The event windows associated with the specified instance ID.</p></li>
    /// <li>
    /// <p><code>instance-tag</code> - The event windows associated with the specified tag and value.</p></li>
    /// <li>
    /// <p><code>instance-tag-key</code> - The event windows associated with the specified tag key, regardless of the value.</p></li>
    /// <li>
    /// <p><code>instance-tag-value</code> - The event windows associated with the specified tag value, regardless of the key.</p></li>
    /// <li>
    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the event window. 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>CMX</code>, specify <code>tag:Owner</code> for the filter name and <code>CMX</code> for the filter value.</p></li>
    /// <li>
    /// <p><code>tag-key</code> - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.</p></li>
    /// <li>
    /// <p><code>tag-value</code> - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.</p></li>
    /// </ul>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
        self.inner = self.inner.set_filters(input);
        self
    }
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>dedicated-host-id</code> - The event windows associated with the specified Dedicated Host ID.</p></li>
    /// <li>
    /// <p><code>event-window-name</code> - The event windows associated with the specified names.</p></li>
    /// <li>
    /// <p><code>instance-id</code> - The event windows associated with the specified instance ID.</p></li>
    /// <li>
    /// <p><code>instance-tag</code> - The event windows associated with the specified tag and value.</p></li>
    /// <li>
    /// <p><code>instance-tag-key</code> - The event windows associated with the specified tag key, regardless of the value.</p></li>
    /// <li>
    /// <p><code>instance-tag-value</code> - The event windows associated with the specified tag value, regardless of the key.</p></li>
    /// <li>
    /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the event window. 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>CMX</code>, specify <code>tag:Owner</code> for the filter name and <code>CMX</code> for the filter value.</p></li>
    /// <li>
    /// <p><code>tag-key</code> - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.</p></li>
    /// <li>
    /// <p><code>tag-value</code> - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.</p></li>
    /// </ul>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
        self.inner.get_filters()
    }
    /// <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <p>The token to request the next page of results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>The token to request the next page of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>The token to request the next page of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
}