ContextQMD
Back to Aws Doc Sdk Examples

Support code examples for the SDK for Python

python/example_code/support/README.md

latest4.0 KB
Original Source

Support code examples for the SDK for Python

Overview

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

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

Support provides support for users of Amazon Web Services.

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

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan in order to run these examples.

<!--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--> <!--custom.prerequisites.end-->

Get started

Basics

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

Single actions

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

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

Run the examples

Instructions

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

Hello Support

This example shows you how to get started using Support.

python hello.py

Learn the basics

This example shows you how to do the following:

  • Get and display available services and severity levels for cases.
  • Create a support case using a selected service, category, and severity level.
  • Get and display a list of open cases for the current day.
  • Add an attachment set and a communication to the new case.
  • Describe the new attachment and communication for the case.
  • Resolve the case.
  • Get and display a list of resolved cases for the current day.
<!--custom.basic_prereqs.support_Scenario_GetStartedSupportCases.start--> <!--custom.basic_prereqs.support_Scenario_GetStartedSupportCases.end-->

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

python get_started_support_cases.py
<!--custom.basics.support_Scenario_GetStartedSupportCases.start--> <!--custom.basics.support_Scenario_GetStartedSupportCases.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