Skip to content

Commit 312c0cd

Browse files
scmacdonscmacdon
committed
Replace SPECIFICATION.md to resolve conflicts
1 parent 93946c7 commit 312c0cd

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

‎scenarios/basics/inspector/SPECIFICATION.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Amazon Inspector Specification
2+
3+
This SDK Basics scenario demonstrates how to interact with Amazon Inspector, a basics scenario that showcases AWS services and SDKs. It is primarily intended for the AWS code examples team to use while developing this example in additional languages.
4+
5+
## Resources
6+
This Basics scenario does not require any additional AWS resources.
7+
8+
### Relevant documentation
9+
10+
* [Getting started with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/getting_started.html)
11+
* [What is Amazon Inspector?](https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html)
12+
* [Amazon Inspector API Reference](https://docs.aws.amazon.com/inspector/v2/APIReference/Welcome.html)
13+
* [Amazon Inspector Pricing](https://aws.amazon.com/inspector/pricing/)
14+
15+
### API Actions Used
16+
17+
* [CreateFilter](https://docs.aws.amazon.com/inspector/v2/APIReference/API_CreateFilter.html)
18+
19+
* [Enable](https://docs.aws.amazon.com/inspector/v2/APIReference/API_Enable.html)
20+
21+
* [ListCoverageStatistics](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListCoverageStatistics.html)
22+
23+
24+
* [ListUsageTotals](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListUsageTotals.html)
25+
26+
* [BatchGetAccountStatus](https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchGetAccountStatus.html)
27+
28+
* [ListFilters](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListFilters.html)
29+
30+
* [ListFindings](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListFindings.html)
31+
32+
* [BatchGetFindingDetails](https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchGetFindingDetails.html)
33+
34+
* [ListCoverage](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListCoverage.html)
35+
36+
* [DeleteFilter](https://docs.aws.amazon.com/inspector/v2/APIReference/API_DeleteFilter.html)
37+
38+
39+
## Hello Amazon Inspector
40+
41+
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.
42+
43+
## Scenario
44+
45+
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.
46+
47+
---
48+
49+
### Setup
50+
51+
* Check Amazon Inspector account status
52+
* Enable Inspector for available resource types (if not already enabled)
53+
* Display account status summary
54+
55+
---
56+
57+
### Coverage Assessment
58+
59+
* List coverage details for scanned resources
60+
* Display overall coverage statistics
61+
* Review scan status for resources (general overview)
62+
63+
---
64+
65+
### Findings Management
66+
67+
* List security findings across all resource types
68+
* Create an example filter to suppress low-severity findings
69+
* List existing filters
70+
71+
---
72+
73+
### Usage and Costs
74+
75+
* Check usage totals and metrics for Inspector
76+
* Review coverage statistics
77+
78+
---
79+
80+
### Outcome
81+
82+
By following this scenario, users learn how to:
83+
84+
* Check Inspector account status and configuration
85+
* Enable Inspector for different resource types
86+
* List and analyze security findings
87+
* Monitor scan coverage
88+
* Create and manage filters
89+
* Track usage and coverage statistics
90+
91+
## Errors
92+
93+
The table below describes the exceptions handled in the program for each action.
94+
95+
| Action | Exception | Handling |
96+
|-------------------------------|---------------------------|--------------------------------------------------------------------------|
97+
| `Enable` | `ValidationException` | Prints a message indicating Inspector may already be enabled. |
98+
| `listUsageTotals` | `ValidationException` | Validation error listing usage totals.
99+
| `BatchGetAccountStatus` | `AccessDeniedException` | Prints AWS service error details and rethrows the exception. |
100+
| `ListFindings` | `ValidationException` | Prints validation error details. |
101+
| `ListCoverage` | `ValidationException` | Prints validation error details. |
102+
| `ListCoverageStatistics` | `ValidationException` | Prints validation error details. |
103+
| `createFilter` | `ValidationException` | Prints validation error details. |
104+
| `ListFilters` | `ValidationException` | Prints AWS service error details and rethrows the exception. |
105+
| `deleteFilter` | `ResourceNotFoundException` | Prints AWS service error details and rethrows the exception. |
106+
| `batchGetFindingDetails` | `ResourceNotFoundException` | Prints AWS service error details and rethrows the exception. |
107+
108+
109+
## Metadata
110+
111+
| Action / Scenario | Metadata File | Metadata Key |
112+
|-----------------------------------------|------------------------|-------------------------------|
113+
| `Enable` | inspector_metadata.yaml | inspector_EnableInspector |
114+
| `BatchGetAccountStatus` | inspector_metadata.yaml | inspector_GetAccountStatus |
115+
| `ListFindings` | inspector_metadata.yaml | inspector_ListFindings |
116+
| `ListCoverage` | inspector_metadata.yaml | inspector_ListCoverage |
117+
| `ListCoverageStatistics` | inspector_metadata.yaml | inspector_ListCoverageStatistics |
118+
| `ListUsageTotals` | inspector_metadata.yaml | inspector_ListUsageTotals |
119+
| `CreateFilter` | inspector_metadata.yaml | inspector_CreateFilter |
120+
| `ListFilters` | inspector_metadata.yaml | inspector_ListFilters |
121+
| `DeleteFilter` | inspector_metadata.yaml | inspector_DeleteFilter` |
122+
| `batchGetFindingDetails` | inspector_metadata.yaml | inspector_BatchGetFindingDetails |
123+
| `Amazon Inspector Hello` | inspector_metadata.yaml | inspector_Hello |
124+
| `Amazon Inspector Basics Scenario` | inspector_metadata.yaml | inspector_Scenario

0 commit comments

Comments
 (0)