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.

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 Fazer a AWS CLI solicitar comandos.

--cli-binary-format

Especifica como a AWS CLI versão 2 interpreta parâmetros de entrada binários. Pode ter um dos valores a seguir:

• base64: o valor padrão. Um parâmetro de entrada que é digitado como um objeto grande binário (BLOB) aceita uma string codificada em base64. Para passar conteúdo binário verdadeiro, coloque o conteúdo em um arquivo e forneça o caminho e o nome do arquivo com o prefixo fileb:// como o valor do parâmetro. Para passar um texto codificado em base64 contido em um arquivo, forneça o caminho e o nome do arquivo com o prefixo file:// como o valor do parâmetro.

• raw-in-base64-out: padrão para a AWS CLI versão 1. Se o valor da configuração for raw-in-base64-out, os arquivos referenciados usando o prefixo file:// serão lidos como texto e, então, a AWS CLI tenta codificá-lo em binário.

Isso substitui o arquivo de configuração cli_binary_format.

$ aws lambda invoke \
    --cli-binary-format raw-in-base64-out \
    --function-name my-function \
    --invocation-type Event \
    --payload '{ "name": "Bob" }' \
    response.json

Se você fizer referência a um valor binário em um arquivo usando a notação de prefixo fileb://, a AWS CLI sempre esperará que o arquivo tenha um conteúdo binário bruto e não tentará converter o valor.

Se você fizer referência a um valor binário em um arquivo usando a notação de prefixo file://, a AWS CLI tratará o arquivo de acordo com a configuração cli_binary_format atual. Se o valor dessa configuração for base64 (o padrão quando não é definido explicitamente), a AWS CLI esperará que o arquivo contenha texto codificado em base64. Se o valor dessa configuração for raw-in-base64-out, a AWS CLI esperará que o arquivo tenha conteúdo binário bruto.

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

O exemplo de comando a seguir usa um URL personalizado do endpoint do Amazon S3.

$ aws s3 ls --endpoint-url http://localhost:4567

As configurações do endpoint estão em vários locais, como variáveis de ambiente do sistema ou do usuário, arquivos de configuração local da AWS, ou explicitamente declaradas na linha de comando como um parâmetro. As configurações do endpoint da AWS CLI têm precedência na seguinte ordem:

1. A opção da linha de comando --endpoint-url.

2. Se habilitada, a variável de ambiente global AWS_IGNORE_CONFIGURED_ENDPOINT_URLS ou a configuração do perfil ignore_configure_endpoint_urls para ignorar os endpoints personalizados.

3. O valor fornecido por uma variável de ambiente específica do serviço AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Os valores fornecidos pelas variáveis de ambiente AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT e AWS_ENDPOINT_URL.

5. O valor do endpoint específico de serviço fornecido pela configuração endpoint_url em uma seção services do arquivo compartilhado config.

6. O valor fornecido pela configuração endpoint_url em um profile do arquivo compartilhado config.

7. Configurações use_dualstack_endpoint, use_fips_endpoint e endpoint_url.

8. Qualquer URL de endpoint padrão para o respectivo AWS service (Serviço da AWS) é usado por último. 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 da 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 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.

--no-verify-ssl

Por padrão, a AWS CLI usa SSL ao se comunicar com serviços da AWS. Para cada chamada e conexão SSL, a AWS CLI verifica os certificados SSL. O uso dessa opção substitui o comportamento padrão de verificação de certificados SSL.

Atenção

Essa opção não é uma prática recomendada. Se você usa --no-verify-ssl, o tráfego entre seu cliente e os serviços da AWS não está mais protegido. Isso significa que o tráfego é um risco de segurança e está vulnerável a explorações man-in-the-middle. Se estiver tendo problemas com certificados, é melhor resolvê-los. Para ver as etapas de resolução de problemas de certificados, consulte Erros de certificado SSL.

--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 AWS CLI Saída do filtro.

--region <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 da Amazon Web Services.

--version

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