Opções de linha de comando - AWS Command Line Interface

O Python 2.7, 3.4 e 3.5 está sendo defasado para o AWS CLI versão 1. Para obter mais informações, consulte a AWS CLI versão 1 seção de Sobre as AWS CLI versões.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Opções de linha de comando

Você pode usar as seguintes opções de linha de comando para substituir as configurações padrão, qualquer configuração de perfil correspondente ou configuração de variável de ambiente para esse único comando. Você não pode usar opções de linha de comando para especificar diretamente credenciais, embora seja possível especificar qual perfil usar. Cada opção que obtém um argumento requer com um espaço ou sinal de igual (=) separando o argumento do nome da opção. Se o valor do argumento for uma string que contenha um espaço, coloque o argumento entre aspas.

Os tipos de argumento (por exemplo, string, booliano) para cada opção da linha de comando são descritos em detalhes em Especificar valores de parâmetro para a AWS CLI Tipos comuns de parâmetros da AWS CLI.

--ca-bundle; <string>

Especifica o pacote de certificados da autoridade de certificação (CA) a ser usado ao verificar certificados SSL.

--cli-auto-prompt;
Esse recurso está disponível somente na AWS CLI versão 2.

O recurso a seguir só estará disponível se você usar a AWS CLI versão 2. Ele não estará disponível se você executar a AWS CLI versão 1. Para obter informações sobre como instalar a versão 2, consulte Instalar, atualizar e desinstalar aAWS CLI versão 2.

Habilita o modo de aviso automático para um único comando. Como os exemplos a seguir mostram, você pode especificá-lo a qualquer momento.

$ aws --cli-auto-prompt $ aws dynamodb --cli-auto-prompt $ aws dynamodb describe-table --cli-auto-prompt

Essa opção substitui a variável de aws_cli_auto_prompt ambiente e a configuração cli_auto_prompt de perfil.

Para obter informações sobre o recurso de aviso AWS CLI versão 2 automático, consulte Ter a AWS CLI solicitando comandos a você.

--cli-connect-timeout; <integer>

Especifica o tempo de conexão de soquete máximo em segundos. Se o valor for definido como zero (0), a conexão de soquete aguardará indefinidamente (será bloqueada) e não atingirá o tempo limite.

--cli-read-timeout; <integer>

Especifica o tempo de leitura de soquete máximo em segundos. Se o valor for definido como zero (0), a leitura do soquete aguardará indefinidamente (será bloqueada) e não atingirá o tempo limite.

--cor <string>

Especifica o suporte para saída de cores. Os valores válidos são on off, e auto. O valor padrão é auto.

--depuração

Uma operação booliana que ativa o registro em log de depuração. A AWS CLI , por padrão, fornece informações limpas sobre todos os êxitos ou falhas relacionados aos resultados do comando na saída do comando. A --debug opção fornece os logs completos do Python. Isso inclui informações adicionais stderr de diagnóstico sobre a operação do comando que podem ser úteis ao solucionar problemas com os quais um comando fornece resultados inesperados. Para visualizar facilmente logs de depuração, sugerimos enviar os logs para um arquivo a fim de facilitar a pesquisa das informações. Você pode fazer isso usando uma das seguintes opções.

Para enviar somente as informações stderr de diagnóstico, acrescente , 2> debug.txt em que debug.txt é o nome que você deseja usar para o arquivo de depuração:

$ aws servicename commandname options --debug 2> debug.txt

Para enviar as informações de saída e stderr diagnóstico, acrescente , &> debug.txt em que debug.txt é o nome que você deseja usar para o arquivo de depuração:

$ aws servicename commandname options --debug &> debug.txt
--endpoint-url <string>

Especifica o URL para o qual enviar a solicitação. Para a maioria dos comandos, a AWS CLI determina automaticamente o URL com base no serviço selecionado e na região da AWS especificada. No entanto, alguns comandos exigem que você especifique um URL específico para a conta. Você também pode configurar alguns AWS serviços da para hospedar um endpoint diretamente em sua VPC privada, que talvez precise ser especificada.

Para obter uma lista dos endpoints de serviços padrão disponíveis em cada região, consulte Regiões e endpoints da AWS no Referência geral do Amazon Web Services.

--no-cli-auto-prompt;
Esse recurso está disponível somente na AWS CLI versão 2.

O recurso a seguir só estará disponível se você usar a AWS CLI versão 2. Ele não estará disponível se você executar a AWS CLI versão 1. Para obter informações sobre como instalar a versão 2, consulte Instalar, atualizar e desinstalar aAWS CLI versão 2.

Desabilita o modo de aviso automático para um único comando.

$ aws dynamodb describe-table --table-name Table1 --no-cli-auto-prompt

Essa opção substitui a variável de aws_cli_auto_prompt ambiente e a configuração cli_auto_prompt de perfil.

Para obter informações sobre o recurso de aviso AWS CLI versão 2 automático, consulte Ter a AWS CLI solicitando comandos a você.

--no-cli-pager;

Uma operação booliana que desabilita o uso de um paginador para a saída do comando.

--no-paginate

Uma operação booliana que desabilita as várias chamadas que o AWS CLI faz automaticamente para receber todos os resultados do comando que cria a paginação da saída. Isso significa que somente a primeira página da saída é exibida.

--no-sign-request

Uma operação booliana que desativa a assinatura de solicitações HTTP para o endpoint de serviço da AWS Isso evita que as credenciais sejam carregadas.

--resultado <string>

Especifica o formato de saída a ser usado para este comando. Você pode especificar qualquer um dos seguintes valores:

  • json – a saída é formatada como uma string JSON.

  • yaml – a saída é formatada como uma string YAML. (Disponível somente na AWS CLI versão 2.)

  • yaml-stream: a saída é transmitida e formatada como uma string YAML. O streaming permite um processamento mais rápido de grandes tipos de dados. (Disponível somente na AWS CLI versão 2.)

  • text – a saída é formatada como várias linhas de valores de string separados por tabulação. Isso pode ser útil para transmitir a saída a um processador de texto, como grep, sed ou awk.

  • table – a saída é formatada como uma tabela usando os caracteres +|- para formar as bordas da célula. Geralmente, a informação é apresentada em um formato "amigável", que é muito mais fácil de ler do que outros, mas não tão útil programaticamente.

--profile <string>

Especifica o perfil Perfis nomeados nomeado para usar este comando. Para configurar perfis nomeados adicionais, você pode usar o comando aws configure com a opção --profile

$ aws configure --profile <profilename>
--consulta <string>

Especifica uma JMESPath consulta a ser usada na filtragem dos dados de resposta. Para obter mais informações, consulte Filtragem da AWS CLI saída.

--região <string>

Especifica para qual região da AWS enviar a solicitação da AWS desse comando. Para obter uma lista de todas as regiões que você pode especificar, consulte Regiões e endpoints da AWS no Referência geral do Amazon Web Services.

--versão

Uma operação booliana que exibe a versão atual do programa de AWS CLI que está em execução.

Os usos comuns das opções de linha de comando incluem a verificação de seus recursos em várias regiões da AWS e a alteração do formato de saída para legibilidade ou a facilidade de uso ao criar scripts. Por exemplo, se não tiver certeza em qual região sua instância está executando, você poderá executar o comando describe-instances em cada região até encontrá-la, da seguinte forma.

$ aws ec2 describe-instances --output table --region us-east-1 ------------------- |DescribeInstances| +-----------------+ $ aws ec2 describe-instances --output table --region us-west-1 ------------------- |DescribeInstances| +-----------------+ $ aws ec2 describe-instances --output table --region us-west-2 ------------------------------------------------------------------------------ | DescribeInstances | +----------------------------------------------------------------------------+ || Reservations || |+-------------------------------------+------------------------------------+| || OwnerId | 012345678901 || || ReservationId | r-abcdefgh || |+-------------------------------------+------------------------------------+| ||| Instances ||| ||+------------------------+-----------------------------------------------+|| ||| AmiLaunchIndex | 0 ||| ||| Architecture | x86_64 ||| ...

Os tipos de argumento (por exemplo, string, booliano) para cada opção da linha de comando são descritos em detalhes em Especificar valores de parâmetro para a AWS CLI Tipos comuns de parâmetros da AWS CLI.