You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeScheduledInstanceAvailabilityRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeScheduledInstanceAvailabilityRequest
- Defined in:
- (unknown)
Overview
When passing DescribeScheduledInstanceAvailabilityRequest as input to an Aws::Client method, you can use a vanilla 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
-
#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.
-
#first_slot_start_time_range ⇒ Types::SlotDateTimeRangeRequest
The time period for the first schedule to start.
-
#max_results ⇒ Integer
The maximum number of results to return in a single call.
-
#max_slot_duration_in_hours ⇒ Integer
The maximum available duration, in hours.
-
#min_slot_duration_in_hours ⇒ Integer
The minimum available duration, in hours.
-
#next_token ⇒ String
The token for the next set of results.
-
#recurrence ⇒ Types::ScheduledInstanceRecurrenceRequest
The schedule recurrence.
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
.
#filters ⇒ Array<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
orEC2-VPC
).platform
- The platform (Linux/UNIX
orWindows
).
#first_slot_start_time_range ⇒ Types::SlotDateTimeRangeRequest
The time period for the first schedule to start.
#max_results ⇒ Integer
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.
#max_slot_duration_in_hours ⇒ Integer
The maximum available duration, in hours. This value must be greater
than MinSlotDurationInHours
and less than 1,720.
#min_slot_duration_in_hours ⇒ Integer
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.
#next_token ⇒ String
The token for the next set of results.
#recurrence ⇒ Types::ScheduledInstanceRecurrenceRequest
The schedule recurrence.