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

Opções de linha de comando

Você pode usar as opções de linha de comando a seguir para substituir as definições de configuração padrão para um ú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.

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

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

--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, consulte Regiões e endpoints da AWS no Referência geral do Amazon Web Services.

--depuração

Uma operação booliana que ativa o registro em log de depuração. Isso inclui informações adicionais de diagnóstico sobre a operação do comando que podem ser úteis para a solução de problemas de um comando que gera resultados inesperados.

--no-paginate

Uma operação booliana que desativa a paginação automática da saída.

--query <string>

Especifica uma consulta JMESPath para uso na filtragem dos dados de resposta. Para obter mais informações, consulte Como filtrar a saída com a opção --query.

--versão

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

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

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

--ca-bundle <string>

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

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

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

Quando você fornece uma ou mais dessas opções como parâmetros da linha de comando, elas substituem a configuração padrão, qualquer configuração de perfil correspondente ou configuração de variável de ambiente para esse único comando.

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 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 você não tem certeza em relação à região em que a sua instância está sendo executada, você pode executar o comando describe-instances em cada região até encontrá-la, da maneira a seguir. 

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