Blame: cpp/README.rst - awsdocs/aws-doc-sdk-examples

awsdocs / aws-doc-sdk-examples UNCLAIMED

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 1 Java

Normal View History Raw

Updating copyright to 2019 2019-01-02 11:29:52 -08:00			`.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.`

			`This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0`
			`International License (the "License"). You may not use this file except in compliance with the`
			`License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/.`

			`This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,`
			`either express or implied. See the License for the specific language governing permissions and`
			`limitations under the License.`

Update C++ README 2019-02-28 16:42:01 -08:00			`#############################`
			`AWS SDK for C++ Code Examples`
			`#############################`
Updating copyright to 2019 2019-01-02 11:29:52 -08:00
Update C++ README 2019-02-28 16:42:01 -08:00			`A collection of code examples for the AWS SDK for C++. The examples are grouped`
			`according to the AWS service they demonstrate.`
Updating copyright to 2019 2019-01-02 11:29:52 -08:00
			`Prerequisites`
			`=============`

code corrections and comments for usability 2021-05-05 18:51:55 -04:00			Before using the Code Examples, first complete the installation and setup steps of `Getting Started
			<https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html>`_ in the AWS SDK for C++
			`Developer Guide.`

another update to readme 2021-05-07 14:04:31 -04:00			`The Getting Started section covers how to obtain and build the SDK, and how to build your own`
issue 2022-12-30 10:51:50 -06:00			`code utilizing the SDK with a sample "Hello World"-style application. A similar procedure is`
update to readme 2021-05-07 16:35:47 -04:00			`applicable to utilizing the code examples in this repository.`

			`Building and running the code examples`
			`=============`
code corrections and comments for usability 2021-05-05 18:51:55 -04:00
C++: Add hello world documentation to language level README (#5209) * update service level README * Added comments for hello service * Editorial fixes 2023-08-08 13:03:15 -04:00			`The example code is organized in subfolders by AWS service.`
			`For example "example_code/s3" contains the Amazon Simple Storage Service (Amazon S3) code examples.`
update to readme 2021-05-07 16:35:47 -04:00
C++: Add hello world documentation to language level README (#5209) * update service level README * Added comments for hello service * Editorial fixes 2023-08-08 13:03:15 -04:00			`Examples that use multiple services are located in the [example_code/cross-service](example_code/cross-service) folder.`

			`The examples use the CMake build system. Every service subfolder contains a CMakeLists.txt file that builds all the examples for that service.`

			`To understand more about the example applications, see`
			`[Get started with the AWS SDK for C++ code examples](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html).`

			`Hello Service`
			`-----------`

			`Many of the services have a "Hello Service" folder with a starter project and README documentation.`
			`For example, the Amazon S3 Hello project is located at [example_code/s3/hello_s3](example_code/s3/hello_s3).`
Update README.rst 2022-12-30 05:27:09 -06:00
a whole hot mess of stuff 2022-12-29 10:37:34 -06:00			`Docker image (Beta)`
			`===================`

slight change to REAMDE#docker-image-beta (#4142) 2023-01-02 10:07:02 -06:00			`This example code will soon be available in a container image`
C++: Add hello world documentation to language level README (#5209) * update service level README * Added comments for hello service * Editorial fixes 2023-08-08 13:03:15 -04:00			`hosted on [Amazon Elastic Container Registry (ECR)](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html). This image will be preloaded`
a whole hot mess of stuff 2022-12-29 10:37:34 -06:00			`with all C++ examples with dependencies pre-resolved, allowing you to explore`
			`these examples in an isolated environment.`

Fix incorrect aliases (#4386) * fix aliases * adding back broken Rust example 2023-02-16 11:37:47 -06:00			`As of January 2023, the [SDK for C++ image](https://gallery.ecr.aws/b4v4v1s0/cpp) is available on ECR Public but is still`
a whole hot mess of stuff 2022-12-29 10:37:34 -06:00			`undergoing active development. Refer to`
			`[this GitHub issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/4133)`
			`for more information.`

Testing - All languages - Remediate Dockerfiles (#5416) 2023-10-03 15:36:27 -04:00			`Build steps`
			`-----------`
			`To build the docker image, run the following command from the shell. This command must be run in`
CPP: tests updates (#5625) * adding mocks 2023-11-08 16:05:41 -05:00			`the "aws-doc-sdk-examples/cpp" directory.`
Testing - All languages - Remediate Dockerfiles (#5416) 2023-10-03 15:36:27 -04:00
			`.. code-block:: bash`

CPP: tests updates (#5625) * adding mocks 2023-11-08 16:05:41 -05:00			`docker build -t <container_tag> .`
Testing - All languages - Remediate Dockerfiles (#5416) 2023-10-03 15:36:27 -04:00
			`The following command will run the docker image, copying your AWS credentials.`

			`.. code-block:: bash`

			`docker run -it --volume ~/.aws/credentials:/home/tests/.aws/credentials <container_tag>`

4162 document c++ dependencies build steps (#4612) * Updating language level ReadMe * more documentation * editorial fixes 2023-03-31 10:30:36 -04:00			`Automated tests`
			`===================`

			`The automated tests for C++ examples can be run using the Python script [run_automated_tests.py](run_automated_tests.py). The script contains instructions for its use.`

			`For information about the dependencies needed to run the examples, see the [DockerFile](Dockerfile).`
Update README.rst 2022-12-30 05:27:09 -06:00
update to readme 2021-05-07 16:35:47 -04:00			`Additional information`
			`=============`

			- As an AWS best practice, grant all code least privilege, or only the permissions required to perform a task. For more information, see `Grant Least Privilege
			<https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege>`_ in the AWS Identity and Access Management User Guide.

			- This code has not been tested in all AWS Regions. Some AWS services are available only in specific Regions. For more information, see `Region
			Table <https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/>`_ on the AWS website.

			`- Running this code might result in charges to your AWS account.`

			`- To propose a new code example for the AWS documentation team to consider producing, create a`
			`new request. The team is looking to produce code examples that cover broader scenarios and use`
			`cases, versus simple code snippets that cover only individual API calls. For instructions, see`
issue 2022-12-30 10:51:50 -06:00			`the Proposing new code examples section in the`
update to readme 2021-05-07 16:35:47 -04:00			`Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_.

			`Copyright and License`
			`=============`

			`All content in this repository, unless otherwise stated, is`
Update README.rst 2022-12-30 10:59:28 -06:00			`Copyright © Amazon Web Services, Inc. or its affiliates. All rights reserved.`
update to readme 2021-05-07 16:35:47 -04:00
			Except where otherwise noted, all examples in this collection are licensed under the `Apache
			license, version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_ (the "License"). The full
			license text is provided in the `LICENSE` file accompanying this repository.