create_instance_event_window ¶

create_instance_event_window(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    name: Optional[String] = None,
    time_ranges: Optional[InstanceEventWindowTimeRangeRequestSet] = None,
    cron_expression: Optional[InstanceEventWindowCronExpression] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
) -> CreateInstanceEventWindowResult

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Parameters:

dry_run (Optional[Boolean], default: 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.
name (Optional[String], default: None ) –

The name of the event window.
time_ranges (Optional[InstanceEventWindowTimeRangeRequestSet], default: None ) –

The time range for the event window. If you specify a time range, you can't specify a cron expression.
cron_expression (Optional[InstanceEventWindowCronExpression], default: None ) –
The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:
- Only hour and day of the week values are supported.
- For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
- The minute, month, and year must be specified by *.
- The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
- Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
- The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
tag_specifications (Optional[TagSpecificationList], default: None ) –

The tags to apply to the event window.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/ec2.py

def create_instance_event_window(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    name: Optional["capo_ec2.types.string.String"] = None,
    time_ranges: Optional[
        "capo_ec2.types.instance_event_window_time_range_request_set.InstanceEventWindowTimeRangeRequestSet"
    ] = None,
    cron_expression: Optional[
        "capo_ec2.types.instance_event_window_cron_expression.InstanceEventWindowCronExpression"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
) -> "capo_ec2.types.create_instance_event_window_result.CreateInstanceEventWindowResult":
    """<p>Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.</p> <p>You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.</p> <p>You can create up to 200 event windows per Amazon Web Services Region.</p> <p>When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the <a>AssociateInstanceEventWindow</a> API.</p> <important> <p>Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.</p> <p>Event windows are <i>not</i> applicable for:</p> <ul> <li> <p>Expedited scheduled events and network maintenance events. </p> </li> <li> <p>Unscheduled maintenance such as AutoRecovery and unplanned reboots.</p> </li> </ul> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</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>
        name: <p>The name of the event window.</p>
        time_ranges: <p>The time range for the event window. If you specify a time range, you can't specify a cron expression.</p>
        cron_expression: <p>The cron expression for the event window, for example, <code>* 0-4,20-23 * * 1,5</code>. If you specify a cron expression, you can't specify a time range.</p> <p>Constraints:</p> <ul> <li> <p>Only hour and day of the week values are supported.</p> </li> <li> <p>For day of the week values, you can specify either integers <code>0</code> through <code>6</code>, or alternative single values <code>SUN</code> through <code>SAT</code>.</p> </li> <li> <p>The minute, month, and year must be specified by <code>*</code>.</p> </li> <li> <p>The hour value must be one or a multiple range, for example, <code>0-4</code> or <code>0-4,20-23</code>.</p> </li> <li> <p>Each hour range must be >= 2 hours, for example, <code>0-2</code> or <code>20-23</code>.</p> </li> <li> <p>The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.</p> </li> </ul> <p>For more information about cron expressions, see <a href="https://en.wikipedia.org/wiki/Cron">cron</a> on the <i>Wikipedia website</i>.</p>
        tag_specifications: <p>The tags to apply to the event window.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_instance_event_window_request.CreateInstanceEventWindowRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_instance_event_window_result.CreateInstanceEventWindowResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_instance_event_window

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateInstanceEventWindow")
    )
    input_: capo_ec2.types.create_instance_event_window_request.CreateInstanceEventWindowRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if name is not None:
        input_["name"] = name
    if time_ranges is not None:
        input_["time_ranges"] = time_ranges
    if cron_expression is not None:
        input_["cron_expression"] = cron_expression
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications

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