get aws regions package

Ringkasan

Modul ini menyediakan metode sederhana untuk mengambil dan memproses informasi wilayah AWS. Ini adalah komponen inti untuk semua alat di kotak alat AWS kami.

Fitur

• Mengambil daerah AWS :

  • Ambil daftar semua wilayah AWS, secara opsional termasuk/tidak termasuk wilayah berdasarkan status opt-in akun.
  • Mendukung mengambil informasi terperinci tentang masing -masing wilayah.

• Detail Wilayah :

  • Ambil deskripsi lokasi geografis untuk daerah AWS spesifik dari toko parameter AWS Systems Manager (SSM).
  • Memanfaatkan threading bersamaan untuk peningkatan kinerja saat mengambil beberapa detail wilayah.

• Penyaringan :

  • Terapkan termasuk dan mengecualikan filter untuk menyesuaikan daftar daerah AWS yang dikembalikan.

Fungsi

Fungsi publik

• get_region_list
  • Mengambil daftar daerah AWS.
  • Parameter:
    • include_list : Daftar daerah opsional untuk dimasukkan.
    • exclude_list : Daftar Daerah Opsional untuk dikecualikan.
    • all_regions : Bendera Boolean untuk memasukkan semua wilayah (default: true).
    • details : Bendera Boolean untuk mengembalikan informasi terperinci tentang masing -masing wilayah (default: false).
    • profile_name : String untuk menentukan nama profil yang akan digunakan.
  • Kembali:
    • Jika details=True : Daftar kamus yang diurutkan yang berisi informasi wilayah terperinci.
    • Jika details=False : Daftar nama wilayah yang diurutkan sebagai string.
  • Naiknya:
    • RegionListingError : Jika terjadi kesalahan selama pengambilan wilayah atau pemrosesan.

Penggunaan

Modul ini dirancang untuk digunakan sebagai bagian dari paket wolfsoftware.get-aws-regions . Fungsi utama, get_region_list , memungkinkan pengambilan fleksibel dan kustomisasi informasi AWS Wilayah berdasarkan kriteria yang ditentukan pengguna.

Contoh

 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' ] } " )

Catatan

• Pastikan kredensial AWS dikonfigurasi dengan benar untuk akses API.
• Penanganan kesalahan diintegrasikan untuk mengelola pengecualian selama operasi AWS.
• Threading digunakan untuk operasi bersamaan yang efisien saat mengambil detail wilayah.

Untuk detail lebih lanjut dan opsi kustomisasi, lihat Function Docstrings dan implementasi modul.