Skip to content

Commit bc17e3f

Browse files
scmacdonscmacdon
authored
Java V2 Add Inspector examples (#7660)
1 parent 3a60ab3 commit bc17e3f

File tree

9 files changed

+1739
-49
lines changed

9 files changed

+1739
-49
lines changed

‎.doc_gen/metadata/inspector_metadata.yaml‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
# zexi 0.4.2
2+
inspector_Hello:
3+
title: Hello &Inspector;
4+
title_abbrev: Hello &Inspector;
5+
synopsis: get started using &Inspector;.
6+
category: Hello
7+
languages:
8+
Java:
9+
versions:
10+
- sdk_version: 2
11+
github: javav2/example_code/inspector
12+
sdkguide:
13+
excerpts:
14+
- description:
15+
snippet_tags:
16+
- inspector.java2.hello.main
17+
services:
18+
inspector: {ListMembers}
19+
inspector_BatchGetFindingDetails:
20+
languages:
21+
Java:
22+
versions:
23+
- sdk_version: 2
24+
github: javav2/example_code/inspector
25+
sdkguide:
26+
excerpts:
27+
- description:
28+
snippet_tags:
29+
- inspector.java2.finding.details.main
30+
services:
31+
inspector: {BatchGetFindingDetails}
32+
inspector_DeleteFilter:
33+
languages:
34+
Java:
35+
versions:
36+
- sdk_version: 2
37+
github: javav2/example_code/inspector
38+
sdkguide:
39+
excerpts:
40+
- description:
41+
snippet_tags:
42+
- inspector.java2.delete.filter.main
43+
services:
44+
inspector: {DeleteFilter}
45+
inspector_Disable:
46+
languages:
47+
Java:
48+
versions:
49+
- sdk_version: 2
50+
github: javav2/example_code/inspector
51+
sdkguide:
52+
excerpts:
53+
- description:
54+
snippet_tags:
55+
- inspector.java2.disable.main
56+
services:
57+
inspector: {Disable}
58+
inspector_Enable:
59+
languages:
60+
Java:
61+
versions:
62+
- sdk_version: 2
63+
github: javav2/example_code/inspector
64+
sdkguide:
65+
excerpts:
66+
- description:
67+
snippet_tags:
68+
- inspector.java2.enable.main
69+
services:
70+
inspector: {Enable}
71+
inspector_CreateFilter:
72+
languages:
73+
Java:
74+
versions:
75+
- sdk_version: 2
76+
github: javav2/example_code/inspector
77+
sdkguide:
78+
excerpts:
79+
- description:
80+
snippet_tags:
81+
- inspector.java2.create.filter.main
82+
services:
83+
inspector: {CreateFilter}
84+
inspector_GetAccountStatus:
85+
languages:
86+
Java:
87+
versions:
88+
- sdk_version: 2
89+
github: javav2/example_code/inspector
90+
sdkguide:
91+
excerpts:
92+
- description:
93+
snippet_tags:
94+
- inspector.java2.get_account_status.main
95+
services:
96+
inspector: {BatchGetAccountStatus}
97+
inspector_ListFindings:
98+
languages:
99+
Java:
100+
versions:
101+
- sdk_version: 2
102+
github: javav2/example_code/inspector
103+
sdkguide:
104+
excerpts:
105+
- description:
106+
snippet_tags:
107+
- inspector.java2.list_findings.main
108+
services:
109+
inspector: {ListFindings}
110+
inspector_ListCoverageStatistics:
111+
languages:
112+
Java:
113+
versions:
114+
- sdk_version: 2
115+
github: javav2/example_code/inspector
116+
sdkguide:
117+
excerpts:
118+
- description:
119+
snippet_tags:
120+
- inspector.java2.list_coverage.stats.main
121+
services:
122+
inspector: {ListCoverageStatistics}
123+
inspector_ListCoverage:
124+
languages:
125+
Java:
126+
versions:
127+
- sdk_version: 2
128+
github: javav2/example_code/inspector
129+
sdkguide:
130+
excerpts:
131+
- description:
132+
snippet_tags:
133+
- inspector.java2.list_coverage.main
134+
services:
135+
inspector: {ListCoverage}
136+
inspector_ListUsageTotals:
137+
languages:
138+
Java:
139+
versions:
140+
- sdk_version: 2
141+
github: javav2/example_code/inspector
142+
sdkguide:
143+
excerpts:
144+
- description:
145+
snippet_tags:
146+
- inspector.java2.list_usage_totals.main
147+
services:
148+
inspector: {ListUsageTotals}
149+
inspector_ListFilters:
150+
languages:
151+
Java:
152+
versions:
153+
- sdk_version: 2
154+
github: javav2/example_code/inspector
155+
sdkguide:
156+
excerpts:
157+
- description:
158+
snippet_tags:
159+
- inspector.java2.list_filters.main
160+
services:
161+
inspector: {ListFilters}
162+
inspector_Scenario:
163+
synopsis_list:
164+
- Check Inspector account status.
165+
- Ensure Inspector is enabled.
166+
- Analyze security findings.
167+
- Check scan coverage.
168+
- Create a findings filter.
169+
- List existing filters.
170+
- Check usage and costs.
171+
- Get coverage statistics.
172+
- Delete a filter.
173+
category: Basics
174+
languages:
175+
Java:
176+
versions:
177+
- sdk_version: 2
178+
github: javav2/example_code/inspector
179+
sdkguide:
180+
excerpts:
181+
- description: Run an interactive scenario demonstrating &Inspector; features.
182+
snippet_tags:
183+
- inspector.java2_scenario.main
184+
- description: A wrapper class for &Inspector; SDK methods.
185+
snippet_tags:
186+
- inspector.java2_actions.main
187+
services:
188+
inspector: {BatchGetAccountStatus, BatchGetFindingDetails, DeleteFilter, Enable, ListFindings, ListCoverage, CreateFilter, ListFilters, ListUsageTotals, ListCoverageStatistics}

‎javav2/example_code/inspector/README.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Amazon Inspector code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with Amazon Inspector.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon Inspector _
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello Amazon Inspector](src/main/java/com/java/inspector/HelloInspector.java#L29) (`ListMembers`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/java/inspector/InspectorScenario.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [BatchGetAccountStatus](src/main/java/com/java/inspector/InspectorActions.java#L246)
49+
- [BatchGetFindingDetails](src/main/java/com/java/inspector/InspectorActions.java#L587)
50+
- [CreateFilter](src/main/java/com/java/inspector/InspectorActions.java#L371)
51+
- [DeleteFilter](src/main/java/com/java/inspector/InspectorActions.java#L557)
52+
- [Disable](src/main/java/com/java/inspector/InspectorActions.java#L670)
53+
- [Enable](src/main/java/com/java/inspector/InspectorActions.java#L55)
54+
- [ListCoverage](src/main/java/com/java/inspector/InspectorActions.java#L490)
55+
- [ListCoverageStatistics](src/main/java/com/java/inspector/InspectorActions.java#L127)
56+
- [ListFilters](src/main/java/com/java/inspector/InspectorActions.java#L325)
57+
- [ListFindings](src/main/java/com/java/inspector/InspectorActions.java#L435)
58+
- [ListUsageTotals](src/main/java/com/java/inspector/InspectorActions.java#L184)
59+
60+
61+
<!--custom.examples.start-->
62+
<!--custom.examples.end-->
63+
64+
## Run the examples
65+
66+
### Instructions
67+
68+
69+
<!--custom.instructions.start-->
70+
<!--custom.instructions.end-->
71+
72+
#### Hello Amazon Inspector
73+
74+
This example shows you how to get started using Amazon Inspector.
75+
76+
77+
#### Learn the basics
78+
79+
This example shows you how to do the following:
80+
81+
- Check Inspector account status.
82+
- Ensure Inspector is enabled.
83+
- Analyze security findings.
84+
- Check scan coverage.
85+
- Create a findings filter.
86+
- List existing filters.
87+
- Check usage and costs.
88+
- Get coverage statistics.
89+
- Delete a filter.
90+
91+
<!--custom.basic_prereqs.inspector_Scenario.start-->
92+
<!--custom.basic_prereqs.inspector_Scenario.end-->
93+
94+
95+
<!--custom.basics.inspector_Scenario.start-->
96+
<!--custom.basics.inspector_Scenario.end-->
97+
98+
99+
### Tests
100+
101+
⚠ Running tests might result in charges to your AWS account.
102+
103+
104+
To find instructions for running these tests, see the [README](../../README.md#Tests)
105+
in the `javav2` folder.
106+
107+
108+
109+
<!--custom.tests.start-->
110+
<!--custom.tests.end-->
111+
112+
## Additional resources
113+
114+
- [Amazon Inspector User Guide](https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html)
115+
- [Amazon Inspector API Reference](https://docs.aws.amazon.com/inspector/latest/APIReference/Welcome.html)
116+
- [SDK for Java 2.x Amazon Inspector reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/inspector/package-summary.html)
117+
118+
<!--custom.resources.start-->
119+
<!--custom.resources.end-->
120+
121+
---
122+
123+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
124+
125+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)