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

Class: Aws::EC2::Types::ReportInstanceStatusRequest

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

{
  description: "String",
  dry_run: false,
  end_time: Time.now,
  instances: ["String"], # required
  reason_codes: ["instance-stuck-in-state"], # required, accepts instance-stuck-in-state, unresponsive, not-accepting-credentials, password-not-available, performance-network, performance-instance-store, performance-ebs-volume, performance-other, other
  start_time: Time.now,
  status: "ok", # required, accepts ok, impaired
}

Contains the parameters for ReportInstanceStatus.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Descriptive text about the health state of your instance.

Returns:

  • (String)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  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)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end

#end_timeTime

The time at which the reported instance health state ended.

Returns:

  • (Time)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end

#instancesArray<String>

One or more instances.

Returns:

  • (Array<String>)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end

#reason_codesArray<String>

One or more reason codes that describe the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems that I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

Returns:

  • (Array<String>)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end

#start_timeTime

The time at which the reported instance health state began.

Returns:

  • (Time)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end

#statusString

The status of all instances listed.

Returns:

  • (String)


23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23020

class ReportInstanceStatusRequest < Struct.new(
  :description,
  :dry_run,
  :end_time,
  :instances,
  :reason_codes,
  :start_time,
  :status)
  include Aws::Structure
end