Data

Tools

Indexes

Applications

Experiments

Open Source Science

wolfsoftware.get-aws-regions

A package for retrieving a list of available regions from AWS.

https://github.com/awstoolbox/get-aws-regions-package

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

aws aws-regions pypi pypi-package python python-package wolfsoftware
Last synced: 6 months ago · JSON representation ·

Repository

A package for retrieving a list of available regions from AWS.

Basic Info
  • Host: GitHub
  • Owner: AWSToolbox
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 275 KB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 4
  • Releases: 4
Topics
aws aws-regions pypi pypi-package python python-package wolfsoftware
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

AWSToolbox logo
Github Build Status License Created
Release Released Commits since release

Overview

This module provides a simple method for retrieving and processing AWS region information. This is a core component for all of the tools in our AWS Toolbox.

Features

  • Fetching AWS Regions:

    • Retrieve a list of all AWS regions, optionally including/excluding regions based on account opt-in status.
    • Supports fetching detailed information about each region.

  • Region Details:

    • Fetch geographical location descriptions for specific AWS regions from the AWS Systems Manager (SSM) Parameter Store.
    • Utilizes concurrent threading for enhanced performance when fetching multiple region details.

  • Filtering:

    • Apply include and exclude filters to customize the list of AWS regions returned.

Functions

Public Functions

  • getregionlist
    • Retrieves a list of AWS regions.
    • Parameters:
    • include_list: Optional list of regions to include.
    • exclude_list: Optional list of regions to exclude.
    • all_regions: Boolean flag to include all regions (default: True).
    • details: Boolean flag to return detailed information about each region (default: False).
    • profile_name: String to specify the name of the profile to use.
    • Returns:
    • If details=True: Sorted list of dictionaries containing detailed region information.
    • If details=False: Sorted list of region names as strings.
    • Raises:
    • RegionListingError: If an error occurs during region retrieval or processing.

Usage

This module is designed to be used as part of the wolfsoftware.get-aws-regions package. The primary function, get_region_list, allows flexible retrieval and customization of AWS region information based on user-defined criteria.

Example

```python from wolfsoftware.getawsregions import getregionlist

Example usage: Retrieve all regions and print their names

regions = getregionlist(details=False) print("AWS Regions:", regions)

Example usage: Retrieve detailed information for selected regions

detailedregions = getregionlist(includelist=['us-west-1', 'us-east-1'], details=True) for region in detailed_regions: print(f"Region: {region['RegionName']}, Location: {region['GeographicalLocation']}") ```

Notes

  • Ensure AWS credentials are properly configured for API access.
  • Error handling is integrated to manage exceptions during AWS operations.
  • Threading is utilized for efficient concurrent operations when fetching region details.

For further details and customization options, refer to the function docstrings and the module's implementation.


Owner

  • Name: AWS Toolbox
  • Login: AWSToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com
  • Location: United Kingdom

A selection of tools for Amazon Web Services. Created by Wolf Software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: Get AWS Regions Package
abstract: A simple package for retrieving a list of AWS regions.
type: software
version: 0.1.2
date-released: 2024-06-27
repository-code: https://github.com/AWSToolbox/get-aws-regions-package
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Delete event: 115
  • Issue comment event: 231
  • Push event: 182
  • Pull request review event: 167
  • Pull request event: 238
  • Create event: 126
Last Year
  • Delete event: 115
  • Issue comment event: 231
  • Push event: 182
  • Pull request review event: 167
  • Pull request event: 238
  • Create event: 126

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 87
  • Average time to close issues: 1 minute
  • Average time to close pull requests: 4 days
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.7
  • Merged pull requests: 58
  • Bot issues: 2
  • Bot pull requests: 87
Past Year
  • Issues: 2
  • Pull requests: 87
  • Average time to close issues: 1 minute
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.7
  • Merged pull requests: 58
  • Bot issues: 2
  • Bot pull requests: 87
View more stats
Top Authors
Issue Authors
  • dependabot[bot] (2)
Pull Request Authors
  • dependabot[bot] (172)
  • TGWolf (1)
Top Labels
Issue Labels
dependabot: auto approve (2) dependabot: auto merge (2) dependabot: dependencies (2) dependabot: ecosystem : python (2)
Pull Request Labels
dependabot: dependencies (172) dependabot: auto approve (139) dependabot: auto merge (137) dependabot: ecosystem : python (94) dependabot: ecosystem : github actions (78) dependabot: manual merge (18) resolution: closed (1) state: stale (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 430 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: wolfsoftware.get-aws-regions

A simple package for retrieving a list of AWS regions.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 430 Last month
Rankings
Dependent packages count: 10.7%
Average: 35.6%
Dependent repos count: 60.4%
Maintainers (1)
WolfSoftware
Last synced: 6 months ago

Dependencies

.github/workflows/cicd.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/citation-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • citation-file-format/cffconvert-github-action 4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 composite
  • ruby/setup-ruby 3783f195e29b74ae398d7caca108814bbafde90e composite
.github/workflows/codeql.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • github/codeql-action/analyze a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/autobuild a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/init a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
.github/workflows/delete-old-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • Mattraks/delete-workflow-runs 39f0bbed25d76b34de5594dceab824811479e5de composite
.github/workflows/dependabot.yml actions
  • dependabot/fetch-metadata 5e5f99653a5b510e8555840e80cbf1514ad4af38 composite
.github/workflows/document-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-node 60edb5dd545a775178f52524783378180af0d1f8 composite
  • ruby/setup-ruby 3783f195e29b74ae398d7caca108814bbafde90e composite
.github/workflows/generate-release.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • softprops/action-gh-release a74c6b72af54cfa997e81df42d94703d6313a2d0 composite
.github/workflows/generate-test-release.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • softprops/action-gh-release a74c6b72af54cfa997e81df42d94703d6313a2d0 composite
.github/workflows/greetings.yml actions
  • actions/first-interaction 34f15e814fe48ac9312ccf29db4e74fa767cbab7 composite
.github/workflows/purge-deprecated-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • otto-de/purge-deprecated-workflow-runs 31a4e821d43e9a354cbd65845922c76e4b4b3633 composite
.github/workflows/repository-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-go cdcb36043654635271a94b9a6d1392de5bb323a7 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/security-hardening.yml actions
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • zgosalvez/github-actions-ensure-sha-pinned-actions 74606c30450304eee8660aae751818321754feb1 composite
.github/workflows/stale.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
requirements-dev.txt pypi
  • pytest ==8.2.2 development
  • setuptools ==70.1.1 development
requirements.txt pypi
  • boto3 ==1.34.134
  • botocore ==1.34.134
setup.py pypi