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: "InstanceId", # required
  wake_up: false,
}

Constant Summary collapse

SENSITIVE =
[]

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)


34761
34762
34763
34764
34765
34766
34767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34761

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

#instance_idString

The ID of the instance.

Returns:

  • (String)


34761
34762
34763
34764
34765
34766
34767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34761

class GetConsoleScreenshotRequest < Struct.new(
  :dry_run,
  :instance_id,
  :wake_up)
  SENSITIVE = []
  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)


34761
34762
34763
34764
34765
34766
34767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34761

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