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

Class: Aws::EC2::Types::CancelConversionRequest

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

Overview

Note:

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

{
  conversion_task_id: "String", # required
  dry_run: false,
  reason_message: "String",
}

Contains the parameters for CancelConversionTask.

Instance Attribute Summary collapse

Instance Attribute Details

#conversion_task_idString

The ID of the conversion task.

Returns:

  • (String)


1692
1693
1694
1695
1696
1697
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1692

class CancelConversionRequest < Struct.new(
  :conversion_task_id,
  :dry_run,
  :reason_message)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


1692
1693
1694
1695
1696
1697
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1692

class CancelConversionRequest < Struct.new(
  :conversion_task_id,
  :dry_run,
  :reason_message)
  include Aws::Structure
end

#reason_messageString

The reason for canceling the conversion task.

Returns:

  • (String)


1692
1693
1694
1695
1696
1697
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1692

class CancelConversionRequest < Struct.new(
  :conversion_task_id,
  :dry_run,
  :reason_message)
  include Aws::Structure
end