<!-- markdownlint-disable -->
<p align="center">
<a href="https://github.com/AWSToolbox/">
<img src="https://cdn.wolfsoftware.com/assets/images/github/organisations/awstoolbox/black-and-white-circle-256.png" alt="AWSToolbox logo" />
</a>
<br />
<a href="https://github.com/AWSToolbox/list-regions/actions/workflows/cicd.yml">
<img src="https://img.shields.io/github/actions/workflow/status/AWSToolbox/list-regions/cicd.yml?branch=master&label=build%20status&style=for-the-badge" alt="Github Build Status" />
</a>
<a href="https://github.com/AWSToolbox/list-regions/blob/master/LICENSE.md">
<img src="https://img.shields.io/github/license/AWSToolbox/list-regions?color=blue&label=License&style=for-the-badge" alt="License">
</a>
<a href="https://github.com/AWSToolbox/list-regions">
<img src="https://img.shields.io/github/created-at/AWSToolbox/list-regions?color=blue&label=Created&style=for-the-badge" alt="Created">
</a>
<br />
<a href="https://github.com/AWSToolbox/list-regions/releases/latest">
<img src="https://img.shields.io/github/v/release/AWSToolbox/list-regions?color=blue&label=Latest%20Release&style=for-the-badge" alt="Release">
</a>
<a href="https://github.com/AWSToolbox/list-regions/releases/latest">
<img src="https://img.shields.io/github/release-date/AWSToolbox/list-regions?color=blue&label=Released&style=for-the-badge" alt="Released">
</a>
<a href="https://github.com/AWSToolbox/list-regions/releases/latest">
<img src="https://img.shields.io/github/commits-since/AWSToolbox/list-regions/latest.svg?color=blue&style=for-the-badge" alt="Commits since release">
</a>
<br />
<a href="https://github.com/AWSToolbox/list-regions/blob/master/.github/CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge" />
</a>
<a href="https://github.com/AWSToolbox/list-regions/blob/master/.github/CONTRIBUTING.md">
<img src="https://img.shields.io/badge/Contributing-blue?style=for-the-badge" />
</a>
<a href="https://github.com/AWSToolbox/list-regions/blob/master/.github/SECURITY.md">
<img src="https://img.shields.io/badge/Report%20Security%20Concern-blue?style=for-the-badge" />
</a>
<a href="https://github.com/AWSToolbox/list-regions/issues">
<img src="https://img.shields.io/badge/Get%20Support-blue?style=for-the-badge" />
</a>
</p>
## Overview
This Python package allows you to list all availability zones configured for a given AWS account. It is part of our larger
[AWS Toolkit](https://github.com/AWSToolbox).
### Installation
To install the package, use:
```sh
pip install wolfsoftware.list-regions
```
### Usage
To list all regions for your AWS account, use the following command:
```sh
usage: list-regions [-h] [-V] [-p PROFILE] [-t THREADS]
List all regions configured for an account.
flags:
-h, --help Show this help message and exit
-V, --version Show program's version number and exit.
optional:
-p PROFILE, --profile PROFILE
AWS profile name from ~/.aws/credentials (default: None)
-t THREADS, --threads THREADS
The number of threads to use (default: 8)
```
### Requirements
You will need a valid set of AWS credentials to run this command. These credentials should be configured in your `~/.aws/credentials` file.
### Example Output
Below is an example of the output you can expect from running this command:
```
+----------------+---------------------------+---------------------+
| Region Name | Location | Status |
+----------------+---------------------------+---------------------+
| af-south-1 | Africa (Cape Town) | not opted in |
| ap-east-1 | Asia Pacific (Hong Kong) | not opted in |
| ap-northeast-1 | Asia Pacific (Tokyo) | opt in not required |
| ap-northeast-2 | Asia Pacific (Seoul) | opt in not required |
| ap-northeast-3 | Asia Pacific (Osaka) | opt in not required |
| ap-south-1 | Asia Pacific (Mumbai) | opt in not required |
| ap-south-2 | Asia Pacific (Hyderabad) | not opted in |
| ap-southeast-1 | Asia Pacific (Singapore) | opt in not required |
| ap-southeast-2 | Asia Pacific (Sydney) | opt in not required |
| ap-southeast-3 | Asia Pacific (Jakarta) | not opted in |
| ap-southeast-4 | Asia Pacific (Melbourne) | not opted in |
| ca-central-1 | Canada (Central) | opt in not required |
| ca-west-1 | Canada West (Calgary) | not opted in |
| eu-central-1 | Europe (Frankfurt) | opt in not required |
| eu-central-2 | Europe (Zurich) | not opted in |
| eu-north-1 | Europe (Stockholm) | opt in not required |
| eu-south-1 | Europe (Milan) | not opted in |
| eu-south-2 | Europe (Spain) | not opted in |
| eu-west-1 | Europe (Ireland) | opt in not required |
| eu-west-2 | Europe (London) | opt in not required |
| eu-west-3 | Europe (Paris) | opt in not required |
| il-central-1 | Israel (Tel Aviv) | not opted in |
| me-central-1 | Middle East (UAE) | not opted in |
| me-south-1 | Middle East (Bahrain) | not opted in |
| sa-east-1 | South America (Sao Paulo) | opt in not required |
| us-east-1 | US East (N. Virginia) | opt in not required |
| us-east-2 | US East (Ohio) | opt in not required |
| us-west-1 | US West (N. California) | opt in not required |
| us-west-2 | US West (Oregon) | opt in not required |
+----------------+---------------------------+---------------------+
```
### Additional Information
For more tools and utilities, check out our [AWS Toolkit](https://github.com/AWSToolbox).
<br />
<p align="right"><a href="https://wolfsoftware.com/"><img src="https://img.shields.io/badge/Created%20by%20Wolf%20on%20behalf%20of%20Wolf%20Software-blue?style=for-the-badge" /></a></p>
Raw data
{
"_id": null,
"home_page": "https://github.com/DevelopersToolbox/template-package-cli",
"name": "wolfsoftware.list-regions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Wolf Software",
"author_email": "pypi@wolfsoftware.com",
"download_url": "https://files.pythonhosted.org/packages/31/d8/5b3c42a51ed90cbb25e93a0cdd806cb1b386214c74e143357c81725b4301/wolfsoftware_list_regions-0.1.2.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable -->\n<p align=\"center\">\n <a href=\"https://github.com/AWSToolbox/\">\n <img src=\"https://cdn.wolfsoftware.com/assets/images/github/organisations/awstoolbox/black-and-white-circle-256.png\" alt=\"AWSToolbox logo\" />\n </a>\n <br />\n <a href=\"https://github.com/AWSToolbox/list-regions/actions/workflows/cicd.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/AWSToolbox/list-regions/cicd.yml?branch=master&label=build%20status&style=for-the-badge\" alt=\"Github Build Status\" />\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/blob/master/LICENSE.md\">\n <img src=\"https://img.shields.io/github/license/AWSToolbox/list-regions?color=blue&label=License&style=for-the-badge\" alt=\"License\">\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions\">\n <img src=\"https://img.shields.io/github/created-at/AWSToolbox/list-regions?color=blue&label=Created&style=for-the-badge\" alt=\"Created\">\n </a>\n <br />\n <a href=\"https://github.com/AWSToolbox/list-regions/releases/latest\">\n <img src=\"https://img.shields.io/github/v/release/AWSToolbox/list-regions?color=blue&label=Latest%20Release&style=for-the-badge\" alt=\"Release\">\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/releases/latest\">\n <img src=\"https://img.shields.io/github/release-date/AWSToolbox/list-regions?color=blue&label=Released&style=for-the-badge\" alt=\"Released\">\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/releases/latest\">\n <img src=\"https://img.shields.io/github/commits-since/AWSToolbox/list-regions/latest.svg?color=blue&style=for-the-badge\" alt=\"Commits since release\">\n </a>\n <br />\n <a href=\"https://github.com/AWSToolbox/list-regions/blob/master/.github/CODE_OF_CONDUCT.md\">\n <img src=\"https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge\" />\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/blob/master/.github/CONTRIBUTING.md\">\n <img src=\"https://img.shields.io/badge/Contributing-blue?style=for-the-badge\" />\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/blob/master/.github/SECURITY.md\">\n <img src=\"https://img.shields.io/badge/Report%20Security%20Concern-blue?style=for-the-badge\" />\n </a>\n <a href=\"https://github.com/AWSToolbox/list-regions/issues\">\n <img src=\"https://img.shields.io/badge/Get%20Support-blue?style=for-the-badge\" />\n </a>\n</p>\n\n## Overview\n\nThis Python package allows you to list all availability zones configured for a given AWS account. It is part of our larger\n[AWS Toolkit](https://github.com/AWSToolbox).\n\n### Installation\n\nTo install the package, use:\n\n```sh\npip install wolfsoftware.list-regions\n```\n\n### Usage\n\nTo list all regions for your AWS account, use the following command:\n\n```sh\nusage: list-regions [-h] [-V] [-p PROFILE] [-t THREADS]\n\nList all regions configured for an account.\n\nflags:\n -h, --help Show this help message and exit\n -V, --version Show program's version number and exit.\n\noptional:\n -p PROFILE, --profile PROFILE\n AWS profile name from ~/.aws/credentials (default: None)\n -t THREADS, --threads THREADS\n The number of threads to use (default: 8)\n```\n\n### Requirements\n\nYou will need a valid set of AWS credentials to run this command. These credentials should be configured in your `~/.aws/credentials` file.\n\n### Example Output\n\nBelow is an example of the output you can expect from running this command:\n\n```\n+----------------+---------------------------+---------------------+\n| Region Name | Location | Status |\n+----------------+---------------------------+---------------------+\n| af-south-1 | Africa (Cape Town) | not opted in |\n| ap-east-1 | Asia Pacific (Hong Kong) | not opted in |\n| ap-northeast-1 | Asia Pacific (Tokyo) | opt in not required |\n| ap-northeast-2 | Asia Pacific (Seoul) | opt in not required |\n| ap-northeast-3 | Asia Pacific (Osaka) | opt in not required |\n| ap-south-1 | Asia Pacific (Mumbai) | opt in not required |\n| ap-south-2 | Asia Pacific (Hyderabad) | not opted in |\n| ap-southeast-1 | Asia Pacific (Singapore) | opt in not required |\n| ap-southeast-2 | Asia Pacific (Sydney) | opt in not required |\n| ap-southeast-3 | Asia Pacific (Jakarta) | not opted in |\n| ap-southeast-4 | Asia Pacific (Melbourne) | not opted in |\n| ca-central-1 | Canada (Central) | opt in not required |\n| ca-west-1 | Canada West (Calgary) | not opted in |\n| eu-central-1 | Europe (Frankfurt) | opt in not required |\n| eu-central-2 | Europe (Zurich) | not opted in |\n| eu-north-1 | Europe (Stockholm) | opt in not required |\n| eu-south-1 | Europe (Milan) | not opted in |\n| eu-south-2 | Europe (Spain) | not opted in |\n| eu-west-1 | Europe (Ireland) | opt in not required |\n| eu-west-2 | Europe (London) | opt in not required |\n| eu-west-3 | Europe (Paris) | opt in not required |\n| il-central-1 | Israel (Tel Aviv) | not opted in |\n| me-central-1 | Middle East (UAE) | not opted in |\n| me-south-1 | Middle East (Bahrain) | not opted in |\n| sa-east-1 | South America (Sao Paulo) | opt in not required |\n| us-east-1 | US East (N. Virginia) | opt in not required |\n| us-east-2 | US East (Ohio) | opt in not required |\n| us-west-1 | US West (N. California) | opt in not required |\n| us-west-2 | US West (Oregon) | opt in not required |\n+----------------+---------------------------+---------------------+\n```\n\n### Additional Information\n\nFor more tools and utilities, check out our [AWS Toolkit](https://github.com/AWSToolbox).\n\n<br />\n<p align=\"right\"><a href=\"https://wolfsoftware.com/\"><img src=\"https://img.shields.io/badge/Created%20by%20Wolf%20on%20behalf%20of%20Wolf%20Software-blue?style=for-the-badge\" /></a></p>\n",
"bugtrack_url": null,
"license": null,
"summary": "Generate a table of the regions your account is using.",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://github.com/AWSToolbox/list-regions",
"Homepage": "https://github.com/DevelopersToolbox/template-package-cli",
"Source": "https://github.com/AWSToolbox/list-regions",
"Sponsor": "https://github.com/sponsors/WolfSoftware",
"Tracker": "https://github.com/AWSToolbox/list-regions/issues/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee9babdb8d8a58b99dacebaaf6d5d26d9088919ee0008cfbc143b71f165be889",
"md5": "7f40cdc844fb0f15c52ea1fb3ce9e457",
"sha256": "b5ab47ed39eb489c319466a3d707880a28e07269912f271f3de44abe67e96861"
},
"downloads": -1,
"filename": "wolfsoftware.list_regions-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f40cdc844fb0f15c52ea1fb3ce9e457",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10428,
"upload_time": "2024-07-01T08:33:55",
"upload_time_iso_8601": "2024-07-01T08:33:55.266384Z",
"url": "https://files.pythonhosted.org/packages/ee/9b/abdb8d8a58b99dacebaaf6d5d26d9088919ee0008cfbc143b71f165be889/wolfsoftware.list_regions-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31d85b3c42a51ed90cbb25e93a0cdd806cb1b386214c74e143357c81725b4301",
"md5": "26c7195cc09649108c438ead653ac59a",
"sha256": "8e163ab0fd1cf6fdf84a49cec97ab150cf03d43607f66e92d956ccafe1708204"
},
"downloads": -1,
"filename": "wolfsoftware_list_regions-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "26c7195cc09649108c438ead653ac59a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10152,
"upload_time": "2024-07-01T08:33:56",
"upload_time_iso_8601": "2024-07-01T08:33:56.648576Z",
"url": "https://files.pythonhosted.org/packages/31/d8/5b3c42a51ed90cbb25e93a0cdd806cb1b386214c74e143357c81725b4301/wolfsoftware_list_regions-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 08:33:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DevelopersToolbox",
"github_project": "template-package-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "wolfsoftware.list-regions"
}
JSON
