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

Class: Aws::EC2::Types::GetConsoleOutputRequest

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

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

Contains the parameters for GetConsoleOutput.

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)


15915
15916
15917
15918
15919
15920
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15915

class GetConsoleOutputRequest < Struct.new(
  :instance_id,
  :dry_run,
  :latest)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


15915
15916
15917
15918
15919
15920
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15915

class GetConsoleOutputRequest < Struct.new(
  :instance_id,
  :dry_run,
  :latest)
  include Aws::Structure
end

#latestBoolean

When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

Returns:

  • (Boolean)


15915
15916
15917
15918
15919
15920
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15915

class GetConsoleOutputRequest < Struct.new(
  :instance_id,
  :dry_run,
  :latest)
  include Aws::Structure
end