get aws regions package

Visão geral

Este módulo fornece um método simples para recuperar e processar informações da região da AWS. Este é um componente principal para todas as ferramentas em nossa caixa de ferramentas da AWS.

Características

• Buscando regiões da AWS :

  • Recupere uma lista de todas as regiões da AWS, opcionalmente, incluindo/excluindo regiões com base no status da conta de conta.
  • Suporta buscar informações detalhadas sobre cada região.

• Detalhes da região :

  • Pegue descrições de localização geográfica para regiões específicas da AWS do armazenamento de parâmetros do AWS Systems Manager (SSM).
  • Utiliza rosqueamento simultâneo para um desempenho aprimorado ao buscar vários detalhes da região.

• Filtragem :

  • Aplique incluir e excluir filtros para personalizar a lista de regiões da AWS devolvidas.

Funções

Funções públicas

• get_region_list
  • Recupera uma lista de regiões da AWS.
  • Parâmetros:
    • include_list : Lista opcional de regiões para incluir.
    • exclude_list : lista opcional de regiões para excluir.
    • all_regions : Bandeira booleana para incluir todas as regiões (padrão: true).
    • details : Bandeira booleana para retornar informações detalhadas sobre cada região (padrão: false).
    • profile_name : string para especificar o nome do perfil a ser usado.
  • Retornos:
    • Se details=True : Lista classificada de dicionários contendo informações detalhadas da região.
    • Se details=False : Lista classificada de nomes de regiões como strings.
  • Aumentos:
    • RegionListingError : Se ocorrer um erro durante a recuperação ou processamento da região.

Uso

Este módulo foi projetado para ser usado como parte do pacote wolfsoftware.get-aws-regions . A função principal, get_region_list , permite recuperação flexível e personalização das informações da região da AWS com base em critérios definidos pelo usuário.

Exemplo

 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

• Verifique se as credenciais da AWS estão configuradas corretamente para acesso à API.
• O tratamento de erros é integrado para gerenciar exceções durante as operações da AWS.
• O encadeamento é utilizado para operações simultâneas eficientes ao buscar detalhes da região.

Para obter mais detalhes e opções de personalização, consulte a função DocStrings e a implementação do módulo.