LinuxCommandLibrary

aws-help

Access AWS CLI command help documentation

TLDR

Display help

$ aws help
copy

List all available topics
$ aws help topics
copy

Display help about a specific topic
$ aws help [topic_name]
copy

SYNOPSIS

aws-help [command] [subcommand]

PARAMETERS

[command]
    Optional AWS service command (e.g., ec2, s3) to show specific help

[subcommand]
    Optional subcommand for detailed syntax and examples

--help
    Alias for general help (recursive)

--cli-help
    Alternative flag for CLI-specific info in some versions

DESCRIPTION

The aws-help command is not a standard standalone Linux utility but often refers to the integrated help system of the AWS Command Line Interface (CLI). Invoked as aws help or aws <service> help, it provides detailed documentation on AWS CLI usage, commands, options, and examples.

It outputs formatted text explaining syntax, available subcommands for services like EC2, S3, or IAM, required parameters, and common options such as --region or --output. This is essential for users managing AWS resources via terminal without accessing online docs.

Note: aws-help may appear as an alias or wrapper script in custom environments (e.g., alias aws-help='aws help'), but core functionality stems from the AWS CLI v2 (awscli package). Install via pip install awscli or system package managers.

CAVEATS

Not a native binary; requires AWS CLI installed. Output is text-only; use aws <cmd> help for paging. Authentication via AWS credentials needed for examples.

INSTALLATION

On Ubuntu: sudo apt install awscli. Verify: aws --version.

EXAMPLES

aws-help s3 for S3 bucket help.
aws-help ec2 describe-instances for instance details.

HISTORY

Introduced with AWS CLI v1 (2013); enhanced in v2 (2020) with better Markdown rendering and JSON output support. Maintained by Amazon Web Services.

SEE ALSO

aws(1), man awscli(1), pip(1)

Copied to clipboard