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

Class: Aws::EC2::Types::DescribeInstanceStatusRequest

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

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_ids: ["String"],
  max_results: 1,
  next_token: "String",
  dry_run: false,
  include_all_instances: false,
}

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)


12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Returns:



12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end

#include_all_instancesBoolean

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Returns:

  • (Boolean)


12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end

#instance_idsArray<String>

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

  • (Array<String>)


12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Returns:

  • (Integer)


12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


12741
12742
12743
12744
12745
12746
12747
12748
12749
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12741

class DescribeInstanceStatusRequest < Struct.new(
  :filters,
  :instance_ids,
  :max_results,
  :next_token,
  :dry_run,
  :include_all_instances)
  include Aws::Structure
end