get aws regions package

Обзор

Этот модуль предоставляет простой метод для извлечения и обработки информации о регионе AWS. Это основной компонент для всех инструментов в нашем наборе инструментов AWS.

Функции

• Привлечение регионов AWS :

  • Получите список всех регионов AWS, при желании, включая/исключая регионы на основе статуса выбора учетной записи.
  • Поддерживает получение подробной информации о каждом регионе.

• Детали региона :

  • Описание географического местоположения. Для конкретных регионов AWS из хранилища параметров AWS Systems Manager (SSM).
  • Использует одновременную резьбу для повышения производительности при получении нескольких деталей региона.

• Фильтрация :

  • Применить Включите и исключите фильтры для настройки списка возвращенных регионов AWS.

Функции

Публичные функции

• get_region_list
  • Получает список регионов AWS.
  • Параметры:
    • include_list : необязательный список регионов для включения.
    • exclude_list : необязательный список регионов, чтобы исключить.
    • all_regions : логический флаг, чтобы включить все регионы (по умолчанию: true).
    • details : логический флаг, чтобы вернуть подробную информацию о каждом регионе (по умолчанию: false).
    • profile_name : String, чтобы указать имя профиля для использования.
  • Возвращает:
    • Если 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 и реализацию модуля.