describe_scheduled_instance_availability¶
Operation¶
async
¶
describe_scheduled_instance_availability(input: DescribeScheduledInstanceAvailabilityInput, plugins: list[Plugin] | None = None) -> DescribeScheduledInstanceAvailabilityOutput
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 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.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeScheduledInstanceAvailabilityInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeScheduledInstanceAvailabilityOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeScheduledInstanceAvailability.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
The filters.
-
availability-zone- The Availability Zone (for example,us-west-2a). -
instance-type- The instance type (for example,c4.large). -
platform- The platform (Linux/UNIXorWindows).
class-attribute
instance-attribute
¶
The time period for the first schedule to start.
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
class-attribute
instance-attribute
¶
max_slot_duration_in_hours: int | None = ...
The maximum available duration, in hours. This value must be greater
than MinSlotDurationInHours and less than 1,720.
class-attribute
instance-attribute
¶
min_slot_duration_in_hours: int | None = ...
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.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token for the next set of results.
class-attribute
instance-attribute
¶
The schedule recurrence.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeScheduledInstanceAvailability.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token required to retrieve the next set of results. This value is
null when there are no more results to return.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.