Skip to content

Latest commit

 

History

History

support

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
actions
actions
 
 
libs
libs
 
 
scenarios
scenarios
 
 
tests
tests
 
 
README.md
README.md
 
 
hello.js
hello.js
 
 
package.json
package.json
 
 

README.md

Support code examples for the SDK for JavaScript (v3)

Overview

Shows how to use the AWS SDK for JavaScript (v3) to work with AWS Support.

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.

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

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.

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Hello Support

This example shows you how to get started using Support.

node ./hello.js

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.

Tests

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

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

Additional resources

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

SPDX-License-Identifier: Apache-2.0