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

Class: Aws::EC2::Types::GetConsoleScreenshotRequest

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 GetConsoleScreenshotRequest data as a hash:

{
  dry_run: false,
  instance_id: "String", # required
  wake_up: false,
}

Contains the parameters for the request.

Instance Attribute Summary collapse

Instance Attribute Details

#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)


13239
13240
13241
13242
13243
13244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13239

class GetConsoleScreenshotRequest < Struct.new(
  :dry_run,
  :instance_id,
  :wake_up)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


13239
13240
13241
13242
13243
13244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13239

class GetConsoleScreenshotRequest < Struct.new(
  :dry_run,
  :instance_id,
  :wake_up)
  include Aws::Structure
end

#wake_upBoolean

When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

Returns:

  • (Boolean)


13239
13240
13241
13242
13243
13244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13239

class GetConsoleScreenshotRequest < Struct.new(
  :dry_run,
  :instance_id,
  :wake_up)
  include Aws::Structure
end