Acessando ajuda e recursos para o AWS CLI - AWS Command Line Interface

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

Acessando ajuda e recursos para o AWS CLI

Este tópico descreve como acessar o conteúdo de ajuda para o AWS Command Line Interface (AWS CLI).

O comando de ajuda integrado da AWS CLI

Você pode obter ajuda com qualquer comando ao usar o AWS Command Line Interface (AWS CLI). Para fazer isso, basta digitar help no final de um nome do comando.

Por exemplo, o comando a seguir exibe ajuda para as AWS CLI opções gerais e os comandos de nível superior disponíveis.

$ aws help

O comando a seguir exibe os comandos específicos disponíveis do Amazon Elastic Compute Cloud (AmazonEC2).

$ aws ec2 help

O exemplo a seguir mostra ajuda detalhada para a EC2 DescribeInstances operação da Amazon. A ajuda inclui descrições de seus parâmetros de entrada, filtros disponíveis, e o que é incluído como saída. Ela também inclui exemplos que mostram como digitar as variações comuns do comando.

$ aws ec2 describe-instances help

A ajuda para cada comando é dividida em seis seções:

Nome

O nome do comando.

NAME describe-instances -
Descrição

Uma descrição da API operação que o comando invoca.

DESCRIPTION Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. ...
Resumo

A sintaxe básica para usar o comando e suas opções. Se uma opção estiver entre colchetes, significa que ela é opcional, tem um valor padrão ou tem uma opção alternativa que você pode usar.

SYNOPSIS describe-instances [--dry-run | --no-dry-run] [--instance-ids <value>] [--filters <value>] [--cli-input-json <value>] [--starting-token <value>] [--page-size <value>] [--max-items <value>] [--generate-cli-skeleton]

Por exemplo, describe-instances tem um comportamento padrão que descreve todas as instâncias na conta atual e AWS na região. Se preferir, você poderá especificar uma lista de instance-ids para descrever uma ou mais instâncias. O dry-run é um sinalizador booliano opcional que não tem um valor. Para usar um sinalizador booliano, especifique um valor apresentado, nesse caso --dry-run ou --no-dry-run. Da mesma forma, --generate-cli-skeleton não tem um valor. Se houver condições no uso de uma opção, elas serão descritas na seção OPTIONS ou mostradas nos exemplos.

Opções

A descrição de cada uma das opções mostradas na sinopse.

OPTIONS --dry-run | --no-dry-run (boolean) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRun- Operation . Otherwise, it is UnauthorizedOperation . --instance-ids (list) One or more instance IDs. Default: Describes all your instances. ...
Exemplos

Os exemplos que mostram o uso do comando e suas opções. Se nenhum exemplo estiver disponível para um comando ou caso de uso necessário, solicite um usando o link de feedback nesta página ou na referência de AWS CLI comando na página de ajuda do comando.

EXAMPLES To describe an Amazon EC2 instance Command: aws ec2 describe-instances --instance-ids i-5203422c To describe all instances with the instance type m1.small Command: aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small" To describe all instances with an Owner tag Command: aws ec2 describe-instances --filters "Name=tag-key,Values=Owner" ...
Saída

As descrições de cada um dos campos e os tipos de dados incluídos na resposta da AWS.

Para describe-instances, a saída é uma lista de objetos de reserva, cada um com vários campos e objetos que contêm informações sobre as instâncias associadas a ele. Essas informações vêm da APIdocumentação do tipo de dados de reserva usado pela AmazonEC2.

OUTPUT Reservations -> (list) One or more reservations. (structure) Describes a reservation. ReservationId -> (string) The ID of the reservation. OwnerId -> (string) The ID of the AWS account that owns the reservation. RequesterId -> (string) The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling). Groups -> (list) One or more security groups. (structure) Describes a security group. GroupName -> (string) The name of the security group. GroupId -> (string) The ID of the security group. Instances -> (list) One or more instances. (structure) Describes an instance. InstanceId -> (string) The ID of the instance. ImageId -> (string) The ID of the AMI used to launch the instance. State -> (structure) The current state of the instance. Code -> (integer) The low byte represents the state. The high byte is an opaque internal value and should be ignored. ...

Quando AWS CLI renderiza a saída emJSON, ela se torna uma matriz de objetos de reserva, semelhante ao exemplo a seguir.

{ "Reservations": [ { "OwnerId": "012345678901", "ReservationId": "r-4c58f8a0", "Groups": [], "RequesterId": "012345678901", "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "ec2-52-74-16-12.us-west-2.compute.amazonaws.com", "State": { "Code": 16, "Name": "running" }, ...

Cada objeto de reserva contém campos que descrevem a reserva e uma série de objetos de instância, cada um com seus próprios campos (por exemplo, PublicDnsName) e objetos (por exemplo, State) que os descrevem.

Usuários do Windows

Você pode usar pipe (|) na saída do comando de ajuda do comando more para visualizar o arquivo de ajuda uma página por vez. Pressione a barra de espaço ou PgDnpara ver mais do documento e q sair.

C:\> aws ec2 describe-instances help | more

AWS CLI guia de referência

Os arquivos de ajuda contêm links que não podem ser visualizados a partir da linha de comando nem é possível navegar até eles a partir dela. Você pode visualizar e interagir com esses links usando o guia de referência on-line da AWS CLI versão 1, guia de . A referência também contém o conteúdo de ajuda para todos os AWS CLI comandos. As descrições são apresentadas para facilitar a navegação e a visualização em dispositivos móveis, tablets e telas de desktop.

APIdocumentação

Todos os comandos no AWS CLI correspondem às solicitações feitas ao público AWS de um serviçoAPI. Cada serviço com um público API tem uma API referência que pode ser encontrada na página inicial do serviço no site de AWS documentação. O conteúdo de uma API referência varia de acordo com a forma como API ela é construída e qual protocolo é usado. Normalmente, uma API referência contém informações detalhadas sobre as operações suportadas peloAPI, os dados enviados de e para o serviço e quaisquer condições de erro que o serviço possa relatar.

APISeções de documentação
  • Ações: informações detalhadas sobre cada operação e seus parâmetros (incluindo restrições de tamanho ou conteúdo e valores padrão). Ela lista os erros que podem ocorrer nessa operação. Cada operação corresponde a um subcomando no AWS CLI.

  • Tipos de dados: informações detalhadas sobre estruturas que um comando pode exigir como um parâmetro ou retornar em resposta a uma solicitação.

  • Parâmetros comuns: informações detalhadas sobre os parâmetros que são compartilhados por toda a ação para o serviço.

  • Erros comuns: informações detalhadas sobre erros que podem ser retornados por todas as operações de um serviço.

O nome e a disponibilidade de cada seção podem variar de acordo com o serviço.

Específico do serviço CLIs

Alguns serviços têm uma separação CLI que data de antes da criação de um único AWS CLI para funcionar com todos os serviços. Esses serviços específicos CLIs têm documentação separada vinculada à página de documentação do serviço. A documentação para serviços específicos CLIs não se aplica ao. AWS CLI

Solucionar de problemas de erros

Para obter ajuda para diagnosticar e corrigir AWS CLI erros, consulteSolução de problemas de erros para o AWS CLI.

Ajuda adicional

Para obter ajuda adicional com seus AWS CLI problemas, visite a AWS CLI comunidade em GitHub.