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

Class: Aws::SSM::Types::CancelCommandRequest

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

Overview

Note:

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

{
  command_id: "CommandId", # required
  instance_ids: ["InstanceId"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#command_idString

The ID of the command you want to cancel.

Returns:

  • (String)


715
716
717
718
719
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

class CancelCommandRequest < Struct.new(
  :command_id,
  :instance_ids)
  include Aws::Structure
end

#instance_idsArray<String>

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

Returns:

  • (Array<String>)


715
716
717
718
719
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

class CancelCommandRequest < Struct.new(
  :command_id,
  :instance_ids)
  include Aws::Structure
end