com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeSpotInstanceRequestsRequestMarshaller;
/**
*
* Contains the parameters for DescribeSpotInstanceRequests.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The IDs of the Spot Instance requests.
*
*/
private com.amazonaws.internal.SdkInternalList spotInstanceRequestIds;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* 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.
*
*/
private Integer maxResults;
/**
*
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*
*
* @return The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*
*
* @param filters
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
*
*
* @param filters
* The 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 or
* gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,
* st1 for Throughput Optimized HDD, sc1 for 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.
*
*
* -
*
* 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> - 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The IDs of the Spot Instance requests.
*
*
* @return The IDs of the Spot Instance requests.
*/
public java.util.List getSpotInstanceRequestIds() {
if (spotInstanceRequestIds == null) {
spotInstanceRequestIds = new com.amazonaws.internal.SdkInternalList();
}
return spotInstanceRequestIds;
}
/**
*
* The IDs of the Spot Instance requests.
*
*
* @param spotInstanceRequestIds
* The IDs of the Spot Instance requests.
*/
public void setSpotInstanceRequestIds(java.util.Collection spotInstanceRequestIds) {
if (spotInstanceRequestIds == null) {
this.spotInstanceRequestIds = null;
return;
}
this.spotInstanceRequestIds = new com.amazonaws.internal.SdkInternalList(spotInstanceRequestIds);
}
/**
*
* The IDs of the Spot Instance requests.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSpotInstanceRequestIds(java.util.Collection)} or
* {@link #withSpotInstanceRequestIds(java.util.Collection)} if you want to override the existing values.
*
*
* @param spotInstanceRequestIds
* The IDs of the Spot Instance requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(String... spotInstanceRequestIds) {
if (this.spotInstanceRequestIds == null) {
setSpotInstanceRequestIds(new com.amazonaws.internal.SdkInternalList(spotInstanceRequestIds.length));
}
for (String ele : spotInstanceRequestIds) {
this.spotInstanceRequestIds.add(ele);
}
return this;
}
/**
*
* The IDs of the Spot Instance requests.
*
*
* @param spotInstanceRequestIds
* The IDs of the Spot Instance requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withSpotInstanceRequestIds(java.util.Collection spotInstanceRequestIds) {
setSpotInstanceRequestIds(spotInstanceRequestIds);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* @param maxResults
* 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.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* 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.
*
*
* @param maxResults
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSpotInstanceRequestsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeSpotInstanceRequestsRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getSpotInstanceRequestIds() != null)
sb.append("SpotInstanceRequestIds: ").append(getSpotInstanceRequestIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeSpotInstanceRequestsRequest == false)
return false;
DescribeSpotInstanceRequestsRequest other = (DescribeSpotInstanceRequestsRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getSpotInstanceRequestIds() == null ^ this.getSpotInstanceRequestIds() == null)
return false;
if (other.getSpotInstanceRequestIds() != null && other.getSpotInstanceRequestIds().equals(this.getSpotInstanceRequestIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getSpotInstanceRequestIds() == null) ? 0 : getSpotInstanceRequestIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeSpotInstanceRequestsRequest clone() {
return (DescribeSpotInstanceRequestsRequest) super.clone();
}
}