aws-lambda-powertools 3.6.1a9__tar.gz → 3.7.0__tar.gz

{aws_lambda_powertools-3.6.1a9 → aws_lambda_powertools-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: aws_lambda_powertools
-Version: 3.6.1a9
+Version: 3.7.0
 Summary: Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.
 License: MIT
 Keywords: aws_lambda_powertools,aws,tracing,logging,lambda,powertools,feature_flags,idempotency,middleware

{aws_lambda_powertools-3.6.1a9 → aws_lambda_powertools-3.7.0}/aws_lambda_powertools/shared/version.py

@@ -1,3 +1,3 @@
 """Exposes version constant to avoid circular dependencies."""
 
-VERSION = "3.6.1a9"
+VERSION = "3.7.0"

aws_lambda_powertools-3.7.0/aws_lambda_powertools/utilities/data_classes/iot_registry_event.py

@@ -0,0 +1,418 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, Literal
+
+from aws_lambda_powertools.utilities.data_classes.common import DictWrapper
+
+EVENT_CRUD_OPERATION = Literal["CREATED", "UPDATED", "DELETED"]
+EVENT_ADD_REMOVE_OPERATION = Literal["ADDED", "REMOVED"]
+
+
+class IoTCoreRegistryEventsBase(DictWrapper):
+    @property
+    def event_id(self) -> str:
+        """
+        The unique identifier for the event.
+        """
+        return self["eventId"]
+
+    @property
+    def timestamp(self) -> datetime:
+        """
+        The timestamp of the event.
+
+        The timestamp is in Unix format (seconds or milliseconds).
+        If it's 10 digits long, it represents seconds;
+        if it's 13 digits, it's in milliseconds and is converted to seconds.
+        """
+        ts = self["timestamp"]
+        return datetime.fromtimestamp(ts / 1000 if ts > 10**10 else ts)
+
+
+class IoTCoreThingEvent(IoTCoreRegistryEventsBase):
+    """
+    Thing Created/Updated/Deleted
+    The registry publishes event messages when things are created, updated, or deleted.
+    """
+
+    @property
+    def event_type(self) -> Literal["THING_EVENT"]:
+        """
+        The event type, which will always be "THING_EVENT".
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> str:
+        """
+        The operation type for the event (e.g., CREATED, UPDATED, DELETED).
+        """
+        return self["operation"]
+
+    @property
+    def thing_id(self) -> str:
+        """
+        The unique identifier for the thing.
+        """
+        return self["thingId"]
+
+    @property
+    def account_id(self) -> str:
+        """
+        The account ID associated with the event.
+        """
+        return self["accountId"]
+
+    @property
+    def thing_name(self) -> str:
+        """
+        The name of the thing.
+        """
+        return self["thingName"]
+
+    @property
+    def version_number(self) -> int:
+        """
+        The version number of the thing.
+        """
+        return self["versionNumber"]
+
+    @property
+    def thing_type_name(self) -> str | None:
+        """
+        The thing type name if available, or None if not specified.
+        """
+        return self.get("thingTypeName")
+
+    @property
+    def attributes(self) -> dict[str, Any]:
+        """
+        The dictionary of attributes associated with the thing.
+        """
+        return self["attributes"]
+
+
+class IoTCoreThingTypeEvent(IoTCoreRegistryEventsBase):
+    """
+    Thing Type Created/Updated/Deprecated/Undeprecated/Deleted
+    The registry publishes event messages when thing types are created, updated, deprecated, undeprecated, or deleted.
+    """
+
+    @property
+    def event_type(self) -> str:
+        """
+        The event type, corresponding to a thing type event.
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> EVENT_CRUD_OPERATION:
+        """
+        The operation performed on the thing type (e.g., CREATED, UPDATED, DELETED).
+        """
+        return self["operation"]
+
+    @property
+    def account_id(self) -> str:
+        """
+        The account ID associated with the event.
+        """
+        return self["accountId"]
+
+    @property
+    def thing_type_id(self) -> str:
+        """
+        The unique identifier for the thing type.
+        """
+        return self["thingTypeId"]
+
+    @property
+    def thing_type_name(self) -> str:
+        """
+        The name of the thing type.
+        """
+        return self["thingTypeName"]
+
+    @property
+    def is_deprecated(self) -> bool:
+        """
+        Whether the thing type is marked as deprecated.
+        """
+        return self["isDeprecated"]
+
+    @property
+    def deprecation_date(self) -> datetime | None:
+        """
+        The deprecation date of the thing type, or None if not available.
+        """
+        return datetime.fromisoformat(self["deprecationDate"]) if self.get("deprecationDate") else None
+
+    @property
+    def searchable_attributes(self) -> list[str]:
+        """
+        The list of attributes that are searchable for the thing type.
+        """
+        return self["searchableAttributes"]
+
+    @property
+    def propagating_attributes(self) -> list[dict[str, str]]:
+        """
+        The list of attributes to propagate for the thing type.
+        """
+        return self["propagatingAttributes"]
+
+    @property
+    def description(self) -> str:
+        """
+        The description of the thing type.
+        """
+        return self["description"]
+
+
+class IoTCoreThingTypeAssociationEvent(IoTCoreRegistryEventsBase):
+    """
+    The registry publishes event messages when a thing type is associated or disassociated with a thing.
+    """
+
+    @property
+    def event_type(self) -> str:
+        """
+        The event type, related to the thing type association event.
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> Literal["THING_TYPE_ASSOCIATION_EVENT"]:
+        """
+        The operation type, which is always "THING_TYPE_ASSOCIATION_EVENT".
+        """
+        return self["operation"]
+
+    @property
+    def thing_id(self) -> str:
+        """
+        The unique identifier for the associated thing.
+        """
+        return self["thingId"]
+
+    @property
+    def thing_name(self) -> str:
+        """
+        The name of the associated thing.
+        """
+        return self["thingName"]
+
+    @property
+    def thing_type_name(self) -> str:
+        """
+        The name of the associated thing type.
+        """
+        return self["thingTypeName"]
+
+
+class IoTCoreThingGroupEvent(IoTCoreRegistryEventsBase):
+    """
+    The registry publishes event messages when a thing group is created, updated, or deleted.
+    """
+
+    @property
+    def event_type(self) -> str:
+        """
+        The event type, corresponding to the thing group event.
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> EVENT_CRUD_OPERATION:
+        """
+        The operation type (e.g., CREATED, UPDATED, DELETED) performed on the thing group.
+        """
+        return self["operation"]
+
+    @property
+    def account_id(self) -> str:
+        """
+        The account ID associated with the event.
+        """
+        return self["accountId"]
+
+    @property
+    def thing_group_id(self) -> str:
+        """
+        The unique identifier for the thing group.
+        """
+        return self["thingGroupId"]
+
+    @property
+    def thing_group_name(self) -> str:
+        """
+        The name of the thing group.
+        """
+        return self["thingGroupName"]
+
+    @property
+    def version_number(self) -> int:
+        """
+        The version number of the thing group.
+        """
+        return self["versionNumber"]
+
+    @property
+    def parent_group_name(self) -> str | None:
+        """
+        The name of the parent group, or None if not applicable.
+        """
+        return self.get("parentGroupName")
+
+    @property
+    def parent_group_id(self) -> str | None:
+        """
+        The ID of the parent group, or None if not applicable.
+        """
+        return self.get("parentGroupId")
+
+    @property
+    def description(self) -> str:
+        """
+        The description of the thing group.
+        """
+        return self["description"]
+
+    @property
+    def root_to_parent_thing_groups(self) -> list[dict[str, str]]:
+        """
+        The list of root-to-parent thing group mappings.
+        """
+        return self["rootToParentThingGroups"]
+
+    @property
+    def attributes(self) -> dict[str, Any]:
+        """
+        The attributes associated with the thing group.
+        """
+        return self["attributes"]
+
+    @property
+    def dynamic_group_mapping_id(self) -> str | None:
+        """
+        The dynamic group mapping ID if available, or None if not specified.
+        """
+        return self.get("dynamicGroupMappingId")
+
+
+class IoTCoreAddOrRemoveFromThingGroupEvent(IoTCoreRegistryEventsBase):
+    """
+    The registry publishes event messages when a thing is added to or removed from a thing group.
+    """
+
+    @property
+    def event_type(self) -> str:
+        """
+        The event type, corresponding to the add/remove from thing group event.
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> EVENT_ADD_REMOVE_OPERATION:
+        """
+        The operation (ADDED or REMOVED) performed on the thing in the group.
+        """
+        return self["operation"]
+
+    @property
+    def account_id(self) -> str:
+        """
+        The account ID associated with the event.
+        """
+        return self["accountId"]
+
+    @property
+    def group_arn(self) -> str:
+        """
+        The ARN of the group the thing was added to or removed from.
+        """
+        return self["groupArn"]
+
+    @property
+    def group_id(self) -> str:
+        """
+        The unique identifier of the group.
+        """
+        return self["groupId"]
+
+    @property
+    def thing_arn(self) -> str:
+        """
+        The ARN of the thing being added or removed.
+        """
+        return self["thingArn"]
+
+    @property
+    def thing_id(self) -> str:
+        """
+        The unique identifier for the thing being added or removed.
+        """
+        return self["thingId"]
+
+    @property
+    def membership_id(self) -> str:
+        """
+        The unique membership ID for the thing within the group.
+        """
+        return self["membershipId"]
+
+
+class IoTCoreAddOrDeleteFromThingGroupEvent(IoTCoreRegistryEventsBase):
+    """
+    The registry publishes event messages when a child group is added to or deleted from a parent group.
+    """
+
+    @property
+    def event_type(self) -> str:
+        """
+        The event type, corresponding to the add/delete from thing group event.
+        """
+        return self["eventType"]
+
+    @property
+    def operation(self) -> EVENT_ADD_REMOVE_OPERATION:
+        """
+        The operation (ADDED or REMOVED) performed on the child group.
+        """
+        return self["operation"]
+
+    @property
+    def account_id(self) -> str:
+        """
+        The account ID associated with the event.
+        """
+        return self["accountId"]
+
+    @property
+    def thing_group_id(self) -> str:
+        """
+        The unique identifier of the thing group.
+        """
+        return self["thingGroupId"]
+
+    @property
+    def thing_group_name(self) -> str:
+        """
+        The name of the thing group.
+        """
+        return self["thingGroupName"]
+
+    @property
+    def child_group_id(self) -> str:
+        """
+        The unique identifier of the child group being added or removed.
+        """
+        return self["childGroupId"]
+
+    @property
+    def child_group_name(self) -> str:
+        """
+        The name of the child group being added or removed.
+        """
+        return self["childGroupName"]

{aws_lambda_powertools-3.6.1a9 → aws_lambda_powertools-3.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aws_lambda_powertools"
-version = "3.6.1a9"
+version = "3.7.0"
 description = "Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity."
 authors = ["Amazon Web Services"]
 include = ["aws_lambda_powertools/py.typed", "THIRD-PARTY-LICENSES"]

{aws_lambda_powertools-3.6.1a9 → aws_lambda_powertools-3.7.0}/setup.py

@@ -64,7 +64,7 @@ extras_require = \
 
 setup_kwargs = {
     'name': 'aws_lambda_powertools',
-    'version': '3.6.1a9',
+    'version': '3.7.0',
     'description': 'Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.',
     'long_description': '<!-- markdownlint-disable MD013 MD041 MD043  -->\n# Powertools for AWS Lambda (Python)\n\n[![Build](https://github.com/aws-powertools/powertools-lambda-python/actions/workflows/quality_check.yml/badge.svg)](https://github.com/aws-powertools/powertools-lambda-python/actions/workflows/python_build.yml)\n[![codecov.io](https://codecov.io/github/aws-powertools/powertools-lambda-python/branch/develop/graphs/badge.svg)](https://app.codecov.io/gh/aws-powertools/powertools-lambda-python)\n![PythonSupport](https://img.shields.io/static/v1?label=python&message=%203.9|%203.10|%203.11|%203.12|%203.13&color=blue?style=flat-square&logo=python) ![PyPI version](https://badge.fury.io/py/aws-lambda-powertools.svg) ![PyPi monthly downloads](https://img.shields.io/pypi/dm/aws-lambda-powertools) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-python/badge)](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-python) [![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET?style=flat-square)](https://discord.gg/B8zZKbbyET)\n\nPowertools for AWS Lambda (Python) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/python/latest/#features).\n\n> Also available in [Java](https://github.com/aws-powertools/powertools-lambda-java), [Typescript](https://github.com/aws-powertools/powertools-lambda-typescript), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet).\n\n**[📜Documentation](https://docs.powertools.aws.dev/lambda/python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://docs.powertools.aws.dev/lambda/python/latest/roadmap/)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**\n\n![hero-image](https://user-images.githubusercontent.com/3340292/198254617-d0fdb672-86a6-4988-8a40-adf437135e0a.png)\n\n## Features\n\n* **[Tracing](https://docs.powertools.aws.dev/lambda/python/latest/core/tracer/)** - Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions\n* **[Logging](https://docs.powertools.aws.dev/lambda/python/latest/core/logger/)** - Structured logging made easier, and decorator to enrich structured logging with key Lambda context details\n* **[Metrics](https://docs.powertools.aws.dev/lambda/python/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)\n* **[Event handler: AppSync](https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/appsync/)** - AWS AppSync event handler for Lambda Direct Resolver and Amplify GraphQL Transformer function\n* **[Event handler: API Gateway and ALB](https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/api_gateway/)** - Amazon API Gateway REST/HTTP API and ALB event handler for Lambda functions invoked using Proxy integration\n* **[Event handler: Agents for Amazon Bedrock](https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/bedrock_agents/)** - Create Agents for Amazon Bedrock, automatically generating OpenAPI schemas\n* **[Bring your own middleware](https://docs.powertools.aws.dev/lambda/python/latest/utilities/middleware_factory/)** - Decorator factory to create your own middleware to run logic before, and after each Lambda invocation\n* **[Parameters utility](https://docs.powertools.aws.dev/lambda/python/latest/utilities/parameters/)** - Retrieve and cache parameter values from Parameter Store, Secrets Manager, or DynamoDB\n* **[Batch processing](https://docs.powertools.aws.dev/lambda/python/latest/utilities/batch/)** - Handle partial failures for AWS SQS batch processing\n* **[Typing](https://docs.powertools.aws.dev/lambda/python/latest/utilities/typing/)** - Static typing classes to speedup development in your IDE\n* **[Validation](https://docs.powertools.aws.dev/lambda/python/latest/utilities/validation/)** - JSON Schema validator for inbound events and responses\n* **[Event source data classes](https://docs.powertools.aws.dev/lambda/python/latest/utilities/data_classes/)** - Data classes describing the schema of common Lambda event triggers\n* **[Parser](https://docs.powertools.aws.dev/lambda/python/latest/utilities/parser/)** - Data parsing and deep validation using Pydantic\n* **[Idempotency](https://docs.powertools.aws.dev/lambda/python/latest/utilities/idempotency/)** - Convert your Lambda functions into idempotent operations which are safe to retry\n* **[Data Masking](https://docs.powertools.aws.dev/lambda/python/latest/utilities/data_masking/)** -  Protect confidential data with easy removal or encryption\n* **[Feature Flags](https://docs.powertools.aws.dev/lambda/python/latest/utilities/feature_flags/)** - A simple rule engine to evaluate when one or multiple features should be enabled depending on the input\n* **[Streaming](https://docs.powertools.aws.dev/lambda/python/latest/utilities/streaming/)** - Streams datasets larger than the available memory as streaming data.\n\n### Installation\n\nWith [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip install aws-lambda-powertools``\n\n## Tutorial and Examples\n\n* [Tutorial](https://docs.powertools.aws.dev/lambda/python/latest/tutorial)\n* [Serverless Shopping cart](https://github.com/aws-samples/aws-serverless-shopping-cart)\n* [Serverless Airline](https://github.com/aws-samples/aws-serverless-airline-booking)\n* [Serverless E-commerce platform](https://github.com/aws-samples/aws-serverless-ecommerce-platform)\n* [Serverless GraphQL Nanny Booking Api](https://github.com/trey-rosius/babysitter_api)\n\n## How to support Powertools for AWS Lambda (Python)?\n\n### Becoming a reference customer\n\nKnowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (Python), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (Python) (become a reference)](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E) issue.\n\nThe following companies, among others, use Powertools:\n\n* [Alma Media](https://www.almamedia.fi/en/)\n* [Banxware](https://www.banxware.com/)\n* [Brsk](https://www.brsk.co.uk/)\n* [BusPatrol](https://buspatrol.com/)\n* [Capital One](https://www.capitalone.com/)\n* [Caylent](https://caylent.com/)\n* [CHS Inc.](https://www.chsinc.com/)\n* [CPQi (Exadel Financial Services)](https://cpqi.com/)\n* [CloudZero](https://www.cloudzero.com/)\n* [CyberArk](https://www.cyberark.com/)\n* [Flyweight](https://flyweight.io/)\n* [globaldatanet](https://globaldatanet.com/)\n* [IMS](https://ims.tech/)\n* [Jit Security](https://www.jit.io/)\n* [LocalStack](https://www.localstack.cloud/)\n* [Propellor.ai](https://www.propellor.ai/)\n* [Pushpay](https://pushpay.com/)\n* [Recast](https://getrecast.com/)\n* [TopSport](https://www.topsport.com.au/)\n* [Transformity](https://transformity.tech/)\n* [Trek10](https://www.trek10.com/)\n* [Vertex Pharmaceuticals](https://www.vrtx.com/)\n\n### Sharing your work\n\nShare what you did with Powertools for AWS Lambda (Python) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (Python) [here](https://docs.powertools.aws.dev/lambda/python/latest/we_made_this/).\n\n### Using Lambda Layer or SAR\n\nThis helps us understand who uses Powertools for AWS Lambda (Python) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](https://docs.powertools.aws.dev/lambda/python/latest/#lambda-layer), you can add Powertools for AWS Lambda (Python) as a dev dependency (or as part of your virtual env) to not impact the development process.\n\n## Credits\n\n* Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)\n* Powertools for AWS Lambda (Python) idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)\n\n## Connect\n\n* **Powertools for AWS Lambda on Discord**: `#python` - **[Invite link](https://discord.gg/B8zZKbbyET)**\n* **Email**: <aws-powertools-maintainers@amazon.com>\n\n## Security disclosures\n\nIf you think you’ve found a potential security issue, please do not post it in the Issues.  Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:aws-security@amazon.com).\n\n## License\n\nThis library is licensed under the MIT-0 License. See the LICENSE file.\n',
     'author': 'Amazon Web Services',