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

Class: Aws::EC2::Types::DescribeScheduledInstancesRequest

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

{
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  scheduled_instance_ids: ["String"],
  slot_start_time_range: {
    earliest_time: Time.now,
    latest_time: Time.now,
  },
}

Contains the parameters for DescribeScheduledInstances.

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)


15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

Returns:



15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#scheduled_instance_idsArray<String>

The Scheduled Instance IDs.

Returns:

  • (Array<String>)


15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#slot_start_time_rangeTypes::SlotStartTimeRangeRequest

The time period for the first schedule to start.



15257
15258
15259
15260
15261
15262
15263
15264
15265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15257

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end