{"id":19143189,"url":"https://github.com/devenes/python-boto3-api","last_synced_at":"2026-04-12T17:54:35.109Z","repository":{"id":43207165,"uuid":"466430113","full_name":"devenes/python-boto3-api","owner":"devenes","description":"Python API uses the Flask and Boto3 libraries. It has instance listing, instance start, instance stop, instance create and instance terminate features; It has 5 endpoints communicating with EC2 service on AWS.","archived":false,"fork":false,"pushed_at":"2022-06-11T10:37:32.000Z","size":151,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-03T15:44:04.241Z","etag":null,"topics":["amazon-web-services","aws","aws-ec2","aws-sdk","aws-sdk-python","boto","boto3","boto3-script","botocore","ec2","ec2-instance-connect","flask","flask-api","flask-application","json","python"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/devenes/boto3-api/","language":"Python","has_issues":false,"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/devenes.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":null,"security":null,"support":null}},"created_at":"2022-03-05T11:11:18.000Z","updated_at":"2024-03-13T02:53:17.000Z","dependencies_parsed_at":"2022-09-24T08:30:19.539Z","dependency_job_id":null,"html_url":"https://github.com/devenes/python-boto3-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devenes%2Fpython-boto3-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devenes%2Fpython-boto3-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devenes%2Fpython-boto3-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devenes%2Fpython-boto3-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devenes","download_url":"https://codeload.github.com/devenes/python-boto3-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240224101,"owners_count":19767705,"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":["amazon-web-services","aws","aws-ec2","aws-sdk","aws-sdk-python","boto","boto3","boto3-script","botocore","ec2","ec2-instance-connect","flask","flask-api","flask-application","json","python"],"created_at":"2024-11-09T07:29:53.590Z","updated_at":"2026-04-12T17:54:30.086Z","avatar_url":"https://github.com/devenes.png","language":"Python","readme":"\u003cdiv align=\"center\" id=\"top\"\u003e \n  \u003cimg src=\"./readme/boto3.jpg\" alt=\"Python Boto3 Api\" /\u003e\n\n\u0026#xa0;\n\n  \u003c!-- \u003ca href=\"https://pythonboto3api.netlify.app\"\u003eDemo\u003c/a\u003e --\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"center\"\u003ePython Boto3 API for AWS\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://badges.aleen42.com/src/docker.svg\" alt=\"Docker\" /\u003e\n  \u003cimg src=\"https://badges.aleen42.com/src/python.svg\" alt=\"Python\" /\u003e\n  \u003cimg src=\"https://badges.aleen42.com/src/amazon.svg\" alt=\"AWS\" /\u003e  \n  \u003cimg alt=\"Github top language\" src=\"https://img.shields.io/github/languages/top/devenes/python-boto3-api?color=blue\"\u003e\n  \u003cimg alt=\"Github language count\" src=\"https://img.shields.io/github/languages/count/devenes/python-boto3-api?color=green\"\u003e\n  \u003cimg alt=\"Repository size\" src=\"https://img.shields.io/github/repo-size/devenes/python-boto3-api?color=purple\"\u003e\n  \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/devenes/python-boto3-api?color=orange\"\u003e\n  \u003c!-- \u003cimg alt=\"Github issues\" src=\"https://img.shields.io/github/issues/devenes/python-boto3-api?color=56BEB8\" /\u003e --\u003e\n  \u003c!-- \u003cimg alt=\"Github forks\" src=\"https://img.shields.io/github/forks/devenes/python-boto3-api?color=56BEB8\" /\u003e --\u003e\n  \u003c!-- \u003cimg alt=\"Github stars\" src=\"https://img.shields.io/github/stars/devenes/python-boto3-api?color=56BEB8\" /\u003e --\u003e\n\u003c/p\u003e\n\n\u003c!-- Status --\u003e\n\n\u003c!-- \u003ch4 align=\"center\"\u003e\n\t🚧  Python Boto3 Api 🚀 Under construction...  🚧\n\u003c/h4\u003e\n\n\u003chr\u003e --\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#dart-about\"\u003eAbout\u003c/a\u003e \u0026#xa0; | \u0026#xa0; \n  \u003ca href=\"#sparkles-features\"\u003eFeatures\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#rocket-technologies\"\u003eTechnologies\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#white_check_mark-requirements\"\u003eRequirements\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#checkered_flag-starting\"\u003eStarting\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#memo-license\"\u003eLicense\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"https://github.com/devenes\" target=\"_blank\"\u003eAuthor\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n## :dart: About\n\nPython API uses the Flask and Boto3 libraries. It has instance listing, instance start, instance stop, instance create and instance terminate features; It has 5 endpoints communicating with EC2 service on AWS.\n\n## :sparkles: Features\n\n- [:dart: About](#dart-about)\n- [:sparkles: Features](#sparkles-features)\n- [:rocket: Technologies](#rocket-technologies)\n- [:white_check_mark: Requirements](#white_check_mark-requirements)\n- [:checkered_flag: Starting](#checkered_flag-starting)\n- [Create Instance \u003ca name = \"create_instance\"\u003e\u003c/a\u003e](#create-instance-)\n- [List Instances \u003ca name = \"list_instance\"\u003e\u003c/a\u003e](#list-instances-)\n- [Start Instance \u003ca name = \"start_instance\"\u003e\u003c/a\u003e](#start-instance-)\n- [Stop Instance \u003ca name = \"stop_instance\"\u003e\u003c/a\u003e](#stop-instance-)\n- [Terminate Instance \u003ca name = \"terminate_instance\"\u003e\u003c/a\u003e](#terminate-instance-)\n- [Resources](#resources)\n- [:memo: License](#memo-license)\n\n## :rocket: Technologies\n\nThe following tools were used in this project:\n\n- [Python](https://www.python.org/)\n- [Flask](https://flask.palletsprojects.com/)\n- [Boto3](https://boto3.amazonaws.com/)\n- [AWS](https://aws.amazon.com/)\n- [Docker](https://www.docker.com/)\n\n## :white_check_mark: Requirements\n\nBefore starting :checkered_flag:, you need to have [Git](https://git-scm.com) and [Python](https://www.python.org/) installed.\n\n## :checkered_flag: Starting\n\n```bash\n# Clone this project\ngit clone https://github.com/devenes/python-boto3-api\n\n# Access\ncd python-boto3-api\n\n# Install dependencies\npip install -r requirements.txt\n\n# Run the project\npython app.py\n\n# The server will initialize in the \u003chttp://localhost:8080\u003e\n```\n\n## Create Instance \u003ca name = \"create_instance\"\u003e\u003c/a\u003e\n\nYou send a POST request to the `create` endpoint with the following parameters and it will create Ubuntu EC2 instance. You create your EC2 Instance with the `region_name`, `KeyName` and `SecurityGroupId` parameters you send in the request.\n\n```\nhttp://\u003capi_host\u003e:\u003capi_port\u003e/ec2/create\n```\n\n| Parameter               | Type     | Description           |\n| :---------------------- | :------- | :-------------------- |\n| `aws_access_key_id`     | `string` | AWS Access Key ID     |\n| `aws_secret_access_key` | `string` | AWS Secret Access Key |\n| `region_name`           | `string` | AWS Region Name       |\n| `KeyName`               | `string` | AWS Key Name          |\n| `SecurityGroupId`       | `string` | AWS Security Group ID |\n\n---\n\n## List Instances \u003ca name = \"list_instance\"\u003e\u003c/a\u003e\n\nYou send a GET request to the `list` endpoint by entering the following parameters, then you can list all the instances and their status in your AWS account in the region you specify.\n\n```\nhttp://\u003capi_host\u003e:\u003capi_port\u003e/ec2/list\n```\n\n| Parameter               | Type     | Description           |\n| :---------------------- | :------- | :-------------------- |\n| `aws_access_key_id`     | `string` | AWS Access Key ID     |\n| `aws_secret_access_key` | `string` | AWS Secret Access Key |\n| `region_name`           | `string` | AWS Region Name       |\n\n---\n\n## Start Instance \u003ca name = \"start_instance\"\u003e\u003c/a\u003e\n\nYou send a POST request to the `start` endpoint by entering the following parameters, and you can start the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `pending` and then to `running`.\n\n```\nhttp://\u003capi_host\u003e:\u003capi_port\u003e/ec2/start\n```\n\n| Parameter               | Type     | Description           |\n| :---------------------- | :------- | :-------------------- |\n| `aws_access_key_id`     | `string` | AWS Access Key ID     |\n| `aws_secret_access_key` | `string` | AWS Secret Access Key |\n| `region_name`           | `string` | AWS Region Name       |\n| `instance_id`           | `string` | Instance ID Number    |\n\n---\n\n## Stop Instance \u003ca name = \"stop_instance\"\u003e\u003c/a\u003e\n\nYou send a POST request to the `stop` endpoint by entering the following parameters, and you can stop the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `stopping` and then to `stopped`.\n\n```\nhttp://\u003capi_host\u003e:\u003capi_port\u003e/ec2/stop\n```\n\n| Parameter               | Type     | Description           |\n| :---------------------- | :------- | :-------------------- |\n| `aws_access_key_id`     | `string` | AWS Access Key ID     |\n| `aws_secret_access_key` | `string` | AWS Secret Access Key |\n| `region_name`           | `string` | AWS Region Name       |\n| `instance_id`           | `string` | Instance ID Number    |\n\n---\n\n## Terminate Instance \u003ca name = \"terminate_instance\"\u003e\u003c/a\u003e\n\nYou send a POST request to the `terminate` endpoint by entering the following parameters, and you can terminate the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `shutting-down` and then `terminated`.\n\n```\nhttp://\u003capi_host\u003e:\u003capi_port\u003e/ec2/terminate\n```\n\n| Parameter               | Type     | Description           |\n| :---------------------- | :------- | :-------------------- |\n| `aws_access_key_id`     | `string` | AWS Access Key ID     |\n| `aws_secret_access_key` | `string` | AWS Secret Access Key |\n| `region_name`           | `string` | AWS Region Name       |\n| `instance_id`           | `string` | Instance ID Number    |\n\n## Resources\n\n- [AWS](https://aws.amazon.com/)\n- [Docker](https://www.docker.com/)\n- [Git](https://git-scm.com/)\n- [Python](https://www.python.org/)\n- [Boto3](https://boto3.amazonaws.com/)\n\n## :memo: License\n\nThis project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.\n\nMade with :heart: by \u003ca href=\"https://github.com/devenes\" target=\"_blank\"\u003edevenes\u003c/a\u003e\n\n\u0026#xa0;\n\n\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevenes%2Fpython-boto3-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevenes%2Fpython-boto3-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevenes%2Fpython-boto3-api/lists"}