Struct aws_sdk_ec2::input::describe_instance_status_input::Builder

pub struct Builder { /* private fields */ }

A builder for DescribeInstanceStatusInput.

Implementations

impl Builder

pub fn filters(self, input: Filter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

The filters.

• availability-zone - The Availability Zone of the instance.

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Examples found in repository

src/client.rs (line 39378)

        pub fn filters(mut self, input: crate::model::Filter) -> Self {
            self.inner = self.inner.filters(input);
            self
        }

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

The filters.

• availability-zone - The Availability Zone of the instance.

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Examples found in repository

src/client.rs (line 39401)

        pub fn set_filters(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Filter>>,
        ) -> Self {
            self.inner = self.inner.set_filters(input);
            self
        }

pub fn instance_ids(self, input: impl Into<String>) -> Self

Appends an item to instance_ids.

To override the contents of this collection use set_instance_ids.

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Examples found in repository

src/client.rs (line 39412)

        pub fn instance_ids(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.instance_ids(input.into());
            self
        }

pub fn set_instance_ids(self, input: Option<Vec<String>>) -> Self

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Examples found in repository

src/client.rs (line 39422)

        pub fn set_instance_ids(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_instance_ids(input);
            self
        }

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Examples found in repository

src/client.rs (line 39427)

        pub fn max_results(mut self, input: i32) -> Self {
            self.inner = self.inner.max_results(input);
            self
        }

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Examples found in repository

src/client.rs (line 39432)

        pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_max_results(input);
            self
        }

pub fn next_token(self, input: impl Into<String>) -> Self

The token to retrieve the next page of results.

Examples found in repository

src/client.rs (line 39437)

        pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.next_token(input.into());
            self
        }

pub fn set_next_token(self, input: Option<String>) -> Self

The token to retrieve the next page of results.

Examples found in repository

src/client.rs (line 39442)

        pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_next_token(input);
            self
        }

pub fn dry_run(self, input: bool) -> Self

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 39447)

        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

pub fn set_dry_run(self, input: Option<bool>) -> Self

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 39452)

        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

pub fn include_all_instances(self, input: bool) -> Self

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Examples found in repository

src/client.rs (line 39458)

        pub fn include_all_instances(mut self, input: bool) -> Self {
            self.inner = self.inner.include_all_instances(input);
            self
        }

pub fn set_include_all_instances(self, input: Option<bool>) -> Self

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Examples found in repository

src/client.rs (line 39464)

        pub fn set_include_all_instances(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_include_all_instances(input);
            self
        }

pub fn build(self) -> Result<DescribeInstanceStatusInput, BuildError>

Consumes the builder and constructs a DescribeInstanceStatusInput.

Examples found in repository

src/client.rs (line 39320)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::DescribeInstanceStatus,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::DescribeInstanceStatusError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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::output::DescribeInstanceStatusOutput,
            aws_smithy_http::result::SdkError<crate::error::DescribeInstanceStatusError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

src/paginator.rs (line 3498)

    pub fn send(
        self,
    ) -> impl tokio_stream::Stream<
        Item = std::result::Result<
            crate::output::DescribeInstanceStatusOutput,
            aws_smithy_http::result::SdkError<crate::error::DescribeInstanceStatusError>,
        >,
    > + Unpin {
        // Move individual fields out of self for the borrow checker
        let builder = self.builder;
        let handle = self.handle;
        aws_smithy_async::future::fn_stream::FnStream::new(move |tx| {
            Box::pin(async move {
                // Build the input for the first time. If required fields are missing, this is where we'll produce an early error.
                let mut input = match builder
                    .build()
                    .map_err(aws_smithy_http::result::SdkError::construction_failure)
                {
                    Ok(input) => input,
                    Err(e) => {
                        let _ = tx.send(Err(e)).await;
                        return;
                    }
                };
                loop {
                    let op = match input
                        .make_operation(&handle.conf)
                        .await
                        .map_err(aws_smithy_http::result::SdkError::construction_failure)
                    {
                        Ok(op) => op,
                        Err(e) => {
                            let _ = tx.send(Err(e)).await;
                            return;
                        }
                    };
                    let resp = handle.client.call(op).await;
                    // If the input member is None or it was an error
                    let done = match resp {
                        Ok(ref resp) => {
                            let new_token = crate::lens::reflens_structure_crate_output_describe_instance_status_output_next_token(resp);
                            let is_empty = new_token.map(|token| token.is_empty()).unwrap_or(true);
                            if !is_empty
                                && new_token == input.next_token.as_ref()
                                && self.stop_on_duplicate_token
                            {
                                true
                            } else {
                                input.next_token = new_token.cloned();
                                is_empty
                            }
                        }
                        Err(_) => true,
                    };
                    if tx.send(resp).await.is_err() {
                        // receiving end was dropped
                        return;
                    }
                    if done {
                        return;
                    }
                }
            })
        })
    }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder