These are examples for the AWS Command Line Interface (AWS CLI) public documentation. All examples have been tested and verified to work with the AWS CLI version 2.
To run these examples, you'll need:
- The AWS CLI, downloaded and running on your machine
- AWS credentials in a shared credentials file
Examples are typically written as functions in shell script files that can be sourced from other files. Most are accompanied by a unit test script in the tests directory that you can run to validate that each example works. The test scripts create the include setup and teardown functions that create and destroy any prerequisite resources. We take care that all AWS resources that the example creates are also destroyed to avoid incurring any unwanted costs. We do recommend when you're done with an example that you check the resources in your account to ensure that the teardown function worked as expected and didn't accidentally leave anything behind.
To run the examples, you need to create a shared credentials file. For more information about how to set up a shared credentials file, see `Configuration and Credential File Settings < https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_ in the AWS CLI User Guide.
For detailed information, see Installing the AWS CLI.
For detailed documentation for the AWS CLI, see the following:
All content in this repository, unless otherwise stated, is Copyright © Amazon Web Services, Inc. or its affiliates. All rights reserved.
Except where otherwise noted, all examples in this collection are licensed under the Apache license, version 2.0 (the "License"). The full license text is provided in the LICENSE file accompanying this repository.