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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeInstanceStatusRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #include_all_instances ⇒ Boolean

  When ‘true`, includes the health status for all instances.

• #instance_ids ⇒ Array<String>

  The instance IDs.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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

#filters ⇒ Array<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:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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

#include_all_instances ⇒ Boolean

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

Default: ‘false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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

#instance_ids ⇒ Array<String>

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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

#max_results ⇒ Integer

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

You cannot specify this parameter and the instance IDs parameter in the same request.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 19810

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