Opções de linha de comando - AWS Command Line Interface
Como usar as opções de linha de comandoAWS CLI opções de linha de comando global suportadasUsos comuns das opções de linha de comando

Esta documentação é para a AWS CLI única versão 1. Para obter a documentação relacionada à versão 2 do AWS CLI, consulte o Guia do usuário da versão 2.

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

No 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 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 Especifique os valores dos parâmetros para o AWS CLI.

AWS CLI opções de linha de comando global suportadas

No, AWS CLI 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.

--ca-pacote <string>

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

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

--debug

Uma operação booliana que ativa o registro em log de depuração. AWS CLI Por padrão, 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
--URL do ponto final <string>

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

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

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

As configurações do endpoint estão localizadas em vários locais, como as variáveis de ambiente do sistema ou do usuário, arquivos de AWS configuração locais ou declaradas explicitamente 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 endpoint padrão URL para o respectivo AWS service é 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-paginate

Um switch booleano que desativa as várias chamadas que ele AWS CLI faz automaticamente para receber todos os resultados do comando que cria a paginação da saída. Isso significa que apenas a primeira página da sua saída é exibida.

--no-sign-request

Um switch booleano que desativa a assinatura das HTTP solicitações no endpoint do AWS serviço. Isso evita que as credenciais sejam carregadas.

--no-verify-ssl

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

Atenção

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

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

  • 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>
--consulta <string>

Especifica uma JMESPathconsulta a ser usada na filtragem dos dados de resposta. Para ter mais informações, consulte AWS CLI Saída do filtro.

--região <string>

Especifica para qual AWS região enviar a AWS solicitação 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

Um switch booleano que exibe a versão atual do AWS CLI programa 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                                       |||
...