describe_scheduled_instances ¶

def describe_scheduled_instances(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    scheduled_instance_ids: Optional[
        "capo_ec2.types.scheduled_instance_id_request_set.ScheduledInstanceIdRequestSet"
    ] = None,
    slot_start_time_range: Optional[
        "capo_ec2.types.slot_start_time_range_request.SlotStartTimeRangeRequest"
    ] = None,
) -> "capo_ec2.types.describe_scheduled_instances_result.DescribeScheduledInstancesResult":
    """<p>Describes the specified Scheduled Instances or all your Scheduled Instances.</p>

    Args:
        dry_run: <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: <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: <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: <p>The token for the next set of results.</p>
        scheduled_instance_ids: <p>The Scheduled Instance IDs.</p>
        slot_start_time_range: <p>The time period for the first schedule to start.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_scheduled_instances_request.DescribeScheduledInstancesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_scheduled_instances_result.DescribeScheduledInstancesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_scheduled_instances

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_scheduled_instances.describe_scheduled_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeScheduledInstances")
    )
    input_: capo_ec2.types.describe_scheduled_instances_request.DescribeScheduledInstancesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if scheduled_instance_ids is not None:
        input_["scheduled_instance_ids"] = scheduled_instance_ids
    if slot_start_time_range is not None:
        input_["slot_start_time_range"] = slot_start_time_range

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output