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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
|
import re
from collections.abc import Iterable
from datetime import datetime, timedelta
from gzip import compress as gzip_compress
from typing import Any, Optional
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.common_models import BaseModel, CloudFormationModel
from moto.core.utils import unix_time_millis, utcnow
from moto.logs.exceptions import (
ConflictException,
InvalidParameterException,
LimitExceededException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
ValidationException,
)
from moto.logs.logs_query import execute_query
from moto.logs.metric_filters import MetricFilters
from moto.moto_api._internal import mock_random
from moto.s3.models import MissingBucket, s3_backends
from moto.utilities.paginator import paginate
from moto.utilities.tagging_service import TaggingService
from moto.utilities.utils import get_partition
from .utils import PAGINATION_MODEL, EventMessageFilter
MAX_RESOURCE_POLICIES_PER_REGION = 10
class Destination(BaseModel):
def __init__(
self,
account_id: str,
region: str,
destination_name: str,
role_arn: str,
target_arn: str,
access_policy: Optional[str] = None,
):
self.access_policy = access_policy
self.arn = f"arn:{get_partition(region)}:logs:{region}:{account_id}:destination:{destination_name}"
self.creation_time = int(unix_time_millis())
self.destination_name = destination_name
self.role_arn = role_arn
self.target_arn = target_arn
def to_dict(self) -> dict[str, Any]:
return {
"accessPolicy": self.access_policy,
"arn": self.arn,
"creationTime": self.creation_time,
"destinationName": self.destination_name,
"roleArn": self.role_arn,
"targetArn": self.target_arn,
}
class LogQuery(BaseModel):
def __init__(
self,
query_id: str,
start_time: int,
end_time: int,
query: str,
log_groups: list["LogGroup"],
):
self.query_id = query_id
self.start_time = start_time
self.end_time = end_time
self.query = query
self.log_group_names = [lg.name for lg in log_groups]
self.create_time = unix_time_millis()
self.status = "Running"
self.results = execute_query(
log_groups=log_groups, query=query, start_time=start_time, end_time=end_time
)
self.status = "Complete"
def to_json(self, log_group_name: str) -> dict[str, Any]:
return {
"queryId": self.query_id,
"queryString": self.query,
"status": self.status,
"createTime": self.create_time,
"logGroupName": log_group_name,
}
def to_result_json(self) -> dict[str, Any]:
return {
"results": [
[{"field": key, "value": str(val)} for key, val in result.items()]
for result in self.results
],
"status": self.status,
}
class LogEvent(BaseModel):
_event_id = 0
def __init__(self, ingestion_time: int, log_event: dict[str, Any]):
self.ingestion_time = ingestion_time
self.timestamp = log_event["timestamp"]
self.message = log_event["message"]
self.event_id = self.__class__._event_id
self.__class__._event_id += 1
""
def to_filter_dict(self) -> dict[str, Any]:
return {
"eventId": str(self.event_id),
"ingestionTime": self.ingestion_time,
# "logStreamName":
"message": self.message,
"timestamp": self.timestamp,
}
def to_response_dict(self) -> dict[str, Any]:
return {
"ingestionTime": self.ingestion_time,
"message": self.message,
"timestamp": self.timestamp,
}
class LogStream(BaseModel):
_log_ids = 0
def __init__(self, log_group: "LogGroup", name: str):
self.account_id = log_group.account_id
self.region = log_group.region
self.log_group = log_group
self.arn = f"arn:{get_partition(self.region)}:logs:{self.region}:{self.account_id}:log-group:{log_group.name}:log-stream:{name}"
self.creation_time = int(unix_time_millis())
self.first_event_timestamp = None
self.last_event_timestamp = None
self.last_ingestion_time: Optional[int] = None
self.log_stream_name = name
self.stored_bytes = 0
# I'm guessing this is token needed for sequenceToken by put_events
self.upload_sequence_token = 0
self.events: list[LogEvent] = []
self.__class__._log_ids += 1
def _update(self) -> None:
# events can be empty when stream is described soon after creation
self.first_event_timestamp = (
min([x.timestamp for x in self.events]) if self.events else None
)
self.last_event_timestamp = (
max([x.timestamp for x in self.events]) if self.events else None
)
def to_describe_dict(self) -> dict[str, Any]:
# Compute start and end times
self._update()
res = {
"arn": self.arn,
"creationTime": self.creation_time,
"logStreamName": self.log_stream_name,
"storedBytes": self.stored_bytes,
}
if self.events:
rest = {
"firstEventTimestamp": self.first_event_timestamp,
"lastEventTimestamp": self.last_event_timestamp,
"lastIngestionTime": self.last_ingestion_time,
"uploadSequenceToken": str(self.upload_sequence_token),
}
res.update(rest)
return res
def put_log_events(self, log_events: list[dict[str, Any]]) -> str:
# TODO: ensure sequence_token
# TODO: to be thread safe this would need a lock
self.last_ingestion_time = int(unix_time_millis())
# TODO: make this match AWS if possible
self.stored_bytes += sum(
[len(log_event["message"]) for log_event in log_events]
)
events = [
LogEvent(self.last_ingestion_time, log_event) for log_event in log_events
]
self.events += events
self.upload_sequence_token += 1
for subscription_filter in self.log_group.subscription_filters.values():
service = subscription_filter.destination_arn.split(":")[2]
formatted_log_events = [
{
"id": event.event_id,
"timestamp": event.timestamp,
"message": event.message,
}
for event in events
]
self._send_log_events(
service=service,
destination_arn=subscription_filter.destination_arn,
filter_name=subscription_filter.name,
log_events=formatted_log_events,
)
return f"{self.upload_sequence_token:056d}"
def _send_log_events(
self,
service: str,
destination_arn: str,
filter_name: str,
log_events: list[dict[str, Any]],
) -> None:
if service == "lambda":
from moto.awslambda.utils import get_backend
get_backend(self.account_id, self.region).send_log_event(
destination_arn,
filter_name,
self.log_group.name,
self.log_stream_name,
log_events,
)
elif service == "firehose":
from moto.firehose import firehose_backends
firehose_backends[self.account_id][self.region].send_log_event(
destination_arn,
filter_name,
self.log_group.name,
self.log_stream_name,
log_events,
)
elif service == "kinesis":
from moto.kinesis import kinesis_backends
kinesis = kinesis_backends[self.account_id][self.region]
kinesis.send_log_event(
destination_arn,
filter_name,
self.log_group.name,
self.log_stream_name,
log_events,
)
def get_log_events(
self,
start_time: str,
end_time: str,
limit: int,
next_token: Optional[str],
start_from_head: str,
) -> tuple[list[dict[str, Any]], Optional[str], Optional[str]]:
if limit is None:
limit = 10000
def filter_func(event: LogEvent) -> bool:
if start_time and event.timestamp < start_time:
return False
if end_time and event.timestamp > end_time:
return False
return True
def get_index_and_direction_from_token(
token: Optional[str],
) -> tuple[Optional[str], int]:
if token is not None:
try:
return token[0], int(token[2:])
except Exception:
raise InvalidParameterException(
"The specified nextToken is invalid."
)
return None, 0
events = sorted(
filter(filter_func, self.events), key=lambda event: event.timestamp
)
direction, index = get_index_and_direction_from_token(next_token)
limit_index = limit - 1
final_index = len(events) - 1
if direction is None:
if start_from_head:
start_index = 0
end_index = start_index + limit_index
else:
end_index = final_index
start_index = end_index - limit_index
elif direction == "f":
start_index = index + 1
end_index = start_index + limit_index
elif direction == "b":
end_index = index - 1
start_index = end_index - limit_index
else:
raise InvalidParameterException("The specified nextToken is invalid.")
if start_index < 0:
start_index = 0
elif start_index > final_index:
return ([], f"b/{final_index:056d}", f"f/{final_index:056d}")
if end_index > final_index:
end_index = final_index
elif end_index < 0:
return ([], f"b/{0:056d}", f"f/{0:056d}")
events_page = [
event.to_response_dict() for event in events[start_index : end_index + 1]
]
return (events_page, f"b/{start_index:056d}", f"f/{end_index:056d}")
def filter_log_events(
self, start_time: int, end_time: int, filter_pattern: str
) -> list[dict[str, Any]]:
def filter_func(event: LogEvent) -> bool:
if start_time and event.timestamp < start_time:
return False
if end_time and event.timestamp > end_time:
return False
if not EventMessageFilter(filter_pattern).matches(event.message):
return False
return True
events: list[dict[str, Any]] = []
for event in sorted(
filter(filter_func, self.events), key=lambda x: x.timestamp
):
event_obj = event.to_filter_dict()
event_obj["logStreamName"] = self.log_stream_name
events.append(event_obj)
return events
class SubscriptionFilter(BaseModel):
def __init__(
self,
name: str,
log_group_name: str,
filter_pattern: str,
destination_arn: str,
role_arn: str,
):
self.name = name
self.log_group_name = log_group_name
self.filter_pattern = filter_pattern
self.destination_arn = destination_arn
self.role_arn = role_arn
self.creation_time = int(unix_time_millis())
def update(self, filter_pattern: str, destination_arn: str, role_arn: str) -> None:
self.filter_pattern = filter_pattern
self.destination_arn = destination_arn
self.role_arn = role_arn
def to_json(self) -> dict[str, Any]:
return {
"filterName": self.name,
"logGroupName": self.log_group_name,
"filterPattern": self.filter_pattern,
"destinationArn": self.destination_arn,
"roleArn": self.role_arn,
"distribution": "ByLogStream",
"creationTime": self.creation_time,
}
class LogGroup(CloudFormationModel):
def __init__(
self,
account_id: str,
region: str,
name: str,
**kwargs: Any,
):
self.name = name
self.account_id = account_id
self.region = region
self.arn = (
f"arn:{get_partition(region)}:logs:{region}:{account_id}:log-group:{name}"
)
self.creation_time = int(unix_time_millis())
self.streams: dict[str, LogStream] = {} # {name: LogStream}
# AWS defaults to Never Expire for log group retention
self.retention_in_days = kwargs.get("RetentionInDays")
self.subscription_filters: dict[str, SubscriptionFilter] = {}
# The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. It is optional.
# Docs:
# https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html
self.kms_key_id = kwargs.get("kmsKeyId")
@staticmethod
def cloudformation_name_type() -> str:
return "LogGroupName"
@staticmethod
def cloudformation_type() -> str:
# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html
return "AWS::Logs::LogGroup"
@classmethod
def create_from_cloudformation_json( # type: ignore[misc]
cls,
resource_name: str,
cloudformation_json: Any,
account_id: str,
region_name: str,
**kwargs: Any,
) -> "LogGroup":
properties = cloudformation_json["Properties"]
tags = properties.get("Tags", [])
tags = dict([tag.values() for tag in tags])
return logs_backends[account_id][region_name].create_log_group(
resource_name, tags, **properties
)
def delete(self, account_id: str, region_name: str) -> None:
backend = logs_backends[account_id][region_name]
backend.delete_log_group(self.name)
@classmethod
def has_cfn_attr(cls, attr: str) -> bool:
return attr in ["Arn"]
def get_cfn_attribute(self, attribute_name: str) -> str:
from moto.cloudformation.exceptions import UnformattedGetAttTemplateException
if attribute_name == "Arn":
return self.arn
raise UnformattedGetAttTemplateException()
@property
def physical_resource_id(self) -> str:
return self.name
def create_log_stream(self, log_stream_name: str) -> None:
if log_stream_name in self.streams:
raise ResourceAlreadyExistsException()
stream = LogStream(log_group=self, name=log_stream_name)
self.streams[log_stream_name] = stream
def delete_log_stream(self, log_stream_name: str) -> None:
if log_stream_name not in self.streams:
raise ResourceNotFoundException()
del self.streams[log_stream_name]
def describe_log_streams(
self,
descending: bool,
log_group_name: str,
log_stream_name_prefix: str,
order_by: str,
limit: int,
next_token: Optional[str] = None,
) -> tuple[list[dict[str, Any]], Optional[str]]:
# responses only log_stream_name, creation_time, arn, stored_bytes when no events are stored.
log_streams = [
(name, stream.to_describe_dict())
for name, stream in self.streams.items()
if name.startswith(log_stream_name_prefix)
]
def sorter(item: Any) -> Any:
return (
item[0]
if order_by == "LogStreamName"
else item[1].get("lastEventTimestamp", 0)
)
log_streams = sorted(log_streams, key=sorter, reverse=descending)
first_index = 0
if next_token:
try:
group, stream = next_token.split("@")
if group != log_group_name:
raise ValueError()
first_index = (
next(
index
for (index, e) in enumerate(log_streams)
if e[1]["logStreamName"] == stream
)
+ 1
)
except (ValueError, StopIteration):
first_index = 0
log_streams = []
last_index = first_index + limit
if last_index > len(log_streams):
last_index = len(log_streams)
log_streams_page = [x[1] for x in log_streams[first_index:last_index]]
new_token = None
if log_streams_page and last_index < len(log_streams):
new_token = f"{log_group_name}@{log_streams_page[-1]['logStreamName']}"
return log_streams_page, new_token
def put_log_events(
self,
log_stream_name: str,
log_events: list[dict[str, Any]],
) -> str:
if log_stream_name not in self.streams:
raise ResourceNotFoundException("The specified log stream does not exist.")
stream = self.streams[log_stream_name]
return stream.put_log_events(log_events)
def get_log_events(
self,
log_stream_name: str,
start_time: str,
end_time: str,
limit: int,
next_token: Optional[str],
start_from_head: str,
) -> tuple[list[dict[str, Any]], Optional[str], Optional[str]]:
if log_stream_name not in self.streams:
raise ResourceNotFoundException()
stream = self.streams[log_stream_name]
return stream.get_log_events(
start_time,
end_time,
limit,
next_token,
start_from_head,
)
def filter_log_events(
self,
log_group_name: str,
log_stream_names: list[str],
start_time: int,
end_time: int,
limit: Optional[int],
next_token: Optional[str],
filter_pattern: str,
interleaved: bool,
) -> tuple[list[dict[str, Any]], Optional[str], list[dict[str, Any]]]:
if not limit:
limit = 10000
streams = [
stream
for name, stream in self.streams.items()
if not log_stream_names or name in log_stream_names
]
events = []
for stream in streams:
events += stream.filter_log_events(start_time, end_time, filter_pattern)
if interleaved:
events = sorted(events, key=lambda event: event["timestamp"])
first_index = 0
if next_token:
try:
group, stream_name, event_id = next_token.split("@")
if group != log_group_name:
raise ValueError()
first_index = (
next(
index
for (index, e) in enumerate(events)
if e["logStreamName"] == stream_name
and e["eventId"] == event_id
)
+ 1
)
except (ValueError, StopIteration):
first_index = 0
# AWS returns an empty list if it receives an invalid token.
events = []
last_index = first_index + limit
if last_index > len(events):
last_index = len(events)
events_page = events[first_index:last_index]
next_token = None
if events_page and last_index < len(events):
last_event = events_page[-1]
next_token = f"{log_group_name}@{last_event['logStreamName']}@{last_event['eventId']}"
searched_streams = [
{"logStreamName": stream.log_stream_name, "searchedCompletely": True}
for stream in streams
]
return events_page, next_token, searched_streams
def to_describe_dict(self) -> dict[str, Any]:
log_group = {
"arn": f"{self.arn}:*",
"logGroupArn": self.arn,
"creationTime": self.creation_time,
"logGroupName": self.name,
"metricFilterCount": 0,
"storedBytes": sum(s.stored_bytes for s in self.streams.values()),
}
# AWS only returns retentionInDays if a value is set for the log group (ie. not Never Expire)
if self.retention_in_days:
log_group["retentionInDays"] = self.retention_in_days
if self.kms_key_id:
log_group["kmsKeyId"] = self.kms_key_id
return log_group
def set_retention_policy(self, retention_in_days: Optional[str]) -> None:
self.retention_in_days = retention_in_days
def describe_subscription_filters(self) -> Iterable[SubscriptionFilter]:
return self.subscription_filters.values()
def put_subscription_filter(
self, filter_name: str, filter_pattern: str, destination_arn: str, role_arn: str
) -> None:
# only two subscription filters can be associated with a log group
if len(self.subscription_filters) == 2:
raise LimitExceededException()
# Update existing filter
if filter_name in self.subscription_filters:
self.subscription_filters[filter_name].update(
filter_pattern, destination_arn, role_arn
)
return
self.subscription_filters[filter_name] = SubscriptionFilter(
name=filter_name,
log_group_name=self.name,
filter_pattern=filter_pattern,
destination_arn=destination_arn,
role_arn=role_arn,
)
def delete_subscription_filter(self, filter_name: str) -> None:
if filter_name not in self.subscription_filters:
raise ResourceNotFoundException(
"The specified subscription filter does not exist."
)
self.subscription_filters.pop(filter_name)
class LogResourcePolicy(CloudFormationModel):
def __init__(self, policy_name: str, policy_document: str):
self.policy_name = policy_name
self.policy_document = policy_document
self.last_updated_time = int(unix_time_millis())
def update(self, policy_document: str) -> None:
self.policy_document = policy_document
self.last_updated_time = int(unix_time_millis())
def describe(self) -> dict[str, Any]:
return {
"policyName": self.policy_name,
"policyDocument": self.policy_document,
"lastUpdatedTime": self.last_updated_time,
}
@property
def physical_resource_id(self) -> str:
return self.policy_name
@staticmethod
def cloudformation_name_type() -> str:
return "PolicyName"
@staticmethod
def cloudformation_type() -> str:
# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html
return "AWS::Logs::ResourcePolicy"
@classmethod
def create_from_cloudformation_json( # type: ignore[misc]
cls,
resource_name: str,
cloudformation_json: Any,
account_id: str,
region_name: str,
**kwargs: Any,
) -> "LogResourcePolicy":
properties = cloudformation_json["Properties"]
policy_name = properties["PolicyName"]
policy_document = properties["PolicyDocument"]
return logs_backends[account_id][region_name].put_resource_policy(
policy_name, policy_document
)
@classmethod
def update_from_cloudformation_json( # type: ignore[misc]
cls,
original_resource: Any,
new_resource_name: str,
cloudformation_json: Any,
account_id: str,
region_name: str,
) -> "LogResourcePolicy":
properties = cloudformation_json["Properties"]
policy_name = properties["PolicyName"]
policy_document = properties["PolicyDocument"]
backend = logs_backends[account_id][region_name]
updated = backend.put_resource_policy(policy_name, policy_document)
# TODO: move `update by replacement logic` to cloudformation. this is required for implementing rollbacks
if original_resource.policy_name != policy_name:
backend.delete_resource_policy(original_resource.policy_name)
return updated
@classmethod
def delete_from_cloudformation_json( # type: ignore[misc]
cls,
resource_name: str,
cloudformation_json: Any,
account_id: str,
region_name: str,
) -> None:
logs_backends[account_id][region_name].delete_resource_policy(resource_name)
class ExportTask(BaseModel):
def __init__(
self,
task_id: str,
task_name: str,
log_group_name: str,
destination: str,
destination_prefix: str,
from_time: int,
to: int,
):
self.task_id = task_id
self.task_name = task_name
self.log_group_name = log_group_name
self.destination = destination
self.destination_prefix = destination_prefix
self.from_time = from_time
self.to = to
self.status = {"code": "active", "message": "Task is active"}
def to_json(self) -> dict[str, Any]:
return {
"taskId": self.task_id,
"taskName": self.task_name,
"logGroupName": self.log_group_name,
"destination": self.destination,
"destinationPrefix": self.destination_prefix,
"from": self.from_time,
"to": self.to,
"status": self.status,
}
class DeliveryDestination(BaseModel):
def __init__(
self,
account_id: str,
region: str,
name: str,
output_format: Optional[str],
delivery_destination_configuration: dict[str, str],
tags: Optional[dict[str, str]],
policy: Optional[str] = None,
):
self.name = name
self.output_format = output_format
self.arn = f"arn:aws:logs:{region}:{account_id}:delivery-destination:{name}"
destination_type = delivery_destination_configuration[
"destinationResourceArn"
].split(":")[2]
if destination_type == "s3":
self.delivery_destination_type = "S3"
elif destination_type == "logs":
self.delivery_destination_type = "CWL"
elif destination_type == "firehose":
self.delivery_destination_type = "FH"
self.delivery_destination_configuration = delivery_destination_configuration
self.tags = tags
self.policy = policy
def to_dict(self) -> dict[str, Any]:
dct = {
"name": self.name,
"arn": self.arn,
"deliveryDestinationType": self.delivery_destination_type,
"outputFormat": self.output_format,
"deliveryDestinationConfiguration": self.delivery_destination_configuration,
"tags": self.tags,
}
dct_items = {k: v for k, v in dct.items() if v}
return dct_items
class DeliverySource(BaseModel):
def __init__(
self,
account_id: str,
region: str,
name: str,
resource_arn: str,
log_type: str,
tags: Optional[dict[str, str]],
):
res_arns = []
res_arns.append(resource_arn)
self.name = name
self.arn = f"arn:aws:logs:{region}:{account_id}:delivery-source:{name}"
self.resource_arns = res_arns
self.service = resource_arn.split(":")[2]
self.log_type = log_type
self.tags = tags
def to_dict(self) -> dict[str, Any]:
dct = {
"name": self.name,
"arn": self.arn,
"resourceArns": self.resource_arns,
"service": self.service,
"logType": self.log_type,
"tags": self.tags,
}
dct_items = {k: v for k, v in dct.items() if v}
return dct_items
class Delivery(BaseModel):
def __init__(
self,
account_id: str,
region: str,
delivery_source_name: str,
delivery_destination_arn: str,
destination_type: str,
record_fields: Optional[list[str]],
field_delimiter: Optional[str],
s3_delivery_configuration: Optional[dict[str, Any]],
tags: Optional[dict[str, str]],
):
self.id = mock_random.get_random_string(length=16)
self.arn = f"arn:aws:logs:{region}:{account_id}:delivery:{self.id}"
self.delivery_source_name = delivery_source_name
self.delivery_destination_arn = delivery_destination_arn
self.destination_type = destination_type
# Default record fields
default_record_fields = [
"date",
"time",
"x-edge-location",
"sc-bytes",
"c-ip",
"cs-method",
"cs(Host)",
"cs-uri-stem",
"sc-status",
"cs(Referer)",
"cs(User-Agent)",
"cs-uri-query",
"cs(Cookie)",
"x-edge-result-type",
"x-edge-request-id",
"x-host-header",
"cs-protocol",
"cs-bytes",
"time-taken",
"x-forwarded-for",
"ssl-protocol",
"ssl-cipher",
"x-edge-response-result-type",
"cs-protocol-version",
"fle-status",
"fle-encrypted-fields",
"c-port",
"time-to-first-byte",
"x-edge-detailed-result-type",
"sc-content-type",
"sc-content-len",
"sc-range-start",
"sc-range-end",
]
self.record_fields = record_fields or default_record_fields
self.field_delimiter = field_delimiter
default_s3_configuration = {}
if destination_type == "S3":
# Default s3 configuration
default_s3_configuration = {
"suffixPath": "AWSLogs/{account-id}/CloudFront/",
"enableHiveCompatiblePath": False,
}
self.s3_delivery_configuration = (
s3_delivery_configuration or default_s3_configuration
)
self.tags = tags
def to_dict(self) -> dict[str, Any]:
dct = {
"id": self.id,
"arn": self.arn,
"deliverySourceName": self.delivery_source_name,
"deliveryDestinationArn": self.delivery_destination_arn,
"deliveryDestinationType": self.destination_type,
"recordFields": self.record_fields,
"fieldDelimiter": self.field_delimiter,
"s3DeliveryConfiguration": self.s3_delivery_configuration,
"tags": self.tags,
}
dct_items = {k: v for k, v in dct.items() if v}
return dct_items
class LogsBackend(BaseBackend):
def __init__(self, region_name: str, account_id: str):
super().__init__(region_name, account_id)
self.groups: dict[str, LogGroup] = {}
self.filters = MetricFilters()
self.queries: dict[str, LogQuery] = {}
self.resource_policies: dict[str, LogResourcePolicy] = {}
self.destinations: dict[str, Destination] = {}
self.tagger = TaggingService()
self.export_tasks: dict[str, ExportTask] = {}
self.delivery_destinations: dict[str, DeliveryDestination] = {}
self.delivery_sources: dict[str, DeliverySource] = {}
self.deliveries: dict[str, Delivery] = {}
def create_log_group(
self, log_group_name: str, tags: dict[str, str], **kwargs: Any
) -> LogGroup:
if log_group_name in self.groups:
raise ResourceAlreadyExistsException()
if len(log_group_name) > 512:
raise InvalidParameterException(
constraint="Member must have length less than or equal to 512",
parameter="logGroupName",
value=log_group_name,
)
self.groups[log_group_name] = LogGroup(
self.account_id, self.region_name, log_group_name, **kwargs
)
self.tag_resource(self.groups[log_group_name].arn, tags)
return self.groups[log_group_name]
def ensure_log_group(self, log_group_name: str) -> None:
if log_group_name in self.groups:
return
self.groups[log_group_name] = LogGroup(
self.account_id,
self.region_name,
log_group_name,
)
def delete_log_group(self, log_group_name: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
del self.groups[log_group_name]
@paginate(pagination_model=PAGINATION_MODEL)
def describe_log_groups(
self, log_group_name_prefix: Optional[str] = None
) -> list[LogGroup]:
groups = [
group
for name, group in self.groups.items()
if name.startswith(log_group_name_prefix or "")
]
return sorted(groups, key=lambda x: x.name)
def get_destination(self, destination_name: str) -> Destination:
for destination in self.destinations:
if self.destinations[destination].destination_name == destination_name:
return self.destinations[destination]
raise ResourceNotFoundException()
def put_destination(
self,
destination_name: str,
role_arn: str,
target_arn: str,
tags: dict[str, str],
) -> Destination:
for _, destination in self.destinations.items():
if destination.destination_name == destination_name:
if role_arn:
destination.role_arn = role_arn
if target_arn:
destination.target_arn = target_arn
return destination
destination = Destination(
self.account_id, self.region_name, destination_name, role_arn, target_arn
)
self.destinations[destination.arn] = destination
self.tag_resource(destination.arn, tags)
return destination
def delete_destination(self, destination_name: str) -> None:
destination = self.get_destination(destination_name)
self.destinations.pop(destination.arn)
return
def describe_destinations(
self, destination_name_prefix: str, limit: int, next_token: Optional[int] = None
) -> tuple[list[dict[str, Any]], Optional[int]]:
if limit > 50:
raise InvalidParameterException(
constraint="Member must have value less than or equal to 50",
parameter="limit",
value=limit,
)
result = []
for destination in self.destinations:
result.append(self.destinations[destination].to_dict())
if next_token:
result = result[: int(next_token)]
if destination_name_prefix:
result = [
destination
for destination in result
if destination["destinationName"].startswith(destination_name_prefix)
]
return result, next_token
def put_destination_policy(self, destination_name: str, access_policy: str) -> None:
destination = self.get_destination(destination_name)
destination.access_policy = access_policy
return
def create_log_stream(self, log_group_name: str, log_stream_name: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
log_group.create_log_stream(log_stream_name)
def ensure_log_stream(self, log_group_name: str, log_stream_name: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
if log_stream_name in self.groups[log_group_name].streams:
return
self.create_log_stream(log_group_name, log_stream_name)
def delete_log_stream(self, log_group_name: str, log_stream_name: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
log_group.delete_log_stream(log_stream_name)
def describe_log_streams(
self,
descending: bool,
limit: int,
log_group_name: str,
log_group_id: str,
log_stream_name_prefix: str,
next_token: Optional[str],
order_by: str,
) -> tuple[list[dict[str, Any]], Optional[str]]:
log_group = self._find_log_group(log_group_id, log_group_name)
if limit > 50:
raise InvalidParameterException(
constraint="Member must have value less than or equal to 50",
parameter="limit",
value=limit,
)
if order_by not in ["LogStreamName", "LastEventTime"]:
raise InvalidParameterException(
constraint="Member must satisfy enum value set: [LogStreamName, LastEventTime]",
parameter="orderBy",
value=order_by,
)
if order_by == "LastEventTime" and log_stream_name_prefix:
raise InvalidParameterException(
msg="Cannot order by LastEventTime with a logStreamNamePrefix."
)
return log_group.describe_log_streams(
descending=descending,
limit=limit,
log_group_name=log_group_name,
log_stream_name_prefix=log_stream_name_prefix,
next_token=next_token,
order_by=order_by,
)
def put_log_events(
self,
log_group_name: str,
log_stream_name: str,
log_events: list[dict[str, Any]],
) -> tuple[str, dict[str, Any]]:
"""
The SequenceToken-parameter is not yet implemented
"""
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
# Only events from the last 14 days or 2 hours in the future are accepted
rejected_info = {}
allowed_events = []
last_timestamp = None
oldest = int(unix_time_millis(utcnow() - timedelta(days=14)))
newest = int(unix_time_millis(utcnow() + timedelta(hours=2)))
for idx, event in enumerate(log_events):
if last_timestamp and last_timestamp > event["timestamp"]:
raise InvalidParameterException(
"Log events in a single PutLogEvents request must be in chronological order."
)
if event["timestamp"] < oldest:
rejected_info["tooOldLogEventEndIndex"] = idx
elif event["timestamp"] > newest:
rejected_info["tooNewLogEventStartIndex"] = idx
else:
allowed_events.append(event)
last_timestamp = event["timestamp"]
token = log_group.put_log_events(log_stream_name, allowed_events)
return token, rejected_info
def get_log_events(
self,
log_group_name: str,
log_group_id: str,
log_stream_name: str,
start_time: str,
end_time: str,
limit: int,
next_token: Optional[str],
start_from_head: str,
) -> tuple[list[dict[str, Any]], Optional[str], Optional[str]]:
log_group = self._find_log_group(
log_group_id=log_group_id, log_group_name=log_group_name
)
if limit and limit > 10000:
raise InvalidParameterException(
constraint="Member must have value less than or equal to 10000",
parameter="limit",
value=limit,
)
return log_group.get_log_events(
log_stream_name, start_time, end_time, limit, next_token, start_from_head
)
def filter_log_events(
self,
log_group_name: str,
log_stream_names: list[str],
start_time: int,
end_time: int,
limit: Optional[int],
next_token: Optional[str],
filter_pattern: str,
interleaved: bool,
) -> tuple[list[dict[str, Any]], Optional[str], list[dict[str, Any]]]:
"""
The following filter patterns are currently supported: Single Terms, Multiple Terms, Exact Phrases.
If the pattern is not supported, all events are returned.
"""
if log_group_name not in self.groups:
raise ResourceNotFoundException()
if limit and limit > 10000:
raise InvalidParameterException(
constraint="Member must have value less than or equal to 10000",
parameter="limit",
value=limit,
)
log_group = self.groups[log_group_name]
return log_group.filter_log_events(
log_group_name,
log_stream_names,
start_time,
end_time,
limit,
next_token,
filter_pattern,
interleaved,
)
def put_retention_policy(self, log_group_name: str, retention_in_days: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
self.groups[log_group_name].set_retention_policy(retention_in_days)
def delete_retention_policy(self, log_group_name: str) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
self.groups[log_group_name].set_retention_policy(None)
def describe_resource_policies(self) -> list[LogResourcePolicy]:
"""
Return list of resource policies.
The next_token and limit arguments are ignored. The maximum
number of resource policies per region is a small number (less
than 50), so pagination isn't needed.
"""
return list(self.resource_policies.values())
def put_resource_policy(
self, policy_name: str, policy_doc: str
) -> LogResourcePolicy:
"""
Creates/updates resource policy and return policy object
"""
if policy_name in self.resource_policies:
policy = self.resource_policies[policy_name]
policy.update(policy_doc)
return policy
if len(self.resource_policies) == MAX_RESOURCE_POLICIES_PER_REGION:
raise LimitExceededException()
policy = LogResourcePolicy(policy_name, policy_doc)
self.resource_policies[policy_name] = policy
return policy
def delete_resource_policy(self, policy_name: str) -> None:
"""
Remove resource policy with a policy name matching given name.
"""
if policy_name not in self.resource_policies:
raise ResourceNotFoundException(
msg=f"Policy with name [{policy_name}] does not exist"
)
del self.resource_policies[policy_name]
def list_tags_log_group(self, log_group_name: str) -> dict[str, str]:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
return self.list_tags_for_resource(log_group.arn)
def tag_log_group(self, log_group_name: str, tags: dict[str, str]) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
self.tag_resource(log_group.arn, tags)
def untag_log_group(self, log_group_name: str, tags: list[str]) -> None:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_group = self.groups[log_group_name]
self.untag_resource(log_group.arn, tags)
def put_metric_filter(
self,
filter_name: str,
filter_pattern: str,
log_group_name: str,
metric_transformations: str,
) -> None:
self.filters.add_filter(
filter_name, filter_pattern, log_group_name, metric_transformations
)
def describe_metric_filters(
self,
prefix: Optional[str] = None,
log_group_name: Optional[str] = None,
metric_name: Optional[str] = None,
metric_namespace: Optional[str] = None,
) -> list[dict[str, Any]]:
filters = self.filters.get_matching_filters(
prefix, log_group_name, metric_name, metric_namespace
)
return filters
def delete_metric_filter(
self, filter_name: Optional[str] = None, log_group_name: Optional[str] = None
) -> None:
self.filters.delete_filter(filter_name, log_group_name)
def describe_subscription_filters(
self, log_group_name: str
) -> Iterable[SubscriptionFilter]:
log_group = self.groups.get(log_group_name)
if not log_group:
raise ResourceNotFoundException()
return log_group.describe_subscription_filters()
def put_subscription_filter(
self,
log_group_name: str,
filter_name: str,
filter_pattern: str,
destination_arn: str,
role_arn: str,
) -> None:
log_group = self.groups.get(log_group_name)
if not log_group:
raise ResourceNotFoundException()
service = destination_arn.split(":")[2]
if service == "lambda":
from moto.awslambda.utils import get_backend
try:
get_backend(self.account_id, self.region_name).get_function(
destination_arn
)
# no specific permission check implemented
except Exception:
raise InvalidParameterException(
"Could not execute the lambda function. Make sure you "
"have given CloudWatch Logs permission to execute your "
"function."
)
elif service == "firehose":
from moto.firehose import firehose_backends
firehose = firehose_backends[self.account_id][
self.region_name
].lookup_name_from_arn(destination_arn)
if not firehose:
raise InvalidParameterException(
"Could not deliver test message to specified Firehose "
"stream. Check if the given Firehose stream is in ACTIVE "
"state."
)
elif service == "kinesis":
from moto.kinesis import kinesis_backends
kinesis = kinesis_backends[self.account_id][self.region_name]
try:
kinesis.describe_stream(stream_arn=destination_arn, stream_name=None)
except Exception:
raise InvalidParameterException(
"Could not deliver test message to specified Kinesis stream. Verify the stream exists "
)
else:
# TODO: support Kinesis stream destinations
raise InvalidParameterException(
f"Service '{service}' has not implemented for put_subscription_filter()"
)
log_group.put_subscription_filter(
filter_name, filter_pattern, destination_arn, role_arn
)
def delete_subscription_filter(self, log_group_name: str, filter_name: str) -> None:
log_group = self.groups.get(log_group_name)
if not log_group:
raise ResourceNotFoundException()
log_group.delete_subscription_filter(filter_name)
def start_query(
self,
log_group_names: list[str],
start_time: int,
end_time: int,
query_string: str,
) -> str:
for log_group_name in log_group_names:
if log_group_name not in self.groups:
raise ResourceNotFoundException()
log_groups = [self.groups[name] for name in log_group_names]
query_id = str(mock_random.uuid1())
self.queries[query_id] = LogQuery(
query_id, start_time, end_time, query_string, log_groups
)
return query_id
def describe_queries(
self, log_stream_name: str, status: Optional[str]
) -> list[LogQuery]:
"""
Pagination is not yet implemented
"""
queries: list[LogQuery] = []
for query in self.queries.values():
if log_stream_name in query.log_group_names and (
not status or status == query.status
):
queries.append(query)
return queries
def get_query_results(self, query_id: str) -> LogQuery:
"""
Not all query commands are implemented yet. Please raise an issue if you encounter unexpected results.
"""
return self.queries[query_id]
def cancel_export_task(self, task_id: str) -> None:
task = self.export_tasks.get(task_id)
if not task:
raise ResourceNotFoundException("The specified export task does not exist.")
# If the task has already finished, AWS throws an InvalidOperationException
# 'The specified export task has already finished'
# However, the export task is currently syncronous, meaning it finishes immediately
# When we make the Task async, we can also implement the error behaviour
task.status = {"code": "CANCELLED", "message": "Cancelled by user"}
def create_export_task(
self,
taskName: str,
logGroupName: str,
destination: str,
destinationPrefix: str,
fromTime: int,
to: int,
) -> str:
try:
s3_backends[self.account_id][self.partition].get_bucket(destination)
except MissingBucket:
raise InvalidParameterException(
"The given bucket does not exist. Please make sure the bucket is valid."
)
if logGroupName not in self.groups:
raise ResourceNotFoundException()
task_id = str(mock_random.uuid4())
self.export_tasks[task_id] = ExportTask(
task_id,
taskName,
logGroupName,
destination,
destinationPrefix,
fromTime,
to,
)
s3_backends[self.account_id][self.partition].put_object(
bucket_name=destination,
key_name="aws-logs-write-test",
value=b"Permission Check Successful",
)
if fromTime <= to:
for stream_name in self.groups[logGroupName].streams.keys():
logs, _, _ = self.filter_log_events(
log_group_name=logGroupName,
log_stream_names=[stream_name],
start_time=fromTime,
end_time=to,
limit=None,
next_token=None,
filter_pattern="",
interleaved=False,
)
raw_logs = "\n".join(
[
f"{datetime.fromtimestamp(log['timestamp'] / 1000).strftime('%Y-%m-%dT%H:%M:%S.000Z')} {log['message']}"
for log in logs
]
)
folder = str(mock_random.uuid4()) + "/" + stream_name.replace("/", "-")
key_name = f"{destinationPrefix}/{folder}/000000.gz"
s3_backends[self.account_id][self.partition].put_object(
bucket_name=destination,
key_name=key_name,
value=gzip_compress(raw_logs.encode("utf-8")),
)
self.export_tasks[task_id].status["code"] = "COMPLETED"
self.export_tasks[task_id].status["message"] = "Completed successfully"
return task_id
def describe_export_tasks(self, task_id: str) -> list[ExportTask]:
"""
Pagination is not yet implemented
"""
if task_id:
if task_id not in self.export_tasks:
raise ResourceNotFoundException()
return [self.export_tasks[task_id]]
else:
return list(self.export_tasks.values())
def list_tags_for_resource(self, resource_arn: str) -> dict[str, str]:
return self.tagger.get_tag_dict_for_resource(resource_arn)
def tag_resource(self, arn: str, tags: dict[str, str]) -> None:
self.tagger.tag_resource(arn, TaggingService.convert_dict_to_tags_input(tags))
def untag_resource(self, arn: str, tag_keys: list[str]) -> None:
self.tagger.untag_resource_using_names(arn, tag_keys)
def _find_log_group(self, log_group_id: str, log_group_name: str) -> LogGroup:
log_group: Optional[LogGroup] = None
if log_group_name:
log_group = self.groups.get(log_group_name)
elif log_group_id:
if not re.fullmatch(r"[\w#+=/:,.@-]*", log_group_id):
raise InvalidParameterException(
msg=f"1 validation error detected: Value '{log_group_id}' at 'logGroupIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\w#+=/:,.@-]*"
)
for log_group in self.groups.values():
if log_group.arn == log_group_id:
log_group = log_group
else:
raise InvalidParameterException(
"Should provider either name or id, but not both"
)
if not log_group:
raise ResourceNotFoundException()
return log_group
def put_delivery_destination(
self,
name: str,
output_format: Optional[str],
delivery_destination_configuration: dict[str, str],
tags: Optional[dict[str, str]],
) -> DeliveryDestination:
if output_format and output_format not in [
"w3c",
"raw",
"json",
"plain",
"parquet",
]:
msg = f"1 validation error detected: Value '{output_format}' at 'outputFormat' failed to satisfy constraint: Member must satisfy enum value set: [w3c, raw, json, plain, parquet]"
raise ValidationException(msg)
if name in self.delivery_destinations:
if tags:
raise ConflictException(
msg="Tags can only be provided when a resource is being created, not updated."
)
if (
output_format
and self.delivery_destinations[name].output_format != output_format
):
msg = "Update to existing Delivery Destination with new Output Format is not allowed. Please create a new Delivery Destination instead."
raise ValidationException(msg)
delivery_destination = DeliveryDestination(
account_id=self.account_id,
region=self.region_name,
name=name,
output_format=output_format,
delivery_destination_configuration=delivery_destination_configuration,
tags=tags,
policy=None,
)
self.delivery_destinations[name] = delivery_destination
if tags:
self.tag_resource(delivery_destination.arn, tags)
return delivery_destination
def get_delivery_destination(self, name: str) -> DeliveryDestination:
if name not in self.delivery_destinations:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
delivery_destination = self.delivery_destinations[name]
return delivery_destination
def describe_delivery_destinations(self) -> list[DeliveryDestination]:
# Pagination not yet implemented
delivery_destinations = list(self.delivery_destinations.values())
return delivery_destinations
def put_delivery_destination_policy(
self, delivery_destination_name: str, delivery_destination_policy: str
) -> dict[str, str]:
if delivery_destination_name not in self.delivery_destinations:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
dd = self.delivery_destinations[delivery_destination_name]
dd.policy = delivery_destination_policy
return {"deliveryDestinationPolicy": delivery_destination_policy}
def get_delivery_destination_policy(
self, delivery_destination_name: str
) -> dict[str, Any]:
if delivery_destination_name not in self.delivery_destinations:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
policy = self.delivery_destinations[delivery_destination_name].policy
return {"deliveryDestinationPolicy": policy}
def put_delivery_source(
self, name: str, resource_arn: str, log_type: str, tags: dict[str, str]
) -> DeliverySource:
log_types = {
"cloudfront": "ACCESS_LOGS",
"bedrock": "APPLICATION_LOGS",
"codewhisperer": "EVENT_LOGS",
"mediapackage": ["EGRESS_ACCESS_LOGS", "INGRESS_ACCESS_LOGS"],
"mediatailor": [
"AD_DECISION_SERVER_LOGS",
"MANIFEST_SERVICE_LOGS",
"TRANSCODE_LOGS",
],
"sso": "ERROR_LOGS",
"qdeveloper": "EVENT_LOGS",
"ses": "APPLICATION_LOG",
"workmail": [
"ACCESS_CONTROL_LOGS",
"AUTHENTICATION_LOGS",
"WORKMAIL_AVAILABILITY_PROVIDER_LOGS",
"WORKMAIL_MAILBOX_ACCESS_LOGS",
"WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS",
],
}
resource_type = resource_arn.split(":")[2]
if resource_type not in log_types:
raise ResourceNotFoundException(msg="Cannot access provided service.")
if log_type not in log_types[resource_type]:
raise ValidationException(
msg=" This service is not allowed for this LogSource."
)
if name in self.delivery_sources:
if tags:
raise ConflictException(
msg="Tags can only be provided when a resource is being created, not updated."
)
if resource_arn not in self.delivery_sources[name].resource_arns:
raise ConflictException(
msg="Update to existing Delivery Source with new ResourceId is not allowed. Please create a new Delivery Source instead."
)
delivery_source = DeliverySource(
account_id=self.account_id,
region=self.region_name,
name=name,
resource_arn=resource_arn,
log_type=log_type,
tags=tags,
)
self.delivery_sources[name] = delivery_source
if tags:
self.tag_resource(delivery_source.arn, tags)
return delivery_source
def describe_delivery_sources(self) -> list[DeliverySource]:
# Pagination not yet implemented
delivery_sources = list(self.delivery_sources.values())
return delivery_sources
def get_delivery_source(self, name: str) -> DeliverySource:
if name not in self.delivery_sources:
raise ResourceNotFoundException(
msg="Requested Delivery Source does not exist in this account.."
)
delivery_source = self.delivery_sources[name]
return delivery_source
def create_delivery(
self,
delivery_source_name: str,
delivery_destination_arn: str,
record_fields: Optional[list[str]],
field_delimiter: Optional[str],
s3_delivery_configuration: Optional[dict[str, Any]],
tags: Optional[dict[str, str]],
) -> Delivery:
if delivery_source_name not in self.delivery_sources:
raise ResourceNotFoundException(
msg="Requested Delivery Source does not exist in this account."
)
if delivery_destination_arn not in [
dd.arn for dd in self.delivery_destinations.values()
]:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
for delivery in self.deliveries.values():
if (
delivery.delivery_source_name == delivery_source_name
and delivery.delivery_destination_arn == delivery_destination_arn
):
raise ConflictException(msg="The specified Delivery already exists")
if delivery.delivery_source_name == delivery_source_name:
for dd in self.delivery_destinations.values():
if (
dd.arn == delivery_destination_arn
and delivery.destination_type == dd.delivery_destination_type
):
raise ConflictException(
msg="Delivery already exists for this Delivery Source with the same Delivery Destination Type."
)
for dd in list(self.delivery_destinations.values()):
if dd.arn == delivery_destination_arn:
destination_type = dd.delivery_destination_type
delivery = Delivery(
account_id=self.account_id,
region=self.region_name,
delivery_source_name=delivery_source_name,
delivery_destination_arn=delivery_destination_arn,
destination_type=destination_type,
record_fields=record_fields,
field_delimiter=field_delimiter,
s3_delivery_configuration=s3_delivery_configuration,
tags=tags,
)
self.deliveries[delivery.id] = delivery
if tags:
self.tag_resource(delivery.arn, tags)
return delivery
def describe_deliveries(self) -> list[Delivery]:
# Pagination not yet implemented
deliveries = list(self.deliveries.values())
return deliveries
def get_delivery(self, id: str) -> Delivery:
if id not in self.deliveries:
raise ResourceNotFoundException(
msg="Requested Delivery does not exist in this account."
)
delivery = self.deliveries[id]
return delivery
def delete_delivery(self, id: str) -> None:
if id not in self.deliveries:
raise ResourceNotFoundException(
msg="Requested Delivery does not exist in this account."
)
self.deliveries.pop(id)
return
def delete_delivery_destination(self, name: str) -> None:
if name not in self.delivery_destinations:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
self.delivery_destinations.pop(name)
return
def delete_delivery_destination_policy(
self, delivery_destination_name: str
) -> None:
delivery_destination = self.delivery_destinations.get(delivery_destination_name)
if not delivery_destination:
raise ResourceNotFoundException(
msg="Requested Delivery Destination does not exist in this account."
)
delivery_destination.policy = None
return
def delete_delivery_source(self, name: str) -> None:
if name not in self.delivery_sources:
raise ResourceNotFoundException(
msg="Requested Delivery Source does not exist in this account."
)
self.delivery_sources.pop(name)
return
logs_backends = BackendDict(LogsBackend, "logs")
|