CLI output formats (json, table, text) in AWS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the default output format of AWS CLI?

The default output format of AWS CLI is json. It provides structured data that is easy to parse and use in scripts.

beginner

Name the three main AWS CLI output formats.

The three main AWS CLI output formats are json, table, and text.

beginner

What is the benefit of using the table output format in AWS CLI?

The table format displays data in a readable grid with rows and columns, making it easy for humans to scan and understand.

intermediate

How does the text output format differ from json and table?

The text format outputs plain text with values separated by tabs, which is useful for simple scripts or when you want minimal formatting.

beginner

How can you change the AWS CLI output format for a single command?

You can change the output format by adding the --output option followed by json, table, or text to the command. For example: aws s3 ls --output table.

Which AWS CLI output format is best for automated scripts that parse data?

A json

B table

C text

D csv

JSON is structured and easy for programs to parse, making it ideal for automation.

What does the AWS CLI table output format provide?

A A readable grid with rows and columns

B Structured JSON data

C Plain text with tabs

D XML formatted data

The table format shows data in a grid that is easy for humans to read.

How do you specify the output format for a single AWS CLI command?

A Use the --format option

B Use the --output option

C Use the --type option

D Use the --mode option

The --output option sets the output format for that command.

Which output format is the default for AWS CLI?

A table

B text

C json

D yaml

JSON is the default output format for AWS CLI.

Which AWS CLI output format is best for quick human reading without extra parsing?

A json

B xml

C text

D table

Table format is designed for easy human reading.

Explain the differences between the JSON, table, and text output formats in AWS CLI.

Think about who or what will use the output: a person or a program.

How can you change the output format of an AWS CLI command temporarily?

Look for the command option that controls output style.

Practice

1. What does the --output json option do when used with an AWS CLI command?

easy

A. It displays the output as a simple text list.

B. It saves the output directly to a file.

C. It shows the output in a table format for easy reading.

D. It formats the command output as structured JSON data.

Solution

1. Step 1: Understand the purpose of --output option

   The --output option controls how AWS CLI displays command results.

2. Step 2: Identify what 'json' output means

   Choosing json formats the output as structured JSON, which is machine-readable and easy to parse.

3. Final Answer:

   It formats the command output as structured JSON data. -> Option D

4. Quick Check:

   --output json = structured JSON output [OK]

Hint: JSON output is structured and good for programs [OK]

Common Mistakes:

• Confusing JSON with table or text output
• Thinking JSON saves output to a file automatically
• Assuming JSON is for human reading only

2. Which of the following is the correct syntax to display AWS CLI command output in a table format?

easy

A. aws ec2 describe-instances --output table

B. aws s3 ls --output text

C. aws iam list-users --format table

D. aws lambda list-functions --output json

Solution

1. Step 1: Identify the correct option for table output

   The AWS CLI uses --output table to format output as a table.

2. Step 2: Check each option's syntax

   aws ec2 describe-instances --output table uses --output table correctly. aws iam list-users --format table uses --format which is invalid. Options B and D use other formats.

3. Final Answer:

   aws ec2 describe-instances --output table -> Option A

4. Quick Check:

   Table output uses --output table [OK]

Hint: Use --output table for readable tables [OK]

Common Mistakes:

• Using --format instead of --output
• Confusing text and table output options
• Missing the --output flag entirely

3. Given the command aws s3api list-buckets --output text, what is the expected format of the output?

medium

A. A JSON object with bucket details.

B. Plain text with bucket names and details separated by tabs.

C. An XML formatted list of buckets.

D. A human-friendly table with borders.

Solution

1. Step 1: Understand the --output text format

   The text output format produces plain text with fields separated by tabs, suitable for scripts.

2. Step 2: Match output format to options

   Plain text with bucket names and details separated by tabs. describes plain text with tab-separated values, which matches --output text. JSON and XML are not text formats, and table includes borders.

3. Final Answer:

   Plain text with bucket names and details separated by tabs. -> Option B

4. Quick Check:

   --output text = tab-separated plain text [OK]

Hint: Text output is tab-separated plain text [OK]

Common Mistakes:

• Confusing text output with JSON or table
• Expecting borders or formatting in text output
• Assuming XML output is default

4. You run aws ec2 describe-instances --output tab but get an error. What is the likely cause?

medium

A. The AWS CLI version does not support output formatting.

B. The command requires additional parameters to run.

C. The correct output format is 'table', not 'tab'.

D. The 'tab' output format is deprecated and replaced by 'text'.

Solution

1. Step 1: Identify the valid output formats

   AWS CLI supports 'json', 'table', and 'text' as output formats. 'tab' is not valid.

2. Step 2: Analyze the error cause

   Using 'tab' instead of 'table' causes a syntax error because 'tab' is not recognized.

3. Final Answer:

   The correct output format is 'table', not 'tab'. -> Option C

4. Quick Check:

   Valid formats: json, table, text [OK]

Hint: Use 'table' not 'tab' for table output [OK]

Common Mistakes:

• Typing 'tab' instead of 'table'
• Assuming 'tab' is a valid alias
• Ignoring error messages about output format

5. You want to write a script that extracts only the bucket names from aws s3api list-buckets. Which output format should you choose to easily parse the bucket names in a shell script?

hard

A. Use --output text for simple tab-separated values.

B. Use --output table and extract names from the table.

C. Use --output json and parse with a JSON tool.

D. Use --output xml for structured parsing.

Solution

1. Step 1: Consider parsing ease in shell scripts

   Shell scripts handle plain text easily, especially tab-separated values.

2. Step 2: Match output format to parsing needs

   --output text produces simple tab-separated output, ideal for shell tools like cut or awk. JSON requires extra tools, table is formatted for humans, XML is unsupported.

3. Final Answer:

   Use --output text for simple tab-separated values. -> Option A

4. Quick Check:

   Text output is easiest for shell parsing [OK]

Hint: Text output is easiest for shell scripts [OK]

Common Mistakes:

• Choosing JSON without JSON parsing tools
• Trying to parse table output in scripts
• Assuming XML output is supported