get aws regions package

Descripción general

Este módulo proporciona un método simple para recuperar y procesar la información de la región de AWS. Este es un componente central para todas las herramientas en nuestra caja de herramientas AWS.

Características

• Obtener regiones de AWS :

  • Recupere una lista de todas las regiones de AWS, opcionalmente incluyendo/excluyendo regiones en función del estado de opción de opción de cuenta.
  • Admite obtener información detallada sobre cada región.

• Detalles de la región :

  • Obtenga descripciones de ubicación geográfica para regiones específicas de AWS de la tienda de parámetros de AWS Systems Manager (SSM).
  • Utiliza subprocesos concurrentes para un rendimiento mejorado al obtener detalles de múltiples regiones.

• Filtrado :

  • Aplicar incluir y excluir filtros para personalizar la lista de regiones de AWS devueltas.

Funciones

Funciones públicas

• get_region_list
  • Recupera una lista de regiones de AWS.
  • Parámetros:
    • include_list : lista opcional de regiones para incluir.
    • exclude_list : lista opcional de regiones para excluir.
    • all_regions : Boolean Flag para incluir todas las regiones (predeterminadas: verdaderas).
    • details : Flagador booleano para devolver información detallada sobre cada región (predeterminada: falso).
    • profile_name : cadena para especificar el nombre del perfil a usar.
  • Devoluciones:
    • If details=True : Lista ordenada de diccionarios que contienen información de región detallada.
    • If details=False : Lista ordenada de nombres de región como cadenas.
  • Aumentos:
    • RegionListingError : si se produce un error durante la recuperación o procesamiento de la región.

Uso

Este módulo está diseñado para ser utilizado como parte del paquete wolfsoftware.get-aws-regions . La función principal, get_region_list , permite la recuperación flexible y la personalización de la información de la región de AWS basada en criterios definidos por el usuario.

Ejemplo

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

Notas

• Asegúrese de que las credenciales de AWS estén configuradas correctamente para el acceso a la API.
• El manejo de errores está integrado para administrar excepciones durante las operaciones de AWS.
• El subproceso se utiliza para operaciones concurrentes eficientes al obtener detalles de la región.

Para obtener más detalles y opciones de personalización, consulte las documentos de la función y la implementación del módulo.