get aws regions package

ภาพรวม

โมดูลนี้ให้วิธีง่ายๆในการดึงและประมวลผลข้อมูลภูมิภาค AWS นี่คือองค์ประกอบหลักสำหรับเครื่องมือทั้งหมดในกล่องเครื่องมือ AWS ของเรา

คุณสมบัติ

• ดึงภูมิภาค AWS :

  • ดึงรายการของภูมิภาค AWS ทั้งหมดเป็นทางเลือกรวมถึง/ยกเว้นภูมิภาคตามสถานะการเลือกใช้บัญชี
  • สนับสนุนการดึงข้อมูลรายละเอียดเกี่ยวกับแต่ละภูมิภาค

• รายละเอียดภูมิภาค :

  • ดึงคำอธิบายตำแหน่งทางภูมิศาสตร์สำหรับภูมิภาค AWS เฉพาะจากการจัดเก็บพารามิเตอร์ AWS Systems Manager (SSM)
  • ใช้เกลียวพร้อมกันเพื่อประสิทธิภาพที่เพิ่มขึ้นเมื่อดึงรายละเอียดหลายภูมิภาค

• การกรอง :

  • สมัครรวมและยกเว้นตัวกรองเพื่อปรับแต่งรายการของภูมิภาค AWS ที่ส่งคืน

ฟังก์ชั่น

ฟังก์ชั่นสาธารณะ

• get_region_list
  • ดึงรายการภูมิภาค AWS
  • พารามิเตอร์:
    • include_list : รายการเพิ่มเติมของภูมิภาคที่จะรวม
    • exclude_list : รายการเพิ่มเติมของภูมิภาคที่จะยกเว้น
    • all_regions : ธงบูลีนเพื่อรวมทุกภูมิภาค (ค่าเริ่มต้น: จริง)
    • details : ธงบูลีนเพื่อส่งคืนข้อมูลรายละเอียดเกี่ยวกับแต่ละภูมิภาค (ค่าเริ่มต้น: เท็จ)
    • profile_name : สตริงเพื่อระบุชื่อของโปรไฟล์ที่จะใช้
  • ผลตอบแทน:
    • หาก details=True : รายการพจนานุกรมที่มีข้อมูลภูมิภาคโดยละเอียด
    • ถ้า details=False : รายการที่เรียงลำดับของชื่อภูมิภาคเป็นสตริง
  • ยกขึ้น:
    • RegionListingError : หากเกิดข้อผิดพลาดในระหว่างการดึงภูมิภาคหรือการประมวลผล

การใช้งาน

โมดูลนี้ได้รับการออกแบบให้ใช้เป็นส่วนหนึ่งของแพ็คเกจ wolfsoftware.get-aws-regions ฟังก์ชั่นหลัก get_region_list ช่วยให้การดึงข้อมูลที่ยืดหยุ่นและการปรับแต่งข้อมูลภูมิภาค AWS ตามเกณฑ์ที่ผู้ใช้กำหนด

ตัวอย่าง

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

หมายเหตุ

• ตรวจสอบให้แน่ใจว่ามีการกำหนดค่าข้อมูลรับรอง AWS อย่างเหมาะสมสำหรับการเข้าถึง API
• การจัดการข้อผิดพลาดถูกรวมเข้าด้วยกันเพื่อจัดการข้อยกเว้นในระหว่างการดำเนินการ AWS
• การทำเกลียวถูกใช้สำหรับการดำเนินงานที่มีประสิทธิภาพพร้อมกันเมื่อดึงรายละเอียดภูมิภาค

สำหรับรายละเอียดเพิ่มเติมและตัวเลือกการปรับแต่งให้ดูฟังก์ชั่นเอกสารและการใช้งานของโมดูล