Skip to content

Commit f0755a2

Browse files
committed
updated spec
1 parent 9266a0b commit f0755a2

File tree

2 files changed

+48
-21
lines changed

2 files changed

+48
-21
lines changed

javav2/example_code/inspector/src/main/java/com/java/inspector/InspectorScenario.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,9 @@ by Amazon Web Services (AWS) that helps improve the security
155155
}
156156
System.out.println();
157157

158-
System.out.println("🎉 Inspector Basics scenario completed successfully!");
158+
System.out.println(" Inspector Basics scenario completed successfully!");
159159
System.out.println();
160-
System.out.println("📚 What you learned:");
160+
System.out.println(" What you learned:");
161161
System.out.println(" ✓ How to check Inspector account status and configuration");
162162
System.out.println(" ✓ How to enable Inspector for different resource types");
163163
System.out.println(" ✓ How to list and analyze security findings");

scenarios/basics/inspector/SPECIFICATION.md

Lines changed: 46 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,38 +25,65 @@ This Basics scenario does not require any additional AWS resources.
2525

2626
## Hello Amazon Inspector
2727

28-
The Hello example is a separate runnable example. - Set up the Inspector service client, checks the current account status for Inspector and displays available scan types.
28+
The Hello example is intended for users not familiar with this service to easily get up and running. It sets up the Inspector service client, checks the current account status for Inspector and displays available scan types.
2929

3030
## Scenario
3131

32-
#### Setup
32+
## Scenario
33+
34+
This scenario demonstrates the basic usage of **Amazon Inspector** using a Java program. It focuses on checking account status, enabling Inspector, listing findings, reviewing coverage, and managing filters.
35+
36+
---
37+
38+
### Setup
39+
40+
* Check Amazon Inspector account status
41+
* Enable Inspector for available resource types (if not already enabled)
42+
* Display account status summary
43+
44+
---
3345

34-
* Enable Amazon Inspector for the account
35-
* Verify Inspector is successfully activated
36-
* Display account status and enabled scan types
46+
### Coverage Assessment
3747

38-
#### Coverage Assessment
48+
* List coverage details for scanned resources
49+
* Display overall coverage statistics
50+
* Review scan status for resources (general overview)
3951

40-
* List coverage statistics for EC2 instances, ECR repositories, and Lambda functions
41-
* Display resource coverage details
42-
* Show scanning status for different resource types
52+
---
4353

44-
#### Findings Management
54+
### Findings Management
4555

4656
* List security findings across all resource types
47-
* Filter findings by severity level (CRITICAL, HIGH, MEDIUM, LOW)
48-
* Retrieve detailed information for specific findings
57+
* Create an example filter to suppress low-severity findings
58+
* List existing filters
59+
60+
---
61+
62+
### Usage and Costs
63+
64+
* Check usage totals and metrics for Inspector
65+
* Review coverage statistics
66+
67+
---
68+
69+
### Notes
70+
71+
* The program **does not retrieve detailed vulnerability (CVE) information**.
72+
* Resource-specific filtering (e.g., EC2, ECR, Lambda) is **not implemented**.
73+
* Cleanup (disabling Inspector) is **not performed**.
4974

50-
#### Vulnerability Analysis
75+
---
5176

52-
* Display vulnerability details including CVE information
53-
* Show affected resources and remediation guidance
54-
* Filter findings by resource type (EC2, ECR, Lambda)
77+
### Outcome
5578

56-
#### Cleanup
79+
By following this scenario, users learn how to:
5780

58-
* Optionally disable Inspector scanning (with user confirmation)
59-
* Display final account status
81+
* Check Inspector account status and configuration
82+
* Enable Inspector for different resource types
83+
* List and analyze security findings
84+
* Monitor scan coverage
85+
* Create and manage filters
86+
* Track usage and coverage statistics
6087

6188
## Errors
6289

0 commit comments

Comments
 (0)