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 CancelSpotFleetRequests operation. Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

Restrictions

Inheritance Hierarchy

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

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

Syntax

C#
public class CancelSpotFleetRequestsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CancelSpotFleetRequestsRequest type exposes the following members

Constructors

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 SpotFleetRequestIds System.Collections.Generic.List<System.String>

Gets and sets the property SpotFleetRequestIds.

The IDs of the Spot Fleet requests.

Constraint: You can specify up to 100 IDs in a single request.

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.

Public Property TerminateInstances System.Nullable<System.Boolean>

Gets and sets the property TerminateInstances.

Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.

To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.

Examples

This example cancels the specified Spot fleet request and terminates its associated Spot Instances.

To cancel a Spot fleet request


var client = new AmazonEC2Client();
var response = client.CancelSpotFleetRequests(new CancelSpotFleetRequestsRequest 
{
    SpotFleetRequestIds = new List<string> {
        "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
    },
    TerminateInstances = true
});

List<CancelSpotFleetRequestsSuccessItem> successfulFleetRequests = response.SuccessfulFleetRequests;

            

This example cancels the specified Spot fleet request without terminating its associated Spot Instances.

To cancel a Spot fleet request without terminating its Spot Instances


var client = new AmazonEC2Client();
var response = client.CancelSpotFleetRequests(new CancelSpotFleetRequestsRequest 
{
    SpotFleetRequestIds = new List<string> {
        "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
    },
    TerminateInstances = false
});

List<CancelSpotFleetRequestsSuccessItem> successfulFleetRequests = response.SuccessfulFleetRequests;

            

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