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

Opções de linha de comando

Na AWS CLI, as opções de linha de comando são parâmetros globais que você pode usar para substituir as configurações padrão, qualquer configuração de perfil correspondente ou a 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.

Como usar as opções de linha de comando

As opções de linha de comando são, na maioria, strings simples, como o nome do perfil profile1 no exemplo a seguir:

$ aws s3 ls --profile profile1 example-bucket-1 example-bucket-2 ...

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. Para obter detalhes sobre tipos de argumento e formatação de parâmetros, consulte Especificar valores de parâmetro para a AWS CLI Tipos comuns de parâmetros da AWS CLI.

A AWS CLI comporta opções de linha de comando globais

Na AWS CLI, você pode usar as opções de linha de comando a seguir para substituir as configurações padrão, qualquer configuração de perfil correspondente ou a configuração de variável de ambiente para esse único comando.

--ca-bundle <string>

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

Se definida, essa opção substituirá o valor da configuração de perfil ca_bundle e AWS_CA_Bundle da variável de ambiente.

--cli-auto-prompt

Habilita o modo de prompt automático para um único comando. Conforme mostrado nos exemplos a seguir, 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 substituirá o valor da variável de ambiente aws_cli_auto_prompt e da configuração de perfil cli_auto_prompt.

Para obter informações sobre o recurso de prompt automático da AWS CLI versão 2, consulte Como fazer a AWS CLI solicitar comandos.

--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.

--color <string>

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

--debug

Uma operação booliana que ativa o registro em log de depuração. Por padrão, a AWS CLI fornece informações limpas sobre quaisquer sucessos ou falhas em relação aos resultados do comando na saída do comando. A opção --debug fornece os logs completos do Python. Isso inclui informações adicionais de diagnóstico de stderr sobre a operação do comando que podem ser úteis para a solução de problemas de um comando que gera resultados inesperados. Para visualizar facilmente os logs de depuração, sugerimos enviar os logs para um arquivo para que seja possível pesquisar as informações de forma mais fácil. Isso pode ser feito de uma das formas a seguir.

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

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

Para enviar ambas a saída e as informações de diagnóstico de stderr, anexe &> debug.txt, onde debug.txt é o nome que você deseja usar para o seu 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 serviços da AWS para hospedar um endpoint diretamente dentro de 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, consulteRegiões e endpoints da AWS na Referência geral do Amazon Web Services.

--no-cli-auto-prompt

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

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

Essa opção substituirá o valor da variável de ambiente aws_cli_auto_prompt e da configuração de perfil cli_auto_prompt.

Para obter informações sobre o recurso de prompt automático da AWS CLI versão 2, consulte Como fazer a AWS CLI solicitar comandos.

--no-cli-pager

Uma opção booleana que desabilita o uso de uma paginação para a saída do comando.

--no-paginate

Uma opção booleana que desabilita as chamadas múltiplas que a AWS CLI faz automaticamente para receber todos os resultados de comandos que criam a paginação da saída. Isso significa que apenas a primeira página da sua 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.

--output <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.

  • yaml-stream: a saída é transmitida e formatada como uma string YAML. A transmissão possibilita um manuseio mais rápido de tipos de dados grandes.

  • text: a saída é formatada como várias linhas de valores de string separados por tabulação. Isso pode ser útil para passar a saída para 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 nomeado para usar esse comando. Para configurar perfis nomeados adicionais, você pode usar o comando aws configure com a opção --profile.

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

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

--region <string>

Especifica para qual região da AWS enviar a solicitação da AWS desse comando. Para obter uma lista de regiões que você pode especificar, consulte a página Regiões e endpoints da AWS na Referência geral da 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.

Usos comuns das opções de linha de comando

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. Nos exemplos a seguir, executamos o comando describe-instances em cada região até descobrirmos em qual delas nossa instância está.

$ 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 ||| ...