{"id":25729483,"url":"https://github.com/mage-os/mageos-async-events-aws","last_synced_at":"2025-05-07T13:27:31.088Z","repository":{"id":237077204,"uuid":"793768624","full_name":"mage-os/mageos-async-events-aws","owner":"mage-os","description":"This module provides events integrations to AWS.","archived":false,"fork":false,"pushed_at":"2025-02-04T16:40:50.000Z","size":44,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-02-22T11:15:29.470Z","etag":null,"topics":["adobecommerce","aws","ecommerce","mage-os","magento","magento2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mage-os.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-29T20:39:46.000Z","updated_at":"2025-02-04T16:40:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"ee581c4a-4ec9-4c73-982f-a965c1575b70","html_url":"https://github.com/mage-os/mageos-async-events-aws","commit_stats":null,"previous_names":["mage-os/mageos-async-events-aws"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fmageos-async-events-aws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fmageos-async-events-aws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fmageos-async-events-aws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fmageos-async-events-aws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mage-os","download_url":"https://codeload.github.com/mage-os/mageos-async-events-aws/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240774336,"owners_count":19855379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adobecommerce","aws","ecommerce","mage-os","magento","magento2"],"created_at":"2025-02-26T01:26:02.649Z","updated_at":"2025-02-26T01:26:03.676Z","avatar_url":"https://github.com/mage-os.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MageOS Async Events AWS\n\nAWS event sinks for [mageos-async-events](https://github.com/mage-os/mageos-async-events)\n\n## Installation\n\n```sh\ncomposer require mage-os/mageos-async-events-aws\n```\n\n## AWS event sinks\n\n### Amazon EventBridge\n\n**Configure AWS Credentials**\n\nAn IAM role with the `events:PutEvents` action is required so that the notifier can relay events into Amazon\nEventBridge.\n\nUnder `Stores -\u003e Services -\u003e Async Events AWS` set the `Access Key` and the `Secret Access Key` and the `Region`. You\ncan also choose to configure the source of the event.\n\n![AWS Config](./docs/config.png)\n\n**Create an EventBridge Subscription**\n\nThe following is an example to create an EventBridge subscription for the `example.event`\n\n```shell\ncurl --location --request POST 'https://test.mageos.dev/rest/V1/async_event' \\\n--header 'Authorization: Bearer TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"asyncEvent\": {\n        \"event_name\": \"example.event\",\n        \"recipient_url\": \"Amazon Event Bridge ARN\",\n        \"verification_token\": \"supersecret\",\n        \"metadata\": \"eventbridge\"\n    }\n}'\n```\n\n### Amazon Simple Queue Service\n\n**Configure AWS Credentials**\n\nAn IAM role with the `sqs:SendMessage` action is required so that the notifier can relay events into Amazon\nSQS.\n\nUnder `Stores -\u003e Services -\u003e Async Events AWS` set the `Access Key` and the `Secret Access Key` and the `Region`.\n\n\u003e [!NOTE]\n\u003e The maximum message size for SQS is 262,144 bytes (256 KiB)\n\n**Create an SQS Subscription**\n\n```shell\ncurl --location --request POST 'https://test.mageos.dev/rest/V1/async_event' \\\n--header 'Authorization: Bearer TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"asyncEvent\": {\n        \"event_name\": \"example.event\",\n        \"recipient_url\": \"Amazon SQS queue URL\",\n        \"verification_token\": \"supersecret\",\n        \"metadata\": \"sqs\"\n    }\n}'\n```\n\n## Contributing\n\nThis is a repository for distribution only.\nContributions are welcome on the development\nrepository [mageos-async-events-sinks](https://github.com/mage-os/mageos-async-events-sinks)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fmageos-async-events-aws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmage-os%2Fmageos-async-events-aws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fmageos-async-events-aws/lists"}