Systems Manager code examples for the SDK for Python

Overview

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

Systems Manager organizes, monitors, and automates management tasks on your AWS resources.

⚠ 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.

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

Get started

• Hello Systems Manager (ListDocuments)

Basics

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

• Learn the basics

Single actions

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

• CreateDocument
• CreateMaintenanceWindow
• CreateOpsItem
• DeleteDocument
• DeleteMaintenanceWindow
• DeleteOpsItem
• DescribeOpsItems
• ListCommandInvocations
• SendCommand
• UpdateMaintenanceWindow
• UpdateOpsItem

Run the examples

Instructions

Hello Systems Manager

This example shows you how to get started using Systems Manager.

python hello.py

Learn the basics

This example shows you how to do the following:

• Create a maintenance window.
• Modify the maintenance window schedule.
• Create a document.
• Send a command to a specified EC2 instance.
• Create an OpsItem.
• Update and resolve the OpsItem.
• Delete the maintenance window, OpsItem, and document.

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

python ssm_getting_started.py

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.

Additional resources

• Systems Manager User Guide
• Systems Manager API Reference
• SDK for Python Systems Manager reference

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

SPDX-License-Identifier: Apache-2.0