Skip to content

Commit 7370d44

Browse files
DavidSoutherDavidSouther
authored
README: 2024-04-08 (#6325)
1 parent 5f39c81 commit 7370d44

File tree

20 files changed

+952
-429
lines changed

20 files changed

+952
-429
lines changed

Diff for: ‎.doc_gen/validation.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ allow_list:
191191
- "src/main/kotlin/com/kotlin/iam/ListUsers"
192192
- "src/main/kotlin/com/kotlin/s3/CopyObject"
193193
- "src/test/java/example/firehose/PutRecord"
194+
- "src/main/kotlin/com/example/iot/HelloIoT"
194195
- "targetTrackingScalingPolicyConfiguration"
195196
- "upload_files_using_managed_file_uploader"
196197
- "videoMetaData=celebrityRecognitionResult"

Diff for: ‎cpp/example_code/cloudtrail/README.md

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# CloudTrail code examples for the SDK for C++
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for C++ to work with AWS CloudTrail.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_CloudTrail _
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
27+
28+
Before using the code examples, first complete the installation and setup steps
29+
for [Getting started](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html) in the AWS SDK for
30+
C++ Developer Guide.
31+
This section covers how to get and build the SDK, and how to build your own code by using the SDK with a
32+
sample Hello World-style application.
33+
34+
Next, for information on code example structures and how to build and run the examples, see [Getting 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).
35+
36+
37+
<!--custom.prerequisites.start-->
38+
<!--custom.prerequisites.end-->
39+
40+
<!--custom.examples.start-->
41+
<!--custom.examples.end-->
42+
43+
## Run the examples
44+
45+
### Instructions
46+
47+
An executable is built for each source file in this folder. These executables are located in the build folder and have
48+
"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions.
49+
50+
For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command
51+
will display any required arguments.
52+
53+
```
54+
./run_my_action
55+
```
56+
57+
If the source file is in a different folder, instructions can be found in the README in that
58+
folder.
59+
60+
<!--custom.instructions.start-->
61+
<!--custom.instructions.end-->
62+
63+
64+
65+
### Tests
66+
67+
⚠ Running tests might result in charges to your AWS account.
68+
69+
70+
71+
```sh
72+
cd <BUILD_DIR>
73+
cmake <path-to-root-of-this-source-code> -DBUILD_TESTS=ON
74+
make
75+
ctest
76+
```
77+
78+
79+
<!--custom.tests.start-->
80+
<!--custom.tests.end-->
81+
82+
## Additional resources
83+
84+
- [CloudTrail Developer Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html)
85+
- [CloudTrail API Reference](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/Welcome.html)
86+
- [SDK for C++ CloudTrail reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cloudtrail/html/annotated.html)
87+
88+
<!--custom.resources.start-->
89+
<!--custom.resources.end-->
90+
91+
---
92+
93+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
94+
95+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎dotnetv3/CloudFormation/README.md

+96-96
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,97 @@
1-
# CloudFormation code examples for the SDK for .NET
2-
3-
## Overview
4-
5-
Shows how to use the AWS SDK for .NET to work with AWS CloudFormation.
6-
7-
<!--custom.overview.start-->
8-
<!--custom.overview.end-->
9-
10-
_CloudFormation enables you to create and provision AWS infrastructure deployments predictably and repeatedly._
11-
12-
## ⚠ Important
13-
14-
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15-
* Running the tests might result in charges to your AWS account.
16-
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17-
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18-
19-
<!--custom.important.start-->
20-
<!--custom.important.end-->
21-
22-
## Code examples
23-
24-
### Prerequisites
25-
26-
For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3` folder.
27-
28-
29-
<!--custom.prerequisites.start-->
30-
<!--custom.prerequisites.end-->
31-
32-
### Get started
33-
34-
- [Hello CloudFormation](Actions/HelloCloudFormation.cs#L4) (`DescribeStackResources`)
35-
36-
37-
<!--custom.examples.start-->
38-
<!--custom.examples.end-->
39-
40-
## Run the examples
41-
42-
### Instructions
43-
44-
For general instructions to run the examples, see the
45-
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
46-
47-
Some projects might include a settings.json file. Before compiling the project,
48-
you can change these values to match your own account and resources. Alternatively,
49-
add a settings.local.json file with your local settings, which will be loaded automatically
50-
when the application runs.
51-
52-
After the example compiles, you can run it from the command line. To do so, navigate to
53-
the folder that contains the .csproj file and run the following command:
54-
55-
```
56-
dotnet run
57-
```
58-
59-
Alternatively, you can run the example from within your IDE.
60-
61-
62-
<!--custom.instructions.start-->
63-
<!--custom.instructions.end-->
64-
65-
#### Hello CloudFormation
66-
67-
This example shows you how to Get started using CloudFormation.
68-
69-
70-
71-
### Tests
72-
73-
⚠ Running tests might result in charges to your AWS account.
74-
75-
76-
To find instructions for running these tests, see the [README](../README.md#Tests)
77-
in the `dotnetv3` folder.
78-
79-
80-
81-
<!--custom.tests.start-->
82-
<!--custom.tests.end-->
83-
84-
## Additional resources
85-
86-
- [CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)
87-
- [CloudFormation API Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html)
88-
- [SDK for .NET CloudFormation reference](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudFormation/NCloudFormation.html)
89-
90-
<!--custom.resources.start-->
91-
<!--custom.resources.end-->
92-
93-
---
94-
95-
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
96-
1+
# CloudFormation code examples for the SDK for .NET
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for .NET to work with AWS CloudFormation.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_CloudFormation enables you to create and provision AWS infrastructure deployments predictably and repeatedly._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello CloudFormation](../CloudFormation/Actions/HelloCloudFormation.cs#L4) (`DescribeStackResources`)
35+
36+
37+
<!--custom.examples.start-->
38+
<!--custom.examples.end-->
39+
40+
## Run the examples
41+
42+
### Instructions
43+
44+
For general instructions to run the examples, see the
45+
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
46+
47+
Some projects might include a settings.json file. Before compiling the project,
48+
you can change these values to match your own account and resources. Alternatively,
49+
add a settings.local.json file with your local settings, which will be loaded automatically
50+
when the application runs.
51+
52+
After the example compiles, you can run it from the command line. To do so, navigate to
53+
the folder that contains the .csproj file and run the following command:
54+
55+
```
56+
dotnet run
57+
```
58+
59+
Alternatively, you can run the example from within your IDE.
60+
61+
62+
<!--custom.instructions.start-->
63+
<!--custom.instructions.end-->
64+
65+
#### Hello CloudFormation
66+
67+
This example shows you how to get started using CloudFormation.
68+
69+
70+
71+
### Tests
72+
73+
⚠ Running tests might result in charges to your AWS account.
74+
75+
76+
To find instructions for running these tests, see the [README](../README.md#Tests)
77+
in the `dotnetv3` folder.
78+
79+
80+
81+
<!--custom.tests.start-->
82+
<!--custom.tests.end-->
83+
84+
## Additional resources
85+
86+
- [CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)
87+
- [CloudFormation API Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html)
88+
- [SDK for .NET CloudFormation reference](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CloudFormation/NCloudFormation.html)
89+
90+
<!--custom.resources.start-->
91+
<!--custom.resources.end-->
92+
93+
---
94+
95+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
96+
9797
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javav2/example_code/bedrock-agent/README.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Agents for Amazon Bedrock code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with Agents for Amazon Bedrock.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Agents for Amazon Bedrock offer you the ability to build and configure autonomous agents in your application._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
<!--custom.examples.start-->
33+
<!--custom.examples.end-->
34+
35+
## Run the examples
36+
37+
### Instructions
38+
39+
40+
<!--custom.instructions.start-->
41+
<!--custom.instructions.end-->
42+
43+
44+
45+
### Tests
46+
47+
⚠ Running tests might result in charges to your AWS account.
48+
49+
50+
To find instructions for running these tests, see the [README](../../README.md#Tests)
51+
in the `javav2` folder.
52+
53+
54+
55+
<!--custom.tests.start-->
56+
<!--custom.tests.end-->
57+
58+
## Additional resources
59+
60+
- [Agents for Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html)
61+
- [Agents for Amazon Bedrock API Reference](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Operations_Agents_for_Amazon_Bedrock.html)
62+
- [SDK for Java 2.x Agents for Amazon Bedrock reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrock-agent/package-summary.html)
63+
64+
<!--custom.resources.start-->
65+
<!--custom.resources.end-->
66+
67+
---
68+
69+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
70+
71+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)