이 설명서는 의 버전 1 AWS CLI 전용입니다. 의 버전 2와 관련된 설명서는 버전 2 사용 설명서 를 AWS CLI참조하세요.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
에 대한 도움말에 액세스 AWS Command Line Interface
이 항목에서는 AWS Command Line Interface (AWS CLI) 의 도움말 콘텐츠에 액세스하는 방법을 설명합니다.
기본 제공 AWS CLI help 명령
AWS Command Line Interface (AWS CLI) 를 사용하면 모든 명령에 대한 도움말을 얻을 수 있습니다. 이를 위해 명령 이름 끝에 help
를 입력하기만 하면 됩니다.
예를 들어, 다음 명령은 일반 AWS CLI 옵션 및 사용 가능한 최상위 명령에 대한 도움말을 표시합니다.
$
aws help
다음 명령은 사용 가능한 Amazon Elastic Compute Cloud (AmazonEC2) 전용 명령을 표시합니다.
$
aws ec2 help
다음 예는 Amazon EC2 DescribeInstances
작업에 대한 자세한 도움말을 표시합니다. 도움말에는 입력 파라미터, 사용 가능한 필터, 출력으로 포함되는 항목에 대한 설명이 포함됩니다. 해당 명령의 일반적인 변형을 입력하는 방법을 보여주는 예제도 포함되어 있습니다.
$
aws ec2 describe-instances help
각 명령에 대한 도움말은 다음과 같은 6개 섹션으로 나뉩니다.
- 이름
-
명령의 이름입니다.
NAME describe-instances -
- 설명
-
명령이 호출하는 API 작업에 대한 설명.
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. ...
- 시놉시스
-
명령 및 옵션 사용을 위한 기본 구문입니다. 옵션을 대괄호로 표시할 경우 선택적인 옵션이거나, 기본값을 가지거나, 사용할 수 있는 대체 옵션을 갖고 있습니다.
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]
예를 들어
describe-instances
에는 현재 계정 및 AWS 지역의 모든 인스턴스를 설명하는 기본 동작이 있습니다. 1개 이상의 인스턴스를 설명할instance-ids
목록을 선택적으로 지정할 수 있습니다.dry-run
은 값을 가지지 않는 선택 사항인 부울 플래그입니다. 부울 플래그를 사용하려면 표시된 값을 지정합니다. 이 경우--dry-run
또는--no-dry-run
입니다. 마찬가지로--generate-cli-skeleton
도 값을 갖고 있지 않습니다. 옵션 사용 시 조건이 있는 경우 해당 조건을OPTIONS
섹션에서 설명하거나 예제에 표시합니다. - 옵션
-
개요에 표시된 각 옵션에 대한 설명입니다.
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. ...
- 예제:
-
명령 및 해당 옵션의 사용을 보여 주는 예제입니다. 필요한 명령 또는 사용 사례에 사용할 수 있는 예제가 없는 경우 이 페이지의 피드백 링크 또는 명령 도움말 페이지의 AWS CLI 명령 참조를 사용하여 예제를 요청하십시오.
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" ...
- 출력
-
의 응답에 포함되는 각 필드 및 데이터 형식에 대한 설명입니다 AWS
describe-instances
의 경우 출력은 예약 객체의 목록이며, 각 객체에는 연관된 인스턴스에 대한 정보를 포함하는 여러 필드 및 객체가 포함됩니다. 이 정보는 Amazon에서 사용하는 예약 데이터 유형에 대한 API 설명서에서 가져온 EC2 것입니다.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. ...
출력을 로 AWS CLI JSON 렌더링하면 다음 예와 마찬가지로 예약 객체의 배열이 됩니다.
{ "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" }, ...
각 예약 객체에는 예약을 설명하는 필드와 인스턴스 객체의 배열이 포함됩니다. 각 배열에는 고유한 필드(예:
PublicDnsName
) 및 이를 설명하는 객체(예:State
)가 있습니다.Windows 사용자
도움말 파일을 한 번에 한 페이지씩 보기 위해 help 명령의 출력을
more
명령에 파이프 (|)할 수 있습니다. 문서를 더 보고 PgDnq
종료하려면 스페이스바 또는 키를 누릅니다.C:\>
aws ec2 describe-instances help | more
AWS CLI 참조 가이드
도움말 파일에는 명령줄에서 탐색하거나 볼 수 없는 링크가 포함됩니다. 온라인 AWS CLI 버전 1 참조 가이드 사용하여 이러한 링크를 보고 상호 작용할 수 있습니다. 참조에는 모든 AWS CLI 명령에 대한 도움말 내용도 포함되어 있습니다. 이 설명은 쉽게 탐색하고 모바일, 태블릿 또는 데스크톱 화면에서 볼 수 있도록 제공됩니다.
API설명서
의 모든 명령은 AWS 서비스 공개에 대한 요청에 AWS CLI 해당합니다API. API공개가 있는 각 서비스에는 AWS 설명서 웹
API설명서 섹션
-
작업 - 각 작업과 해당 파라미터에 대한 세부 정보(길이 또는 콘텐츠에 대한 제약, 기본값 등)입니다. 이 작업에 발생할 수 있는 오류를 나열합니다. 각 작업은 의 하위 명령에 해당합니다. AWS CLI
-
데이터 유형 - 명령이 파라미터로 요구하거나 요청에 대한 응답으로 반환할 수 있는 구조에 대한 자세한 정보입니다.
-
범용 파라미터 - 서비스의 모든 작업에서 공유하는 파라미터에 대한 세부 정보입니다.
-
범용 오류 - 모든 서비스 작업에서 반환할 수 있는 오류에 대한 세부 정보입니다.
각 섹션의 이름 및 가용성은 서비스에 따라 다를 수 있습니다.
서비스별 CLIs
일부 서비스에는 모든 서비스에서 사용할 수 CLI 있도록 단일 서비스가 생성되기 전과 다른 AWS CLI 날짜가 있습니다. 이러한 서비스별 CLIs 설명서에는 서비스의 설명서 페이지에서 링크된 별도의 설명서가 있습니다. 서비스별 설명서는 에는 적용되지 CLIs 않습니다. AWS CLI
오류 해결
AWS CLI 오류 진단 및 수정에 대한 도움말은 을 참조하십시오. 오류 문제 해결 AWS CLI
추가 도움말
AWS CLI 문제에 대한 추가 지원이 필요하면 AWS CLI 커뮤니티를