Struct aws_sdk_ec2::client::fluent_builders::DescribeSpotInstanceRequests

pub struct DescribeSpotInstanceRequests { /* private fields */ }

Fluent builder constructing a request to DescribeSpotInstanceRequests.

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

Implementations

impl DescribeSpotInstanceRequests

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeSpotInstanceRequests, AwsResponseRetryClassifier>, SdkError<DescribeSpotInstanceRequestsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeSpotInstanceRequestsOutput, SdkError<DescribeSpotInstanceRequestsError>>

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, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeSpotInstanceRequestsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

Appends an item to Filters.

To override the contents of this collection use set_filters.

One or more filters.

• availability-zone-group - The Availability Zone group.

• create-time - The time stamp when the Spot Instance request was created.

• fault-code - The fault code related to the request.

• fault-message - The fault message related to the request.

• instance-id - The ID of the instance that fulfilled the request.

• launch-group - The Spot Instance launch group.

• launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

• launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

• launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

• launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

• launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

• launch.group-id - The ID of the security group for the instance.

• launch.group-name - The name of the security group for the instance.

• launch.image-id - The ID of the AMI.

• launch.instance-type - The type of instance (for example, m3.medium).

• launch.kernel-id - The kernel ID.

• launch.key-name - The name of the key pair the instance launched with.

• launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

• launch.ramdisk-id - The RAM disk ID.

• launched-availability-zone - The Availability Zone in which the request is launched.

• network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

• network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

• network-interface.description - A description of the network interface.

• network-interface.device-index - The index of the device for the network interface attachment on the instance.

• network-interface.group-id - The ID of the security group associated with the network interface.

• network-interface.network-interface-id - The ID of the network interface.

• network-interface.private-ip-address - The primary private IP address of the network interface.

• network-interface.subnet-id - The ID of the subnet for the instance.

• product-description - The product description associated with the instance (Linux/UNIX | Windows).

• spot-instance-request-id - The Spot Instance request ID.

• spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

• state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.

• status-code - The short code describing the most recent evaluation of your Spot Instance request.

• status-message - The message explaining the status of the Spot Instance request.

• tag: - 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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - 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.

• type - The type of Spot Instance request (one-time | persistent).

• valid-from - The start date of the request.

• valid-until - The end date of the request.

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

One or more filters.

• availability-zone-group - The Availability Zone group.

• create-time - The time stamp when the Spot Instance request was created.

• fault-code - The fault code related to the request.

• fault-message - The fault message related to the request.

• instance-id - The ID of the instance that fulfilled the request.

• launch-group - The Spot Instance launch group.

• launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

• launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

• launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

• launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

• launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

• launch.group-id - The ID of the security group for the instance.

• launch.group-name - The name of the security group for the instance.

• launch.image-id - The ID of the AMI.

• launch.instance-type - The type of instance (for example, m3.medium).

• launch.kernel-id - The kernel ID.

• launch.key-name - The name of the key pair the instance launched with.

• launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

• launch.ramdisk-id - The RAM disk ID.

• launched-availability-zone - The Availability Zone in which the request is launched.

• network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

• network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

• network-interface.description - A description of the network interface.

• network-interface.device-index - The index of the device for the network interface attachment on the instance.

• network-interface.group-id - The ID of the security group associated with the network interface.

• network-interface.network-interface-id - The ID of the network interface.

• network-interface.private-ip-address - The primary private IP address of the network interface.

• network-interface.subnet-id - The ID of the subnet for the instance.

• product-description - The product description associated with the instance (Linux/UNIX | Windows).

• spot-instance-request-id - The Spot Instance request ID.

• spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

• state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.

• status-code - The short code describing the most recent evaluation of your Spot Instance request.

• status-message - The message explaining the status of the Spot Instance request.

• tag: - 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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - 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.

• type - The type of Spot Instance request (one-time | persistent).

• valid-from - The start date of the request.

• valid-until - The end date of the request.

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.

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.

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

Appends an item to SpotInstanceRequestIds.

To override the contents of this collection use set_spot_instance_request_ids.

One or more Spot Instance request IDs.

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

One or more Spot Instance request IDs.

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

The token to request the next set of results. This value is null when there are no more results to return.

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

The token to request the next set of results. This value is null when there are no more results to return.

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

The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

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

The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

Trait Implementations

impl Clone for DescribeSpotInstanceRequests

fn clone(&self) -> DescribeSpotInstanceRequests

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSpotInstanceRequests

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

Formats the value using the given formatter.