Skip to content

DescribeScheduledInstancesRequest

Source code in docs_src/capo_ec2/types/describe_scheduled_instances_request.py
class DescribeScheduledInstancesRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>The filters.</p> <ul> <li> <p> <code>availability-zone</code> - The Availability Zone (for example, <code>us-west-2a</code>).</p> </li> <li> <p> <code>instance-type</code> - The instance type (for example, <code>c4.large</code>).</p> </li> <li> <p> <code>platform</code> - The platform (<code>Linux/UNIX</code> or <code>Windows</code>).</p> </li> </ul>"""
    max_results: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>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 <code>NextToken</code> value.</p>"""
    next_token: NotRequired["capo_ec2.types.string.String"]
    """<p>The token for the next set of results.</p>"""
    scheduled_instance_ids: NotRequired[
        "capo_ec2.types.scheduled_instance_id_request_set.ScheduledInstanceIdRequestSet"
    ]
    """<p>The Scheduled Instance IDs.</p>"""
    slot_start_time_range: NotRequired[
        "capo_ec2.types.slot_start_time_range_request.SlotStartTimeRangeRequest"
    ]
    """<p>The time period for the first schedule to start.</p>"""

dry_run instance-attribute

dry_run: NotRequired[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 instance-attribute

filters: NotRequired[FilterList]

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/UNIX or Windows).

max_results instance-attribute

max_results: NotRequired[Integer]

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.

next_token instance-attribute

next_token: NotRequired[String]

The token for the next set of results.

scheduled_instance_ids instance-attribute

scheduled_instance_ids: NotRequired[ScheduledInstanceIdRequestSet]

The Scheduled Instance IDs.

slot_start_time_range instance-attribute

slot_start_time_range: NotRequired[SlotStartTimeRangeRequest]

The time period for the first schedule to start.