get aws regions package

概要

このモジュールは、AWSリージョン情報を取得および処理するための簡単な方法を提供します。これは、AWSツールボックスのすべてのツールのコアコンポーネントです。

特徴

• AWS地域の取得：

  • アカウントのオプトインステータスに基づいて領域を含む/除外するすべてのAWS地域のリストを取得します。
  • 各地域に関する詳細情報の取得をサポートします。

• 地域の詳細：

  • AWS Systems Manager（SSM）パラメーターストアの特定のAWS領域の地理的位置説明を取得します。
  • 複数の領域の詳細を取得するときに、パフォーマンスを向上させるために、同時スレッドを使用します。

• フィルタリング：

  • フィルターを含めて除外して、返されたAWS領域のリストをカスタマイズします。

関数

パブリック機能

• get_region_list
  • AWS地域のリストを取得します。
  • パラメーター：
    • include_list ：含める領域のオプションリスト。
    • exclude_list ：除外する地域のオプションリスト。
    • all_regions ：すべての領域を含むブールフラグ（デフォルト：真）。
    • details ：各地域に関する詳細情報を返すブールフラグ（デフォルト：false）。
    • 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操作中に例外を管理するために統合されています。
• スレッドは、領域の詳細を取得するときに効率的な同時操作に使用されます。

詳細とカスタマイズオプションについては、関数Docstringsとモジュールの実装を参照してください。