AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CancelSpotInstanceRequests operation. Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CancelSpotInstanceRequestsRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class CancelSpotInstanceRequestsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CancelSpotInstanceRequestsRequest type exposes the following members

Constructors

NameDescription
Public Method CancelSpotInstanceRequestsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CancelSpotInstanceRequestsRequest(List<String>)

Instantiates CancelSpotInstanceRequestsRequest with the parameterized properties

Properties

NameTypeDescription
Public Property DryRun System.Nullable<System.Boolean>

Gets and sets the property DryRun.

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.

Public Property SpotInstanceRequestIds System.Collections.Generic.List<System.String>

Gets and sets the property SpotInstanceRequestIds.

The IDs of the Spot Instance requests.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Examples

This example cancels a Spot Instance request.

To cancel Spot Instance requests


var client = new AmazonEC2Client();
var response = client.CancelSpotInstanceRequests(new CancelSpotInstanceRequestsRequest 
{
    SpotInstanceRequestIds = new List<string> {
        "sir-08b93456"
    }
});

List<CancelledSpotInstanceRequest> cancelledSpotInstanceRequests = response.CancelledSpotInstanceRequests;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer