Package org.jclouds.aws.ec2.features

Interface SpotInstanceApi

public interface SpotInstanceApi

Provides access to EC2 Spot Instances via their REST API.

Method Summary

Modifier and Type	Method	Description
void	cancelSpotInstanceRequestsInRegion(String region, String... requestIds)	Cancels one or more Spot Instance requests.
Set<SpotInstanceRequest>	describeSpotInstanceRequestsInRegion(String region, String... requestIds)	Describes Spot Instance requests.
Set<SpotInstanceRequest>	describeSpotInstanceRequestsInRegionWithFilter(String region, com.google.common.collect.Multimap<String,String> filter)	Describes Spot Instance requests.
Set<Spot>	describeSpotPriceHistoryInRegion(String region, DescribeSpotPriceHistoryOptions... options)	Describes Spot Price history.
SpotInstanceRequest	requestSpotInstanceInRegion(String region, float spotPrice, String imageId, String instanceType)	request a single spot instance
Set<SpotInstanceRequest>	requestSpotInstancesInRegion(String region, float spotPrice, int instanceCount, LaunchSpecification launchSpec, RequestSpotInstancesOptions... options)	Creates a Spot Instance request.

Method Details

describeSpotInstanceRequestsInRegion

@Named("DescribeSpotInstanceRequests")
@POST
@Path("/")
Set<SpotInstanceRequest> describeSpotInstanceRequestsInRegion(@Nullable
 String region,
 String... requestIds)

Describes Spot Instance requests. 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 conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Parameters:

region - Region where the spot instance service is running

requestIds - Specifies the ID of the Spot Instance request.

Returns:

TODO

See Also:

• requestSpotInstancesInRegion(java.lang.String, float, int, org.jclouds.aws.ec2.domain.LaunchSpecification, org.jclouds.aws.ec2.options.RequestSpotInstancesOptions...)
• cancelSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• describeSpotPriceHistoryInRegion(java.lang.String, org.jclouds.aws.ec2.options.DescribeSpotPriceHistoryOptions...)

describeSpotInstanceRequestsInRegionWithFilter

@Named("DescribeSpotInstanceRequests")
@POST
@Path("/")
Set<SpotInstanceRequest> describeSpotInstanceRequestsInRegionWithFilter(@Nullable
 String region,
 com.google.common.collect.Multimap<String,String> filter)

Describes Spot Instance requests. 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 conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Parameters:

region - Region where the spot instance service is running

filter - Mulitmap of filter key/values.

Returns:

TODO

See Also:

• requestSpotInstancesInRegion(java.lang.String, float, int, org.jclouds.aws.ec2.domain.LaunchSpecification, org.jclouds.aws.ec2.options.RequestSpotInstancesOptions...)
• cancelSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• describeSpotPriceHistoryInRegion(java.lang.String, org.jclouds.aws.ec2.options.DescribeSpotPriceHistoryOptions...)

requestSpotInstanceInRegion

@Named("RequestSpotInstances")
@POST
@Path("/")
SpotInstanceRequest requestSpotInstanceInRegion(@Nullable
 String region,
 @FormParam("SpotPrice")
 float spotPrice,
 @FormParam("LaunchSpecification.ImageId")
 String imageId,
 @FormParam("LaunchSpecification.InstanceType")
 String instanceType)

request a single spot instance

Parameters:

region - Region where the spot instance service is running

spotPrice - Specifies the maximum hourly price for any Spot Instance launched to fulfill the request.

imageId - The AMI ID.

instanceType - The instance type (ex. m1.small)

Returns:

spot instance request

See Also:

• requestSpotInstancesInRegion(java.lang.String, float, int, org.jclouds.aws.ec2.domain.LaunchSpecification, org.jclouds.aws.ec2.options.RequestSpotInstancesOptions...)

requestSpotInstancesInRegion

@Named("RequestSpotInstances")
@POST
@Path("/")
Set<SpotInstanceRequest> requestSpotInstancesInRegion(@Nullable
 String region,
 @FormParam("SpotPrice")
 float spotPrice,
 @FormParam("InstanceCount")
 int instanceCount,
 LaunchSpecification launchSpec,
 RequestSpotInstancesOptions... options)

Creates a Spot Instance request. 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 conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Parameters:

region - Region where the spot instance service is running

spotPrice - Specifies the maximum hourly price for any Spot Instance launched to fulfill the request.

instanceCount - number of instances to request

launchSpec - includes at least The AMI ID and instance type (ex. m1.small)

options - options including expiration time or grouping

Returns:

set of spot instance requests

See Also:

• describeSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• cancelSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• describeSpotPriceHistoryInRegion(java.lang.String, org.jclouds.aws.ec2.options.DescribeSpotPriceHistoryOptions...)

describeSpotPriceHistoryInRegion

@Named("DescribeSpotPriceHistory")
@POST
@Path("/")
Set<Spot> describeSpotPriceHistoryInRegion(@Nullable
 String region,
 DescribeSpotPriceHistoryOptions... options)

Describes Spot Price history. 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 conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Parameters:

region - Region where the spot instance service is running

options - options to control the describeVpcsInRegion

Returns:

TODO

See Also:

• describeSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• requestSpotInstancesInRegion(java.lang.String, float, int, org.jclouds.aws.ec2.domain.LaunchSpecification, org.jclouds.aws.ec2.options.RequestSpotInstancesOptions...)
• cancelSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)

cancelSpotInstanceRequestsInRegion

@Named("CancelSpotInstanceRequests")
@POST
@Path("/")
void cancelSpotInstanceRequestsInRegion(@Nullable
 String region,
 String... requestIds)

Cancels one or more Spot Instance requests. 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 conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Parameters:

region - Region where the spot instance service is running

requestIds - Specifies the ID of the Spot Instance request.

See Also:

• describeSpotInstanceRequestsInRegion(java.lang.String, java.lang.String...)
• requestSpotInstancesInRegion(java.lang.String, float, int, org.jclouds.aws.ec2.domain.LaunchSpecification, org.jclouds.aws.ec2.options.RequestSpotInstancesOptions...)
• describeSpotPriceHistoryInRegion(java.lang.String, org.jclouds.aws.ec2.options.DescribeSpotPriceHistoryOptions...)