Back to Aws Doc Sdk Examples

Audit Manager code examples for the SDK for Python

python/example_code/auditmanager/README.md

latest6.5 KB
Original Source

Audit Manager code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with AWS Audit Manager.

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

Audit Manager helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • 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.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the python folder.

Install the packages required by these examples by running the following in a virtual environment:

python -m pip install -r requirements.txt
<!--custom.prerequisites.start-->

For more information, see the following resources:

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

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

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

Run the examples

Instructions

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

Create a custom framework from an AWS Config conformance pack

This example shows you how to do the following:

  • Get a list of AWS Config conformance packs.
  • Create an Audit Manager custom control for each managed rule in a conformance pack.
  • Create an Audit Manager custom framework that contains the controls.
<!--custom.scenario_prereqs.auditmanager_Scenario_CustomFrameworkFromConformancePack.start--> <!--custom.scenario_prereqs.auditmanager_Scenario_CustomFrameworkFromConformancePack.end-->

Start the example by running the following at a command prompt:

python framework_from_conformance_pack.py
<!--custom.scenarios.auditmanager_Scenario_CustomFrameworkFromConformancePack.start--> <!--custom.scenarios.auditmanager_Scenario_CustomFrameworkFromConformancePack.end-->

Create a custom framework that contains Security Hub controls

This example shows you how to do the following:

  • Get a list of all standard controls that have Security Hub as their data source.
  • Create an Audit Manager custom framework that contains the controls.
<!--custom.scenario_prereqs.auditmanager_Scenario_CustomFrameworkFromSecurityHub.start--> <!--custom.scenario_prereqs.auditmanager_Scenario_CustomFrameworkFromSecurityHub.end-->

Start the example by running the following at a command prompt:

python security_hub_custom_framework.py
<!--custom.scenarios.auditmanager_Scenario_CustomFrameworkFromSecurityHub.start--> <!--custom.scenarios.auditmanager_Scenario_CustomFrameworkFromSecurityHub.end-->

Create an assessment report

This example shows you how to create an Audit Manager assessment report that contains one day of evidence.

<!--custom.scenario_prereqs.auditmanager_Scenario_CreateAssessmentReport.start--> <!--custom.scenario_prereqs.auditmanager_Scenario_CreateAssessmentReport.end-->

Start the example by running the following at a command prompt:

python create_assessment_report.py
<!--custom.scenarios.auditmanager_Scenario_CreateAssessmentReport.start--> <!--custom.scenarios.auditmanager_Scenario_CreateAssessmentReport.end-->

Tests

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

To find instructions for running these tests, see the README in the python folder.

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

Additional resources

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

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

SPDX-License-Identifier: Apache-2.0