EC2 / Client / modify_instance_event_start_time

modify_instance_event_start_time#

EC2.Client.modify_instance_event_start_time(**kwargs)#

Modifies the start time for a scheduled Amazon EC2 instance event.

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_event_start_time(
    DryRun=True|False,
    InstanceId='string',
    InstanceEventId='string',
    NotBefore=datetime(2015, 1, 1)
)
Parameters:
  • DryRun (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.

  • InstanceId (string) –

    [REQUIRED]

    The ID of the instance with the scheduled event.

  • InstanceEventId (string) –

    [REQUIRED]

    The ID of the event whose date and time you are modifying.

  • NotBefore (datetime) –

    [REQUIRED]

    The new date and time when the event will take place.

Return type:

dict

Returns:

Response Syntax

{
    'Event': {
        'InstanceEventId': 'string',
        'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
        'Description': 'string',
        'NotAfter': datetime(2015, 1, 1),
        'NotBefore': datetime(2015, 1, 1),
        'NotBeforeDeadline': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Event (dict) –

      Information about the event.

      • InstanceEventId (string) –

        The ID of the event.

      • Code (string) –

        The event code.

      • Description (string) –

        A description of the event.

        After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

      • NotAfter (datetime) –

        The latest scheduled end time for the event.

      • NotBefore (datetime) –

        The earliest scheduled start time for the event.

      • NotBeforeDeadline (datetime) –

        The deadline for starting the event.