1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
|
"""EventBridgeSchedulerBackend class with methods for supported APIs."""
import datetime
from collections.abc import Iterable
from typing import Any, Optional, cast
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.common_models import BaseModel
from moto.core.utils import unix_time, utcfromtimestamp, utcnow
from moto.utilities.tagging_service import TaggingService
from moto.utilities.utils import get_partition
from .exceptions import (
ScheduleExists,
ScheduleGroupNotFound,
ScheduleNotFound,
ValidationException,
)
class Schedule(BaseModel):
def __init__(
self,
region: str,
account_id: str,
group_name: str,
name: str,
description: Optional[str],
schedule_expression: str,
schedule_expression_timezone: Optional[str],
flexible_time_window: dict[str, Any],
target: dict[str, Any],
state: Optional[str],
kms_key_arn: Optional[str],
start_date: Optional[str],
end_date: Optional[str],
action_after_completion: Optional[str],
):
self.name = name
self.group_name = group_name
self.description = description
self.arn = f"arn:{get_partition(region)}:scheduler:{region}:{account_id}:schedule/{group_name}/{name}"
self.schedule_expression = schedule_expression
self.schedule_expression_timezone = schedule_expression_timezone or "UTC"
self.flexible_time_window = flexible_time_window
self.target = Schedule.validate_target(target)
self.state = state or "ENABLED"
self.kms_key_arn = kms_key_arn
self.start_date = self._validate_start_date(start_date)
self.end_date = end_date
self.action_after_completion = action_after_completion
self.creation_date = self.last_modified_date = unix_time()
@staticmethod
def validate_target(target: dict[str, Any]) -> dict[str, Any]: # type: ignore[misc]
if "RetryPolicy" not in target:
target["RetryPolicy"] = {
"MaximumEventAgeInSeconds": 86400,
"MaximumRetryAttempts": 185,
}
return target
def _validate_start_date(self, start_date: Optional[str]) -> Optional[str]:
# `.count("*")` means a recurrence expression
# https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/scheduler/client/create_schedule.html (StartDate parameter)
if self.schedule_expression.count("*") and start_date is not None:
start_date_as_dt = utcfromtimestamp(cast(int, start_date))
now = utcnow()
if start_date_as_dt < now:
diff = now - start_date_as_dt
rule = datetime.timedelta(minutes=5)
within_rule = diff <= rule
if not within_rule:
raise ValidationException(
message="The StartDate you specify cannot be earlier than 5 minutes ago."
)
return start_date
def to_dict(self, short: bool = False) -> dict[str, Any]:
dct: dict[str, Any] = {
"Arn": self.arn,
"Name": self.name,
"GroupName": self.group_name,
"Description": self.description,
"ScheduleExpression": self.schedule_expression,
"ScheduleExpressionTimezone": self.schedule_expression_timezone,
"FlexibleTimeWindow": self.flexible_time_window,
"Target": self.target,
"ActionAfterCompletion": self.action_after_completion,
"State": self.state,
"KmsKeyArn": self.kms_key_arn,
"StartDate": self.start_date,
"EndDate": self.end_date,
"CreationDate": self.creation_date,
"LastModificationDate": self.last_modified_date,
}
if short:
dct["Target"] = {"Arn": dct["Target"]["Arn"]}
return dct
def update(
self,
description: str,
end_date: str,
flexible_time_window: dict[str, Any],
kms_key_arn: str,
schedule_expression: str,
schedule_expression_timezone: str,
start_date: str,
state: str,
target: dict[str, Any],
) -> None:
self.schedule_expression = schedule_expression
self.schedule_expression_timezone = schedule_expression_timezone or "UTC"
self.flexible_time_window = flexible_time_window
self.target = Schedule.validate_target(target)
self.description = description
self.state = state
self.kms_key_arn = kms_key_arn
self.start_date = start_date
self.end_date = end_date
self.last_modified_date = unix_time()
class ScheduleGroup(BaseModel):
def __init__(self, region: str, account_id: str, name: str):
self.name = name
self.arn = f"arn:{get_partition(region)}:scheduler:{region}:{account_id}:schedule-group/{name}"
self.schedules: dict[str, Schedule] = {}
self.created_on = None if self.name == "default" else unix_time()
self.last_modified = None if self.name == "default" else unix_time()
def add_schedule(self, schedule: Schedule) -> None:
self.schedules[schedule.name] = schedule
def get_schedule(self, name: str) -> Schedule:
if name not in self.schedules:
raise ScheduleNotFound(name)
return self.schedules[name]
def delete_schedule(self, name: str) -> None:
if name not in self.schedules:
raise ScheduleNotFound(name)
self.schedules.pop(name)
def to_dict(self) -> dict[str, Any]:
return {
"Arn": self.arn,
"CreationDate": self.created_on,
"LastModificationDate": self.last_modified,
"Name": self.name,
"State": "ACTIVE",
}
class EventBridgeSchedulerBackend(BaseBackend):
"""Implementation of EventBridgeScheduler APIs."""
def __init__(self, region_name: str, account_id: str):
super().__init__(region_name, account_id)
self.schedules: list[Schedule] = []
self.schedule_groups = {
"default": ScheduleGroup(
region=region_name, account_id=account_id, name="default"
)
}
self.tagger = TaggingService()
def create_schedule(
self,
description: str,
end_date: str,
flexible_time_window: dict[str, Any],
group_name: str,
kms_key_arn: str,
name: str,
schedule_expression: str,
schedule_expression_timezone: str,
start_date: str,
state: str,
target: dict[str, Any],
action_after_completion: Optional[str],
) -> Schedule:
"""
The ClientToken parameter is not yet implemented
"""
group = self.schedule_groups[group_name or "default"]
if name in group.schedules:
raise ScheduleExists(name)
schedule = Schedule(
region=self.region_name,
account_id=self.account_id,
group_name=group.name,
name=name,
description=description,
schedule_expression=schedule_expression,
schedule_expression_timezone=schedule_expression_timezone,
flexible_time_window=flexible_time_window,
target=target,
state=state,
kms_key_arn=kms_key_arn,
start_date=start_date,
end_date=end_date,
action_after_completion=action_after_completion,
)
group.add_schedule(schedule)
return schedule
def get_schedule(self, group_name: Optional[str], name: str) -> Schedule:
group = self.get_schedule_group(group_name)
return group.get_schedule(name)
def delete_schedule(self, group_name: Optional[str], name: str) -> None:
group = self.get_schedule_group(group_name)
group.delete_schedule(name)
def update_schedule(
self,
description: str,
end_date: str,
flexible_time_window: dict[str, Any],
group_name: str,
kms_key_arn: str,
name: str,
schedule_expression: str,
schedule_expression_timezone: str,
start_date: str,
state: str,
target: dict[str, Any],
) -> Schedule:
"""
The ClientToken is not yet implemented
"""
schedule = self.get_schedule(group_name=group_name, name=name)
schedule.update(
description=description,
end_date=end_date,
flexible_time_window=flexible_time_window,
kms_key_arn=kms_key_arn,
schedule_expression=schedule_expression,
schedule_expression_timezone=schedule_expression_timezone,
start_date=start_date,
state=state,
target=target,
)
return schedule
def list_schedules(
self, group_names: Optional[str], state: Optional[str]
) -> Iterable[Schedule]:
"""
The following parameters are not yet implemented: MaxResults, NamePrefix, NextToken
"""
results = []
for group in self.schedule_groups.values():
if not group_names or group.name in group_names:
for schedule in group.schedules.values():
if not state or schedule.state == state:
results.append(schedule)
return results
def create_schedule_group(
self, name: str, tags: list[dict[str, str]]
) -> ScheduleGroup:
"""
The ClientToken parameter is not yet implemented
"""
group = ScheduleGroup(
region=self.region_name, account_id=self.account_id, name=name
)
self.schedule_groups[name] = group
self.tagger.tag_resource(group.arn, tags)
return group
def get_schedule_group(self, group_name: Optional[str]) -> ScheduleGroup:
if (group_name or "default") not in self.schedule_groups:
raise ScheduleGroupNotFound(group_name or "default")
return self.schedule_groups[group_name or "default"]
def list_schedule_groups(self) -> Iterable[ScheduleGroup]:
"""
The MaxResults-parameter and pagination options are not yet implemented
"""
return self.schedule_groups.values()
def delete_schedule_group(self, name: Optional[str]) -> None:
self.schedule_groups.pop(name or "default")
def list_tags_for_resource(
self, resource_arn: str
) -> dict[str, list[dict[str, str]]]:
return self.tagger.list_tags_for_resource(resource_arn)
def tag_resource(self, resource_arn: str, tags: list[dict[str, str]]) -> None:
self.tagger.tag_resource(resource_arn, tags)
def untag_resource(self, resource_arn: str, tag_keys: list[str]) -> None:
self.tagger.untag_resource_using_names(resource_arn, tag_keys)
scheduler_backends = BackendDict(EventBridgeSchedulerBackend, "scheduler")
|