Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions .doc_gen/metadata/inspector_metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# zexi 0.4.2
inspector_Hello:
title: Hello &Inspector;
title_abbrev: Hello &Inspector;
synopsis: get started using &Inspector;.
category: Hello
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.hello.main
services:
inspector: {BatchGetAccountStatus, ListFindings, ListUsageTotals}
inspector_EnableInspector:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.enable.main
services:
inspector: {Enable}
inspector_CreateFilter:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.create.filter.main
services:
inspector: {CreateFilter}
inspector_GetAccountStatus:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.get_account_status.main
services:
inspector: {BatchGetAccountStatus}
inspector_ListFindings:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.list_findings.main
services:
inspector: {ListFindings}
inspector_BatchGetFindingDetails:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.get_account_status.main
services:
inspector: {BatchGetFindingDetails}
inspector_ListCoverageStatistics:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.list_coverage.stats.main
services:
inspector: {ListCoverageStatistics}
inspector_ListCoverage:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.list_coverage.main
services:
inspector: {ListCoverage}
inspector_ListUsageTotals:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.list_usage_totals.main
services:
inspector: {ListUsageTotals}
inspector_ListFilters:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description:
snippet_tags:
- inspector.java2.list_filters.main
services:
inspector: {inspector_ListFilters}
inspector_Scenario:
synopsis_list:
- Check Inspector account status.
- Ensure Inspector is enabled.
- Analyze security findings.
- Check scan coverage.
- Create a findings filter.
- List existing filters.
- Check usage and costs.
- Get coverage statistics.
category: Basics
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/inspector
sdkguide:
excerpts:
- description: Run an interactive scenario demonstrating &Inspector; features.
snippet_tags:
- inspector.java2_scenario.main
- description: A wrapper class for &Inspector; SDK methods.
snippet_tags:
- inspector.java2_actions.main
services:
inspector: {}
38 changes: 38 additions & 0 deletions javav2/example_code/inspector/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/

### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr

### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/

### VS Code ###
.vscode/

### Mac OS ###
.DS_Store
122 changes: 122 additions & 0 deletions javav2/example_code/inspector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# Amazon Inspector code examples for the SDK for Java 2.x

## Overview

Shows how to use the AWS SDK for Java 2.x to work with Amazon Inspector.

<!--custom.overview.start-->
<!--custom.overview.end-->

_Amazon Inspector _

## ⚠ Important

* 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/).
* Running the tests might result in charges to your AWS account.
* 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).
* 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).

<!--custom.important.start-->
<!--custom.important.end-->

## Code examples

### Prerequisites

For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.


<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello Amazon Inspector](src/main/java/com/java/inspector/HelloInspector.java#L24) (`BatchGetAccountStatus`)


### Basics

Code examples that show you how to perform the essential operations within a service.

- [Learn the basics](src/main/java/com/java/inspector/InspectorScenario.java)


### Single actions

Code excerpts that show you how to call individual service functions.

- [BatchGetAccountStatus](src/main/java/com/java/inspector/InspectorActions.java#L194)
- [BatchGetFindingDetails](src/main/java/com/java/inspector/InspectorActions.java#L194)
- [CreateFilter](src/main/java/com/java/inspector/InspectorActions.java#L290)
- [Enable](src/main/java/com/java/inspector/InspectorActions.java#L21)
- [ListCoverage](src/main/java/com/java/inspector/InspectorActions.java#L415)
- [ListCoverageStatistics](src/main/java/com/java/inspector/InspectorActions.java#L72)
- [ListFindings](src/main/java/com/java/inspector/InspectorActions.java#L340)
- [ListUsageTotals](src/main/java/com/java/inspector/InspectorActions.java#L122)
- [inspector_ListFilters](src/main/java/com/java/inspector/InspectorActions.java#L235)


<!--custom.examples.start-->
<!--custom.examples.end-->

## Run the examples

### Instructions


<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Amazon Inspector

This example shows you how to get started using Amazon Inspector.


#### Learn the basics

This example shows you how to do the following:

- Check Inspector account status.
- Ensure Inspector is enabled.
- Analyze security findings.
- Check scan coverage.
- Create a findings filter.
- List existing filters.
- Check usage and costs.
- Get coverage statistics.

<!--custom.basic_prereqs.inspector_Scenario.start-->
<!--custom.basic_prereqs.inspector_Scenario.end-->


<!--custom.basics.inspector_Scenario.start-->
<!--custom.basics.inspector_Scenario.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `javav2` folder.



<!--custom.tests.start-->
<!--custom.tests.end-->

## Additional resources

- [Amazon Inspector User Guide](https://docs.aws.amazon.com/inspector/latest/user/what-is-inspector.html)
- [Amazon Inspector API Reference](https://docs.aws.amazon.com/inspector/latest/APIReference/Welcome.html)
- [SDK for Java 2.x Amazon Inspector reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/inspector/package-summary.html)

<!--custom.resources.start-->
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
Loading
Loading