Skip to content

AIBS Informatics AWS Utils

Build Status codecov


Overview

The AIBS Informatics AWS Utils library provides a collection of utilities and tools for working with AWS services. This library includes functionalities for interacting with AWS S3, ECR, Lambda, Batch, DynamoDB, and many other AWS services, making it easier to integrate AWS capabilities into various projects at the Allen Institute for Brain Science.

Features

  • AWS Service Wrappers - Simplified interfaces for S3, Lambda, Batch, ECS, ECR, and more
  • DynamoDB Utilities - Table management, conditions, and query functions
  • ECR Tools - Container image management and replication
  • EFS Integration - Mount point management and path utilities
  • Data Sync - File system synchronization operations
  • Authentication - AWS auth and credential management utilities

Quick Start

Installation

pip install aibs-informatics-aws-utils

Basic Usage

from aibs_informatics_aws_utils.s3 import get_s3_client, upload_file

# Upload a file to S3
upload_file("local/path/file.txt", "s3://bucket/remote/path/file.txt")

Supported AWS Services

Service Module Description
API Gateway apigateway API Gateway utilities
Athena athena Athena query utilities
Batch batch AWS Batch job utilities
DynamoDB dynamodb DynamoDB table and query utilities
EC2 ec2 EC2 instance utilities
ECR ecr Container registry utilities
ECS ecs Container service utilities
EFS efs Elastic File System utilities
FSx fsx FSx file system utilities
Lambda lambda_ Lambda function utilities
Logs logs CloudWatch Logs utilities
S3 s3 S3 storage utilities
Secrets Manager secretsmanager Secrets management utilities
SES ses Email service utilities
SNS sns Notification service utilities
SQS sqs Queue service utilities
SSM ssm Systems Manager utilities
Step Functions stepfn State machine utilities

Contributing

Any and all PRs are welcome. Please see CONTRIBUTING.md for more information.

License

This software is licensed under the Allen Institute Software License, which is the 2-clause BSD license plus a third clause that prohibits redistribution and use for commercial purposes without further permission. For more information, please visit Allen Institute Terms of Use.