Systems Manager code examples for the SDK for Java 2.x

Overview

Shows how to use the AWS SDK for Java 2.x to work with AWS Systems Manager.

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

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.

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

Code examples

Prerequisites

For prerequisites, see the README in the javav2 folder.

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

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
• DescribeOpsItems
• DescribeParameters
• PutParameter
• SendCommand
• UpdateMaintenanceWindow
• UpdateOpsItem

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

Run the examples

Instructions

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

Properties file

Before running the AWS Systems Manager JUnit tests, you must define values in the config.properties file located in the resources folder. This file contains values that are required to run the JUnit tests. For example, you define a parameter name used in the tests. If you do not define all values, the JUnit tests fail.

Define these values to successfully run the JUnit tests:

• paraName - A parameter name used in the GetParameter test.
• source - The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
• category - A category to assign to an OpsItem.
• severity - A severity value to assign to an OpsItem.
• title - The OpsItem title.

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

Hello Systems Manager

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

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.

<!--custom.basic_prereqs.ssm_Scenario.start--> <!--custom.basic_prereqs.ssm_Scenario.end--> <!--custom.basics.ssm_Scenario.start--> <!--custom.basics.ssm_Scenario.end-->

Tests

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

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

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

Additional resources

• Systems Manager User Guide
• Systems Manager API Reference
• SDK for Java 2.x Systems Manager reference

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

---

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

SPDX-License-Identifier: Apache-2.0