get aws regions package

Überblick

Dieses Modul bietet eine einfache Methode zum Abrufen und Verarbeiten von AWS -Regionsinformationen. Dies ist eine Kernkomponente für alle Tools in unserer AWS -Toolbox.

Merkmale

• AWS -Regionen abrufen :

  • Abrufen Sie eine Liste aller AWS-Regionen ab, einschließlich/Ausschluss von Regionen basierend auf dem Status des Kontos.
  • Unterstützt das Abrufen detaillierter Informationen zu jeder Region.

• Region Details :

  • Fetch geografische Standortbeschreibungen für bestimmte AWS -Regionen aus dem Parameterspeicher AWS Systems Manager (SSM).
  • Verwendet das gleichzeitige Threading für eine verbesserte Leistung beim Abholen mehrerer Regionen.

• Filterung :

  • Bewerben Sie Filter einschließen und ausschließen, um die Liste der zurückgegebenen AWS -Regionen anzupassen.

Funktionen

Öffentliche Funktionen

• get_region_list
  • Ruft eine Liste von AWS -Regionen ab.
  • Parameter:
    • include_list : Optionale Liste der Regionen, die einbezogen werden sollen.
    • exclude_list : Optionale Liste der zu ausgeschlossenen Regionen.
    • all_regions : Boolean Flag, um alle Regionen zu enthalten (Standard: TRUE).
    • details : Boolean Flag, um detaillierte Informationen zu jeder Region zurückzugeben (Standard: Falsch).
    • profile_name : String, um den Namen des zu verwendenden Profils anzugeben.
  • Rückgaben:
    • Wenn details=True : sortierte Liste der Wörterbücher mit detaillierten Regionsinformationen.
    • Wenn details=False : sortierte Liste der Regionamen als Zeichenfolgen.
  • Erhöhungen:
    • RegionListingError : Wenn ein Fehler während der Abruf oder Verarbeitung von Regionen auftritt.

Verwendung

Dieses Modul ist so konzipiert, dass sie als Teil des wolfsoftware.get-aws-regions Pakets verwendet werden können. Die primäre Funktion, get_region_list , ermöglicht flexible Abrufen und Anpassung von AWS-Regionsinformationen basierend auf benutzerdefinierten Kriterien.

Beispiel

 from wolfsoftware . get_aws_regions import get_region_list

# Example usage: Retrieve all regions and print their names
regions = get_region_list ( details = False )
print ( "AWS Regions:" , regions )

# Example usage: Retrieve detailed information for selected regions
detailed_regions = get_region_list ( include_list = [ 'us-west-1' , 'us-east-1' ], details = True )
for region in detailed_regions :
    print ( f"Region: { region [ 'RegionName' ] } , Location: { region [ 'GeographicalLocation' ] } " )

Notizen

• Stellen Sie sicher, dass AWS -Anmeldeinformationen für den API -Zugriff ordnungsgemäß konfiguriert sind.
• Die Fehlerbehandlung ist integriert, um Ausnahmen während der AWS -Operationen zu verwalten.
• Das Threading wird für effiziente gleichzeitige Operationen verwendet, wenn Region Details abrufen.

Weitere Details und Anpassungsoptionen finden Sie in den Funktionsdocstrings und der Implementierung des Moduls.