AWS SDK Version 3 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.

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CancelCommandAsync.

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

Syntax

C#
public abstract CancelCommandResponse CancelCommand(
         String commandId,
         List<String> instanceIds
)

Parameters

commandId
Type: System.String

The ID of the command you want to cancel.

instanceIds
Type: System.Collections.Generic.List<System.String>

(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.

Return Value


The response from the CancelCommand service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
InternalServerErrorException An error occurred on the server side.
InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
InvalidInstanceIdException The following problems can cause this exception: You don't have permission to access the managed node. Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running. SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also