com.amazonaws.services.ec2.model
Class DescribeSpotInstanceRequestsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest
All Implemented Interfaces:
DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>, java.io.Serializable

public class DescribeSpotInstanceRequestsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>

Container for the parameters to the DescribeSpotInstanceRequests operation.

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide .

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 .

See Also:
AmazonEC2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest), Serialized Form

Constructor Summary
DescribeSpotInstanceRequestsRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 Request<DescribeSpotInstanceRequestsRequest> getDryRunRequest()
          This method is intended for internal use only.
 java.util.List<Filter> getFilters()
          One or more filters.
 java.util.List<java.lang.String> getSpotInstanceRequestIds()
          One or more Spot Instance request IDs.
 int hashCode()
           
 void setFilters(java.util.Collection<Filter> filters)
          One or more filters.
 void setSpotInstanceRequestIds(java.util.Collection<java.lang.String> spotInstanceRequestIds)
          One or more Spot Instance request IDs.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DescribeSpotInstanceRequestsRequest withFilters(java.util.Collection<Filter> filters)
          One or more filters.
 DescribeSpotInstanceRequestsRequest withFilters(Filter... filters)
          One or more filters.
 DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(java.util.Collection<java.lang.String> spotInstanceRequestIds)
          One or more Spot Instance request IDs.
 DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(java.lang.String... spotInstanceRequestIds)
          One or more Spot Instance request IDs.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DescribeSpotInstanceRequestsRequest

public DescribeSpotInstanceRequestsRequest()
Method Detail

getSpotInstanceRequestIds

public java.util.List<java.lang.String> getSpotInstanceRequestIds()
One or more Spot Instance request IDs.

Returns:
One or more Spot Instance request IDs.

setSpotInstanceRequestIds

public void setSpotInstanceRequestIds(java.util.Collection<java.lang.String> spotInstanceRequestIds)
One or more Spot Instance request IDs.

Parameters:
spotInstanceRequestIds - One or more Spot Instance request IDs.

withSpotInstanceRequestIds

public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(java.lang.String... spotInstanceRequestIds)
One or more Spot Instance request IDs.

Returns a reference to this object so that method calls can be chained together.

Parameters:
spotInstanceRequestIds - One or more Spot Instance request IDs.
Returns:
A reference to this updated object so that method calls can be chained together.

withSpotInstanceRequestIds

public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(java.util.Collection<java.lang.String> spotInstanceRequestIds)
One or more Spot Instance request IDs.

Returns a reference to this object so that method calls can be chained together.

Parameters:
spotInstanceRequestIds - One or more Spot Instance request IDs.
Returns:
A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.List<Filter> getFilters()
One or more filters.

Returns:
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 Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

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

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

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

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

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

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

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

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

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

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

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

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

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

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

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

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

  • launch.network-interface.group-name - The name of the security group associated with the network interface.

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

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

  • 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:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

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


setFilters

public void setFilters(java.util.Collection<Filter> filters)
One or more filters.

Parameters:
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 Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

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

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

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

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

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

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

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

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

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

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

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

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

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

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

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

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

  • launch.network-interface.group-name - The name of the security group associated with the network interface.

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

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

  • 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:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

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


withFilters

public DescribeSpotInstanceRequestsRequest withFilters(Filter... filters)
One or more filters.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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 Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

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

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

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

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

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

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

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

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

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

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

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

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

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

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

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

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

  • launch.network-interface.group-name - The name of the security group associated with the network interface.

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

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

  • 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:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

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

Returns:
A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeSpotInstanceRequestsRequest withFilters(java.util.Collection<Filter> filters)
One or more filters.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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 Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

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

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

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

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

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

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

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

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

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

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

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

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

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

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

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

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

  • launch.network-interface.group-name - The name of the security group associated with the network interface.

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

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

  • 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:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

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

Returns:
A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeSpotInstanceRequestsRequest> getDryRunRequest()
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:
getDryRunRequest in interface DryRunSupportedRequest<DescribeSpotInstanceRequestsRequest>

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.