pyawsutils
pyawsutils is a collection of utilities for interacting with Amazon Web Services.
Overview
pyawsutils is available:
- install using pip from pypi: https://pypi.org/project/pyawsutils
- browse source code on github: https://github.com/microchip-pic-avr-tools/pyawsutils
- read API documentation on github: https://microchip-pic-avr-tools.github.io/pyawsutils
- read the changelog on github: https://github.com/microchip-pic-avr-tools/pyawsutils/blob/main/CHANGELOG.md
Usage
pyawsutils is intended as a library but could also be used stand-alone as a CLI. Its primary consumer is iotprovision. Make sure you have the AWS CLI installed and run aws configure first to setup your profile.
Command-line interface
pyawsutils has 4 actions with different options. See help and examples below for more details.
Getting help:
pyawsutils --help
register-mar action
The register-mar action supports AWS Multi account registration(MAR) of your device certificate(s) with your AWS profile.
Example:
pyawsutils register-mar -c mycertificate.pem --policy-name mypolicy
register-jitr action
The register-jitr action setup an AWS account for Just in time registration(JITR) with your AWS profile. A cloudformation stack(MCHPStack) is created including a lambda function that registers the device when it connects for the first time.
Example:
pyawsutils register-jitr
create-policy action
The create-policy action lets you create policies that can be used with your MAR setup and AWS IoT account.
Example:
pyawsutils create-policy --policy mypolicy.json --policy-name mypolicy
Clean action
The clean action let you delete all device certificates, things and policies in an AWS IoT account with your AWS profile. Note: CA certificates are not deleted. Other services like cloudformation stacks are also not deleted.
Example:
pyawsutils clean
Library
pyawsutils can be used as a library by instantiating any of the contained classes.
Register device for custom provisioning with MAR
The mar module enables registering a device in AWS by using multi account registration(MAR). The policy module contains policy helper functions. For example:
from pyawsutils.mar import aws_mar
from pyawsutils.policy import Policy
device_cert_file = "my_device.crt"
my_policy = "my_policy"
templatefile = "my_policytemplate.json"
# Read policy template file
with open(templatefile, "r") as myfile:
policy_template = myfile.read()
# Create AWS policy
aws_policy_tool = Policy()
aws_policy_tool.create_policy(my_policy, policy_template)
# Register device certificate without CA for custom provisioning with MAR.
aws_mar_tool = aws_mar()
aws_mar_tool.create_device(certificate_file=device_cert_file,
policy_name=my_policy,
thing_type=None)
Register signer with AWS for custom provisioning
The register_signer module enables registering a signer in the AWS cloud.
from pyawsutils.register_signer import register_signer
# Register signer with AWS. For custom provisioning only.
register_signer(signer_ca_key_path=signer_ca_key_file,
signer_ca_cert_path=signer_ca_cert_file,
signer_ca_ver_cert_path=signer_ca_ver_cert_file,
aws_profile="default")
Setup an AWS Just-in-Time Registration(JITR) account
The aws_cloudformation module contains functions using AWS Cloudformation to setup a JITR account. Example setting up a lambda function with JITR code.
from pyawsutils.aws_cloudformation import setup_aws_jitr_account
# Setup AWS account for JITR, using Cloudformation and uploading Lambda pack with JITR code
setup_aws_jitr_account(force=force_setup)
Cleaner utility
The clean module contains functions to delete certificates, things and policies from your account.
from pyawsutils.clean import AccountCleaner
clean_tool = AccountCleaner(profile_name)
clean_tool.cleanup()
Versioning
pyawsutils version can be determined by:
from pyawsutils import __version__ as pyawsutils_version
print(f"pyawsutils version {pyawsutils_version}")
Changelog
[1.2] - December 2023
Added
- DSG-5731 Help improvements
Fixed
- DSG-5640 Clean up unused pyedbglib dependencies / requirements
- DSG-5714 pyawsutils clean action should also delete MCHPStack
- DSG-5722 Profile not taken into account when doing cloud formation
- DSG-5729 Bug/typo in usage example for pyawsutils create-policy
- DSG-6131 PEP-0440 compliance for pyawsutils
[1.1.0] - October 2022
Fixed
- DSG-5683 Updated AWS JITR Lambda Python runtime 3.6 -> 3.9
[1.0.0] - June 2022
Added
- DSG-5013 Added Amazon root CA bundle as recommended by Amazon
- DSG-4397 Added readme link
- DSG-4471 Added changelog link
Fixed
- DSG-4361 Clean action does not delete any policies
- DSG-5023 Replaced find_packages with find_namespace_packages
[0.11.6] - December 2021
Added
- DSG-4071 Publication to GitHub
- DSG-4192 Sphinx documentation
[0.10.0] - February 2021
- First public release to PyPi
Metadata
Release files for pyawsutils 1.2.6.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyawsutils-1.2.6.12-py3-none-any.whl | Python 3 | none | any | Details for pyawsutils-1.2.6.12-py3-none-any.whl |
Release files / pyawsutils-1.2.6.12-py3-none-any.whl
| Download URL | pyawsutils-1.2.6.12-py3-none-any.whl |
|---|---|
| Size | 4.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2dfa3d13f246a36d90ffe281267111adac03db44ade83dafa38dbbb836af5d16
|
|
BLAKE2b-256 checksum How to use checksums |
9069136f309df5411b29fef1a9e8fdd4814f4234015018e7a296e06b58d76db6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.16
|
Security for pyawsutils 1.2.6.12
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.