You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeSpotInstanceRequestsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeSpotInstanceRequestsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  spot_instance_request_ids: ["String"],
  next_token: "String",
  max_results: 1,
}

Contains the parameters for DescribeSpotInstanceRequests.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


15438
15439
15440
15441
15442
15443
15444
15445
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15438

class DescribeSpotInstanceRequestsRequest < Struct.new(
  :filters,
  :dry_run,
  :spot_instance_request_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filtersArray<Types::Filter>

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

Returns:



15438
15439
15440
15441
15442
15443
15444
15445
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15438

class DescribeSpotInstanceRequestsRequest < Struct.new(
  :filters,
  :dry_run,
  :spot_instance_request_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


15438
15439
15440
15441
15442
15443
15444
15445
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15438

class DescribeSpotInstanceRequestsRequest < Struct.new(
  :filters,
  :dry_run,
  :spot_instance_request_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


15438
15439
15440
15441
15442
15443
15444
15445
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15438

class DescribeSpotInstanceRequestsRequest < Struct.new(
  :filters,
  :dry_run,
  :spot_instance_request_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end

#spot_instance_request_idsArray<String>

One or more Spot Instance request IDs.

Returns:

  • (Array<String>)


15438
15439
15440
15441
15442
15443
15444
15445
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15438

class DescribeSpotInstanceRequestsRequest < Struct.new(
  :filters,
  :dry_run,
  :spot_instance_request_ids,
  :next_token,
  :max_results)
  include Aws::Structure
end