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

Class: Aws::EC2::Types::DescribeScheduledInstanceAvailabilityRequest

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

{
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  first_slot_start_time_range: { # required
    earliest_time: Time.now, # required
    latest_time: Time.now, # required
  },
  max_results: 1,
  max_slot_duration_in_hours: 1,
  min_slot_duration_in_hours: 1,
  next_token: "String",
  recurrence: { # required
    frequency: "String",
    interval: 1,
    occurrence_days: [1],
    occurrence_relative_to_end: false,
    occurrence_unit: "String",
  },
}

Contains the parameters for DescribeScheduledInstanceAvailability.

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)


10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more 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:



10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#first_slot_start_time_rangeTypes::SlotDateTimeRangeRequest

The time period for the first schedule to start.



10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  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 300. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#max_slot_duration_in_hoursInteger

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

Returns:

  • (Integer)


10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#min_slot_duration_in_hoursInteger

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

Returns:

  • (Integer)


10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end

#recurrenceTypes::ScheduledInstanceRecurrenceRequest

The schedule recurrence.



10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10551

class DescribeScheduledInstanceAvailabilityRequest < Struct.new(
  :dry_run,
  :filters,
  :first_slot_start_time_range,
  :max_results,
  :max_slot_duration_in_hours,
  :min_slot_duration_in_hours,
  :next_token,
  :recurrence)
  include Aws::Structure
end