Skip to content

Commit 4f43876

Browse files
committed
updated Readme
1 parent 8a447b3 commit 4f43876

File tree

1 file changed

+122
-0
lines changed

1 file changed

+122
-0
lines changed
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
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#L24) (`BatchGetAccountStatus`)
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#L194)
49+
- [BatchGetFindingDetails](src/main/java/com/java/inspector/InspectorActions.java#L194)
50+
- [CreateFilter](src/main/java/com/java/inspector/InspectorActions.java#L290)
51+
- [Enable](src/main/java/com/java/inspector/InspectorActions.java#L21)
52+
- [ListCoverage](src/main/java/com/java/inspector/InspectorActions.java#L415)
53+
- [ListCoverageStatistics](src/main/java/com/java/inspector/InspectorActions.java#L72)
54+
- [ListFindings](src/main/java/com/java/inspector/InspectorActions.java#L340)
55+
- [ListUsageTotals](src/main/java/com/java/inspector/InspectorActions.java#L122)
56+
- [inspector_ListFilters](src/main/java/com/java/inspector/InspectorActions.java#L235)
57+
58+
59+
<!--custom.examples.start-->
60+
<!--custom.examples.end-->
61+
62+
## Run the examples
63+
64+
### Instructions
65+
66+
67+
<!--custom.instructions.start-->
68+
<!--custom.instructions.end-->
69+
70+
#### Hello Amazon Inspector
71+
72+
This example shows you how to get started using Amazon Inspector.
73+
74+
75+
#### Learn the basics
76+
77+
This example shows you how to do the following:
78+
79+
- Check Inspector account status.
80+
- Ensure Inspector is enabled.
81+
- Analyze security findings.
82+
- Check scan coverage.
83+
- Create a findings filter.
84+
- List existing filters.
85+
- Check usage and costs.
86+
- Get coverage statistics.
87+
88+
<!--custom.basic_prereqs.inspector_Scenario.start-->
89+
<!--custom.basic_prereqs.inspector_Scenario.end-->
90+
91+
92+
<!--custom.basics.inspector_Scenario.start-->
93+
<!--custom.basics.inspector_Scenario.end-->
94+
95+
96+
### Tests
97+
98+
⚠ Running tests might result in charges to your AWS account.
99+
100+
101+
To find instructions for running these tests, see the [README](../../README.md#Tests)
102+
in the `javav2` folder.
103+
104+
105+
106+
<!--custom.tests.start-->
107+
<!--custom.tests.end-->
108+
109+
## Additional resources
110+
111+
- [Amazon Inspector User Guide](https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html)
112+
- [Amazon Inspector API Reference](https://docs.aws.amazon.com/inspector/latest/APIReference/Welcome.html)
113+
- [SDK for Java 2.x Amazon Inspector reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/inspector/package-summary.html)
114+
115+
<!--custom.resources.start-->
116+
<!--custom.resources.end-->
117+
118+
---
119+
120+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
121+
122+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)