Struct DescribeInstanceStatusInput

#[non_exhaustive]
pub struct DescribeInstanceStatusInput {
    pub instance_ids: Option<Vec<String>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub dry_run: Option<bool>,
    pub filters: Option<Vec<Filter>>,
    pub include_all_instances: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_ids: Option<Vec<String>>

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

max_results: Option<i32>

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 Pagination.

You cannot specify this parameter and the instance IDs parameter in the same request.

next_token: Option<String>

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

dry_run: Option<bool>

Checks whether you have the required permissions for the operation, 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.

filters: Option<Vec<Filter>>

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).

• operator.managed - A Boolean that indicates whether this is a managed instance.

• operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.

• 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).

• attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).

include_all_instances: Option<bool>

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

Default: false

Implementations

impl DescribeInstanceStatusInput

pub fn instance_ids(&self) -> &[String]

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_ids.is_none().

pub fn max_results(&self) -> Option<i32>

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 Pagination.

You cannot specify this parameter and the instance IDs parameter in the same request.

pub fn next_token(&self) -> Option<&str>

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

pub fn dry_run(&self) -> Option<bool>

Checks whether you have the required permissions for the operation, 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.

pub fn filters(&self) -> &[Filter]

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).

• operator.managed - A Boolean that indicates whether this is a managed instance.

• operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.

• 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).

• attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

pub fn include_all_instances(&self) -> Option<bool>

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

Default: false

impl DescribeInstanceStatusInput

pub fn builder() -> DescribeInstanceStatusInputBuilder

Creates a new builder-style object to manufacture DescribeInstanceStatusInput.

Trait Implementations

impl Clone for DescribeInstanceStatusInput

fn clone(&self) -> DescribeInstanceStatusInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeInstanceStatusInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeInstanceStatusInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DescribeInstanceStatusInput