Este pacote fornece uma interface de linha de comando unificada para Amazon Web Services.
Ir para:
Este README é para a AWS CLI versão 1. Se você estiver procurando informações sobre a AWS CLI versão 2, visite a filial v2.
O pacote aws-cli funciona em versões Python:
Em 30/05/2022, o suporte para Python 3.6 foi encerrado. Isso segue o fim do suporte da Python Software Foundation para o tempo de execução que ocorreu em 23/12/2021.
Em 13/12/2023, o suporte para Python 3.7 foi encerrado. Isso segue o fim do suporte da Python Software Foundation para o tempo de execução que ocorreu em 27/06/2023. Para obter mais informações, consulte esta postagem do blog.
Atenção!
Recomendamos que todos os clientes monitorem regularmente o site Boletins de segurança da Amazon Web Services para obter quaisquer boletins de segurança importantes relacionados ao aws-cli.
A versão 1 da AWS CLI foi disponibilizada em 02/09/2013 e atualmente está na fase de suporte completo do ciclo de vida de disponibilidade.
Para obter informações sobre manutenção e suporte para versões principais do SDK e suas dependências subjacentes, consulte a seção Política de manutenção no AWS SDKs and Tools Shared Configuration and Credentials Reference Guide .
A instalação da AWS CLI e de suas dependências usa uma variedade de recursos de empacotamento fornecidos por pip
e setuptools
. Para garantir uma instalação tranquila, é recomendado usar:
pip
: 9.0.2 ou superiorsetuptools
: 36.2.0 ou superior A maneira mais segura de instalar a AWS CLI é usar pip em um virtualenv
:
$ python -m pip instalar awscli
ou, se você não estiver instalando em um virtualenv
, para instalar globalmente:
$ sudo python -m pip instalar awscli
ou para seu usuário:
$ python -m pip install --user awscli
Se você tiver o pacote aws-cli instalado e quiser atualizar para a versão mais recente, poderá executar:
$ python -m pip install --upgrade awscli
Isso instalará o pacote aws-cli, bem como todas as dependências.
Observação
No macOS, se você vir um erro relacionado à versão six
que acompanha distutils
no El Capitan, use a opção --ignore-installed
:
$ sudo python -m pip install awscli --ignore-installed seis
No Linux e no Mac OS, a AWS CLI pode ser instalada usando um instalador incluído. A AWS CLI também pode ser instalada no Windows por meio de um instalador MSI.
Se você quiser executar a ramificação develop
da AWS CLI, consulte a seção Versão de desenvolvimento do guia de contribuição.
Consulte a seção de instalação do Guia do usuário da AWS CLI para obter mais informações.
Antes de usar a AWS CLI, você precisa configurar suas credenciais da AWS. Você pode fazer isso de várias maneiras:
A maneira mais rápida de começar é executar o comando aws configure
:
$ aws configurar ID da chave de acesso da AWS: MYACCESSKEY Chave de acesso secreta da AWS: MYSECRETKEY Nome da região padrão [us-west-2]: us-west-2 Formato de saída padrão [Nenhum]: json
Para usar variáveis de ambiente, faça o seguinte:
$ exportar AWS_ACCESS_KEY_ID=$ exportar AWS_SECRET_ACCESS_KEY=
Para usar o arquivo de credenciais compartilhadas, crie um arquivo formatado INI como este:
[padrão] aws_access_key_id=MYACCESSKEY aws_secret_access_key=MYSECRETKEY [testando] aws_access_key_id=MYACCESSKEY aws_secret_access_key=MYSECRETKEY
e coloque-o em ~/.aws/credentials
(ou em %UserProfile%.aws/credentials
no Windows). Se desejar colocar o arquivo de credenciais compartilhadas em um local diferente do especificado acima, você precisará informar ao aws-cli onde encontrá-lo. Faça isso definindo a variável de ambiente apropriada:
$ exportar AWS_SHARED_CREDENTIALS_FILE=/caminho/para/shared_credentials_file
Para usar um arquivo de configuração, crie um arquivo formatado INI como este:
[padrão] aws_access_key_id=aws_secret_access_key= # Opcional, para definir a região padrão para este perfil. região = nós-oeste-1 [teste de perfil] aws_access_key_id= aws_secret_access_key= região=us-west-2
e coloque-o em ~/.aws/config
(ou em %UserProfile%.awsconfig
no Windows). Se desejar colocar o arquivo de configuração em um local diferente daquele especificado acima, você precisará informar à AWS CLI onde encontrá-lo. Faça isso definindo a variável de ambiente apropriada:
$ exportar AWS_CONFIG_FILE=/caminho/para/arquivo_config
Como você pode ver, você pode ter vários profiles
definidos no arquivo de credenciais compartilhadas e no arquivo de configuração. Você pode então especificar qual perfil usar usando a opção --profile
. Se nenhum perfil for especificado, o perfil default
será usado.
No arquivo de configuração, exceto para o perfil padrão, você deve prefixar cada seção de configuração de um grupo de perfis com profile
. Por exemplo, se você tiver um perfil chamado "testing", o cabeçalho da seção seria [profile testing]
.
A opção final para credenciais é altamente recomendada se você estiver usando a AWS CLI em uma instância EC2. As funções IAM são uma ótima maneira de instalar credenciais automaticamente em sua instância. Se você estiver usando funções do IAM, a AWS CLI as encontrará e usará automaticamente.
Além das credenciais, diversas outras variáveis podem ser configuradas com variáveis de ambiente, entradas de arquivo de configuração ou ambas. Consulte o Guia de referência de credenciais e configuração compartilhada de ferramentas e SDKs da AWS para obter mais informações.
Para obter mais informações sobre opções de configuração, consulte o tópico Variáveis de configuração da AWS CLI. Você também pode acessar este tópico na AWS CLI executando aws help config-vars
.
Um comando AWS CLI tem a seguinte estrutura:
$ aws[opções e parâmetros]
Por exemplo, para listar os buckets S3, o comando seria:
$ aws s3ls
Para visualizar a documentação de ajuda, use um dos seguintes:
$ aws ajuda $ awsajuda $ aws ajuda
Para obter a versão da AWS CLI:
$ aws --versão
Para ativar a saída de depuração:
$ aws --debug
Você pode ler mais informações no capítulo Usando a AWS CLI do Guia do usuário da AWS CLI.
O pacote aws-cli inclui um recurso de conclusão de comando para sistemas do tipo Unix. Este recurso não é instalado automaticamente, então você precisa configurá-lo manualmente. Para saber mais, leia o tópico de conclusão de comando da AWS CLI.
A melhor forma de interagir com nossa equipe é através do GitHub. Você pode abrir um problema e escolher um de nossos modelos para orientação, relatórios de bugs ou solicitações de recursos.
Você pode encontrar ajuda da comunidade no Stack Overflow com a tag aws-cli ou no AWS Discussion Forum for CLI. Se você tiver um plano de suporte com o AWS Support, também poderá criar um novo caso de suporte.
Verifique se há problemas semelhantes abertos antes de abrir outro.
A AWS CLI implementa APIs de serviços da AWS. Para questões gerais relacionadas aos serviços ou suas limitações, os Fóruns de discussão da Amazon Web Services podem ser úteis.