Effect AWS Monorepo
A collection of libraries simplifying AWS integrations within the Effect ecosystem
Effect Website: https://www.effect.website
Effect API Reference: https://effect-ts.github.io/effect
Effect AWS Website: https://effect-aws.website
Effect AWS API Reference: https://floydspace.github.io/effect-aws
Monorepo Structure
The Effect AWS monorepo is organized into clients (having same name as native AWS clients) and helper packages. Below is an overview of the packages included:
| Package | Description | ||
|---|---|---|---|
@effect-aws/commons | Common utilities for Effectful AWS clients |   | README |
@effect-aws/client-account | Effectful AWS Account client |   | README |
@effect-aws/client-api-gateway | Effectful AWS API Gateway client |   | README |
@effect-aws/client-api-gateway-v2 | Effectful AWS API Gateway V2 client |   | README |
@effect-aws/client-api-gateway-management-api | Effectful AWS API Gateway Management API client |   | README |
@effect-aws/client-athena | Effectful AWS Athena client |   | README |
@effect-aws/client-auto-scaling | Effectful AWS Auto Scaling client |   | README |
@effect-aws/client-bedrock | Effectful AWS Bedrock client |   | README |
@effect-aws/client-bedrock-runtime | Effectful AWS Bedrock Runtime client |   | README |
@effect-aws/client-cloudsearch | Effectful AWS CloudSearch client |   | README |
@effect-aws/client-cloudtrail | Effectful AWS CloudTrail client |   | README |
@effect-aws/client-cloudwatch | Effectful AWS CloudWatch client |   | README |
@effect-aws/client-cloudwatch-events | Effectful AWS CloudWatch Events client |   | README |
@effect-aws/client-cloudwatch-logs | Effectful AWS CloudWatch Logs client |   | README |
@effect-aws/client-codedeploy | Effectful AWS CodeDeploy client |   | README |
@effect-aws/client-cognito-identity-provider | Effectful AWS Cognito Identity Provider client |   | README |
@effect-aws/client-dynamodb | Effectful AWS DynamoDB client |   | README |
@effect-aws/client-ec2 | Effectful AWS EC2 client |   | README |
@effect-aws/client-ecr | Effectful AWS ECR client |   | README |
@effect-aws/client-ecs | Effectful AWS ECS client |   | README |
@effect-aws/client-elasticache | Effectful AWS ElastiCache client |   | README |
@effect-aws/client-eventbridge | Effectful AWS EventBridge client |   | README |
@effect-aws/client-firehose | Effectful AWS Firehose client |   | README |
@effect-aws/client-iam | Effectful AWS IAM client |   | README |
@effect-aws/client-iot | Effectful AWS IoT client |   | README |
@effect-aws/client-iot-data-plane | Effectful AWS IoT Data Plane client |   | README |
@effect-aws/client-iot-events | Effectful AWS IoT Events client |   | README |
@effect-aws/client-iot-events-data | Effectful AWS IoT Events Data client |   | README |
@effect-aws/client-iot-jobs-data-plane | Effectful AWS IoT Jobs Data Plane client |   | README |
@effect-aws/client-iot-wireless | Effectful AWS IoT Wireless client |   | README |
@effect-aws/client-kinesis | Effectful AWS Kinesis client |   | README |
@effect-aws/client-kms | Effectful AWS KMS client |   | README |
@effect-aws/client-lambda | Effectful AWS Lambda client |   | README |
@effect-aws/client-mq | Effectful AWS MQ client |   | README |
@effect-aws/client-opensearch | Effectful AWS OpenSearch client |   | README |
@effect-aws/client-opensearch-serverless | Effectful AWS OpenSearch Serverless client |   | README |
@effect-aws/client-organizations | Effectful AWS Organizations client |   | README |
@effect-aws/client-rds | Effectful AWS RDS client |   | README |
@effect-aws/client-s3 | Effectful AWS S3 client |   | README |
@effect-aws/client-scheduler | Effectful AWS Scheduler client |   | README |
@effect-aws/client-secrets-manager | Effectful AWS Secrets Manager client |   | README |
@effect-aws/client-ses | Effectful AWS SES client |   | README |
@effect-aws/client-sfn | Effectful AWS Step Functions client |   | README |
@effect-aws/client-sns | Effectful AWS SNS client |   | README |
@effect-aws/client-sqs | Effectful AWS SQS client |   | README |
@effect-aws/client-ssm | Effectful AWS SSM client |   | README |
@effect-aws/client-sts | Effectful AWS STS client |   | README |
@effect-aws/client-textract | Effectful AWS Textract client |   | README |
@effect-aws/client-timestream-write | Effectful AWS Timestream Write client |   | README |
@effect-aws/client-timestream-query | Effectful AWS Timestream Query client |   | README |
@effect-aws/client-timestream-influxdb | Effectful AWS Timestream InfluxDB client |   | README |
@effect-aws/dynamodb | Effectful AWS DynamoDB library & functions |   | README |
@effect-aws/http-handler | Effectful HttpHandler for AWS SDK |   | README |
@effect-aws/lambda | Effectful AWS Lambda handler |   | README |
@effect-aws/powertools-logger | Effectful Powertools Logger for AWS Lambda |   | README |
@effect-aws/powertools-tracer | Effectful Powertools Tracer for AWS Lambda |   | README |
@effect-aws/s3 | Effectful AWS S3 functions |   | README |
@effect-aws/secrets-manager | Effectful AWS Secrets Manager functions |   | README |
@effect-aws/ssm | Effectful AWS SSM functions |   | README |
Documentation
API Reference
For a complete API reference of the effect-aws packages, see the Effect AWS API documentation.
Contributing Guidelines
Thank you for considering contributing to our project! Here are some guidelines to help you get started:
Reporting Bugs
If you have found a bug, please open an issue on our issue tracker and provide as much detail as possible. This should include:
- A clear and concise description of the problem
- Steps to reproduce the problem
- The expected behavior
- The actual behavior
- Any relevant error messages or logs
Suggesting Enhancements
If you have an idea for an enhancement or a new feature, please open an issue on our issue tracker and provide as much detail as possible. This should include:
- A clear and concise description of the enhancement or feature
- Any potential benefits or use cases
- Any potential drawbacks or trade-offs
Pull Requests
We welcome contributions via pull requests! Here are some guidelines to help you get started:
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes:
git checkout -b my-new-feature - Install dependencies:
pnpm install(pnpm@9.x, usingcorepackornixpreferred)- if you introduce new dependencies, please use
.projenrc.tsto add them - then run
pnpm defaultto update the project
- if you introduce new dependencies, please use
- Make your changes and add tests if applicable.
- Run the tests:
pnpm test - Commit your changes:
git commit -am 'Add some feature' - Push your changes to your fork:
git push origin my-new-feature - Open a pull request against our
mainbranch.
Pull Request Guidelines
- Please make sure your changes are consistent with the project's existing style and conventions.
- Please write clear commit messages and include a summary of your changes in the pull request description.
- Please make sure all tests pass and add new tests as necessary.
- If your change requires documentation, please update the relevant documentation.
- Please be patient! We will do our best to review your pull request as soon as possible.
License
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.