Skip to content

Commit 763807b

Browse files
authored
Tools: Update drifted READMEs (#7506)
* Fix READMEs that have drifted. * Updates to READMEs.
1 parent ea52583 commit 763807b

File tree

41 files changed

+351
-468
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+351
-468
lines changed

dotnetv3/Aurora/README.md

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -28,39 +28,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2828

2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
31-
32-
### Get started
33-
34-
- [Hello Aurora](Actions/HelloAurora.cs#L4) (`DescribeDBClusters`)
35-
36-
37-
### Basics
38-
39-
Code examples that show you how to perform the essential operations within a service.
40-
41-
- [Learn the basics](Scenarios/AuroraScenario.cs)
42-
43-
44-
### Single actions
45-
46-
Code excerpts that show you how to call individual service functions.
47-
48-
- [CreateDBCluster](Actions/AuroraWrapper.cs#L199)
49-
- [CreateDBClusterParameterGroup](Actions/AuroraWrapper.cs#L41)
50-
- [CreateDBClusterSnapshot](Actions/AuroraWrapper.cs#L320)
51-
- [CreateDBInstance](Actions/AuroraWrapper.cs#L286)
52-
- [DeleteDBCluster](Actions/AuroraWrapper.cs#L367)
53-
- [DeleteDBClusterParameterGroup](Actions/AuroraWrapper.cs#L181)
54-
- [DeleteDBInstance](Actions/AuroraWrapper.cs#L386)
55-
- [DescribeDBClusterParameterGroups](Actions/AuroraWrapper.cs#L98)
56-
- [DescribeDBClusterParameters](Actions/AuroraWrapper.cs#L66)
57-
- [DescribeDBClusterSnapshots](Actions/AuroraWrapper.cs#L340)
58-
- [DescribeDBClusters](Actions/AuroraWrapper.cs#L259)
59-
- [DescribeDBEngineVersions](Actions/AuroraWrapper.cs#L21)
60-
- [DescribeDBInstances](Actions/AuroraWrapper.cs#L236)
61-
- [DescribeOrderableDBInstanceOptions](Actions/AuroraWrapper.cs#L154)
62-
- [ModifyDBClusterParameterGroup](Actions/AuroraWrapper.cs#L115)
63-
6431
### Scenarios
6532

6633
Code examples that show you how to accomplish a specific task by calling multiple
@@ -97,26 +64,6 @@ Alternatively, you can run the example from within your IDE.
9764
<!--custom.instructions.start-->
9865
<!--custom.instructions.end-->
9966

100-
#### Hello Aurora
101-
102-
This example shows you how to get started using Aurora.
103-
104-
105-
#### Learn the basics
106-
107-
This example shows you how to do the following:
108-
109-
- Create a custom Aurora DB cluster parameter group and set parameter values.
110-
- Create a DB cluster that uses the parameter group.
111-
- Create a DB instance that contains a database.
112-
- Take a snapshot of the DB cluster, then clean up resources.
113-
114-
<!--custom.basic_prereqs.aurora_Scenario_GetStartedClusters.start-->
115-
<!--custom.basic_prereqs.aurora_Scenario_GetStartedClusters.end-->
116-
117-
118-
<!--custom.basics.aurora_Scenario_GetStartedClusters.start-->
119-
<!--custom.basics.aurora_Scenario_GetStartedClusters.end-->
12067

12168

12269
#### Create an Aurora Serverless work item tracker
@@ -157,4 +104,4 @@ in the `dotnetv3` folder.
157104

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

160-
SPDX-License-Identifier: Apache-2.0
107+
SPDX-License-Identifier: Apache-2.0

dotnetv3/AutoScaling/README.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,12 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32-
### Get started
33-
34-
- [Hello Auto Scaling](Actions/HelloAutoScaling.cs#L4) (`DescribeAutoScalingGroups`)
35-
36-
37-
### Basics
38-
39-
Code examples that show you how to perform the essential operations within a service.
40-
41-
- [Learn the basics](Scenarios/AutoScalingBasics/AutoScalingBasics.cs)
42-
43-
4432
### Single actions
4533

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

4836
- [AttachLoadBalancerTargetGroups](../cross-service/ResilientService/AutoScalerActions/AutoScalerWrapper.cs#L890)
49-
- [CreateAutoScalingGroup](Actions/AutoScalingWrapper.cs#L28)
5037
- [DeleteAutoScalingGroup](../cross-service/ResilientService/AutoScalerActions/AutoScalerWrapper.cs#L693)
51-
- [DescribeAutoScalingGroups](Actions/AutoScalingWrapper.cs#L109)
52-
- [DescribeAutoScalingInstances](Actions/AutoScalingWrapper.cs#L109)
53-
- [DescribeScalingActivities](Actions/AutoScalingWrapper.cs#L86)
54-
- [DisableMetricsCollection](Actions/AutoScalingWrapper.cs#L202)
55-
- [EnableMetricsCollection](Actions/AutoScalingWrapper.cs#L223)
56-
- [SetDesiredCapacity](Actions/AutoScalingWrapper.cs#L249)
57-
- [TerminateInstanceInAutoScalingGroup](Actions/AutoScalingWrapper.cs#L275)
58-
- [UpdateAutoScalingGroup](Actions/AutoScalingWrapper.cs#L306)
5938

6039
### Scenarios
6140

@@ -93,44 +72,6 @@ Alternatively, you can run the example from within your IDE.
9372
<!--custom.instructions.start-->
9473
<!--custom.instructions.end-->
9574

96-
#### Hello Auto Scaling
97-
98-
This example shows you how to get started using Auto Scaling.
99-
100-
101-
#### Learn the basics
102-
103-
This example shows you how to do the following:
104-
105-
- Create an Amazon EC2 Auto Scaling group with a launch template and Availability Zones, and get information about running instances.
106-
- Enable Amazon CloudWatch metrics collection.
107-
- Update the group's desired capacity and wait for an instance to start.
108-
- Terminate an instance in the group.
109-
- List scaling activities that occur in response to user requests and capacity changes.
110-
- Get statistics for CloudWatch metrics, then clean up resources.
111-
112-
<!--custom.basic_prereqs.auto-scaling_Scenario_GroupsAndInstances.start-->
113-
<!--custom.basic_prereqs.auto-scaling_Scenario_GroupsAndInstances.end-->
114-
115-
116-
<!--custom.basics.auto-scaling_Scenario_GroupsAndInstances.start-->
117-
##### Configuration settings
118-
119-
This example uses several configuration settings that are stored in `settings.json`
120-
to change the existing values.
121-
122-
Note: The image ID, instance type, and Availability Zone must be available in the same AWS Region as the account that's
123-
used to run the scenario. For information about how to get valid settings, see [Find a Linux AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html).
124-
125-
* `GroupName` - The name to use for the Auto Scaling group.
126-
* `ImageId` - The image ID to use with the Amazon EC2 Auto Scaling template. The AMI-ID column of the Amazon EC2 image locator table.
127-
* `InstanceType` - The instance type to use with the template. The Instance Type column of the Amazon EC2 image locator table.
128-
* `LaunchTemplateName` - The name of the launch template.
129-
* `AvailabilityZone` - The Availability Zone for the launch template. The Zone column of the Amazon EC2 image locator table.
130-
* `ServiceLinkedRoleArn` - The Amazon Resource Name (ARN) of a serivce-linked role that will be used
131-
to create the Auto Scaling group.
132-
133-
<!--custom.basics.auto-scaling_Scenario_GroupsAndInstances.end-->
13475

13576

13677
#### Build and manage a resilient service
@@ -177,4 +118,4 @@ in the `dotnetv3` folder.
177118

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

180-
SPDX-License-Identifier: Apache-2.0
121+
SPDX-License-Identifier: Apache-2.0

dotnetv3/Bedrock-runtime/README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,6 @@ functions within the same service.
3535

3636
- [Tool use with the Converse API](Scenarios/ConverseToolScenario/ConverseToolScenario.cs)
3737

38-
### AI21 Labs Jurassic-2
39-
40-
- [Converse](Models/Ai21LabsJurassic2/Converse/Converse.cs#L4)
41-
- [InvokeModel](Models/Ai21LabsJurassic2/InvokeModel/InvokeModel.cs#L4)
42-
4338
### Amazon Nova
4439

4540
- [Converse](Models/AmazonNova/AmazonNovaText/Converse/Converse.cs#L4)
@@ -52,38 +47,26 @@ functions within the same service.
5247

5348
### Amazon Titan Text
5449

55-
- [Converse](Models/AmazonTitanText/Converse/Converse.cs#L4)
56-
- [ConverseStream](Models/AmazonTitanText/ConverseStream/ConverseStream.cs#L4)
57-
- [InvokeModel](Models/AmazonTitanText/InvokeModel/InvokeModel.cs#L4)
5850
- [InvokeModelWithResponseStream](Models/AmazonTitanText/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
5951

6052
### Anthropic Claude
6153

62-
- [Converse](Models/AnthropicClaude/Converse/Converse.cs#L4)
63-
- [ConverseStream](Models/AnthropicClaude/ConverseStream/ConverseStream.cs#L4)
64-
- [InvokeModel](Models/AnthropicClaude/InvokeModel/InvokeModel.cs#L4)
6554
- [InvokeModelWithResponseStream](Models/AnthropicClaude/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
6655

6756
### Cohere Command
6857

69-
- [Converse](Models/CohereCommand/Converse/Converse.cs#L4)
70-
- [ConverseStream](Models/CohereCommand/ConverseStream/ConverseStream.cs#L4)
7158
- [InvokeModel: Command R and R+](Models/CohereCommand/Command_R_InvokeModel/InvokeModel.cs#L4)
7259
- [InvokeModel: Command and Command Light](Models/CohereCommand/Command_InvokeModel/InvokeModel.cs#L4)
7360
- [InvokeModelWithResponseStream: Command R and R+](Models/CohereCommand/Command_R_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
7461
- [InvokeModelWithResponseStream: Command and Command Light](Models/CohereCommand/Command_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
7562

7663
### Meta Llama
7764

78-
- [Converse](Models/MetaLlama/Converse/Converse.cs#L4)
79-
- [ConverseStream](Models/MetaLlama/ConverseStream/ConverseStream.cs#L4)
8065
- [InvokeModel](Models/MetaLlama/Llama3_InvokeModel/InvokeModel.cs#L4)
8166
- [InvokeModelWithResponseStream](Models/MetaLlama/Llama3_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
8267

8368
### Mistral AI
8469

85-
- [Converse](Models/Mistral/Converse/Converse.cs#L4)
86-
- [ConverseStream](Models/Mistral/ConverseStream/ConverseStream.cs#L4)
8770
- [InvokeModel](Models/Mistral/InvokeModel/InvokeModel.cs#L4)
8871
- [InvokeModelWithResponseStream](Models/Mistral/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
8972

dotnetv3/CloudWatch/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ To enable billing metrics and statistics for these examples, make sure to
3131
[enable billing alerts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html#turning_on_billing_metrics) for your account.
3232
<!--custom.prerequisites.end-->
3333

34-
### Get started
35-
36-
- [Hello CloudWatch](Actions/HelloCloudWatch.cs#L4) (`ListMetrics`)
37-
38-
3934
### Basics
4035

4136
Code examples that show you how to perform the essential operations within a service.
@@ -96,10 +91,6 @@ Alternatively, you can run the example from within your IDE.
9691
<!--custom.instructions.start-->
9792
<!--custom.instructions.end-->
9893

99-
#### Hello CloudWatch
100-
101-
This example shows you how to get started using CloudWatch.
102-
10394

10495
#### Learn the basics
10596

@@ -147,4 +138,4 @@ in the `dotnetv3` folder.
147138

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

150-
SPDX-License-Identifier: Apache-2.0
141+
SPDX-License-Identifier: Apache-2.0

dotnetv3/Cognito/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ Code excerpts that show you how to call individual service functions.
5050
- [ConfirmDevice](Actions/CognitoWrapper.cs#L241)
5151
- [ConfirmSignUp](Actions/CognitoWrapper.cs#L213)
5252
- [InitiateAuth](Actions/CognitoWrapper.cs#L184)
53-
- [ListUserPools](Actions/CognitoWrapper.cs#L25)
5453
- [ListUsers](Actions/CognitoWrapper.cs#L46)
5554
- [ResendConfirmationCode](Actions/CognitoWrapper.cs#L264)
5655
- [SignUp](Actions/CognitoWrapper.cs#L311)
@@ -135,4 +134,4 @@ in the `dotnetv3` folder.
135134

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

138-
SPDX-License-Identifier: Apache-2.0
137+
SPDX-License-Identifier: Apache-2.0

dotnetv3/EC2/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32-
### Get started
33-
34-
- [Hello Amazon EC2](Actions/HelloEC2.cs#L4) (`DescribeSecurityGroups`)
35-
36-
3732
### Basics
3833

3934
Code examples that show you how to perform the essential operations within a service.
@@ -107,10 +102,6 @@ Alternatively, you can run the example from within your IDE.
107102
<!--custom.instructions.start-->
108103
<!--custom.instructions.end-->
109104

110-
#### Hello Amazon EC2
111-
112-
This example shows you how to get started using Amazon EC2.
113-
114105

115106
#### Learn the basics
116107

@@ -174,4 +165,4 @@ in the `dotnetv3` folder.
174165

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

177-
SPDX-License-Identifier: Apache-2.0
168+
SPDX-License-Identifier: Apache-2.0

dotnetv3/ECS/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32-
### Get started
33-
34-
- [Hello Amazon ECS](ECSActions/HelloECS.cs#L4) (`ListClusters`)
35-
36-
3732
### Single actions
3833

3934
Code excerpts that show you how to call individual service functions.
@@ -78,10 +73,6 @@ Alternatively, you can run the example from within your IDE.
7873
<!--custom.instructions.start-->
7974
<!--custom.instructions.end-->
8075

81-
#### Hello Amazon ECS
82-
83-
This example shows you how to get started using Amazon ECS.
84-
8576

8677

8778
#### Get ARN information for clusters, services, and tasks
@@ -125,4 +116,4 @@ in the `dotnetv3` folder.
125116

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

128-
SPDX-License-Identifier: Apache-2.0
119+
SPDX-License-Identifier: Apache-2.0

javascriptv3/example_code/entityresolution/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javas
3838

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

41+
- [CheckWorkflowStatus](actions/check-workflow-status.js#L4)
4142
- [CreateMatchingWorkflow](actions/create-matching-workflow.js#L4)
4243
- [CreateSchemaMapping](actions/create-schema-mapping.js#L4)
4344
- [DeleteMatchingWorkflow](actions/delete-matching-workflow.js#L4)

javav2/example_code/acm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Code excerpts that show you how to call individual service functions.
3737
- [DeleteCertificate](src/main/java/com/example/acm/DeleteCert.java#L10)
3838
- [DescribeCertificate](src/main/java/com/example/acm/DescribeCert.java#L11)
3939
- [ExportCertificate](src/main/java/com/example/acm/ExportCertificate.java#L20)
40-
- [ImportCertificate](src/main/java/com/example/acm/ImportCert.java#L16)
40+
- [ImportCertificate](src/main/java/com/example/acm/ImportCert.java#L21)
4141
- [ListCertificates](src/main/java/com/example/acm/ListCerts.java#L12)
4242
- [ListTagsForCertificate](src/main/java/com/example/acm/ListCertTags.java#L13)
4343
- [RemoveTagsFromCertificate](src/main/java/com/example/acm/RemoveTagsFromCert.java#L13)
@@ -84,4 +84,4 @@ in the `javav2` folder.
8484

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

87-
SPDX-License-Identifier: Apache-2.0
87+
SPDX-License-Identifier: Apache-2.0

javav2/example_code/bedrock-runtime/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
3434
> see [Model access](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html).
3535
>
3636
<!--custom.prerequisites.end-->
37-
3837
### Scenarios
3938

4039
Code examples that show you how to accomplish a specific task by calling multiple
@@ -121,10 +120,11 @@ functions within the same service.
121120
<!--custom.instructions.start-->
122121
<!--custom.instructions.end-->
123122

123+
124+
124125
#### Generate videos from text prompts using Amazon Bedrock
125126

126-
This example shows you how to a Spring Boot app that generates videos from text prompts using Amazon Bedrock and the
127-
Nova-Reel model.
127+
This example shows you how to a Spring Boot app that generates videos from text prompts using Amazon Bedrock and the Nova-Reel model.
128128

129129

130130
<!--custom.scenario_prereqs.bedrock-runtime_Scenario_GenerateVideos_NovaReel.start-->
@@ -136,9 +136,7 @@ Nova-Reel model.
136136

137137
#### Tool use with the Converse API
138138

139-
This example shows you how to build a typical interaction between an application, a generative AI model, and connected
140-
tools or APIs to mediate interactions between the AI and the outside world. It uses the example of connecting an
141-
external weather API to the AI model so it can provide real-time weather information based on user input.
139+
This example shows you how to build a typical interaction between an application, a generative AI model, and connected tools or APIs to mediate interactions between the AI and the outside world. It uses the example of connecting an external weather API to the AI model so it can provide real-time weather information based on user input.
142140

143141

144142
<!--custom.scenario_prereqs.bedrock-runtime_Scenario_ToolUse.start-->

javav2/example_code/ec2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Code excerpts that show you how to call individual service functions.
5353
- [DeleteKeyPair](src/main/java/com/example/ec2/scenario/EC2Actions.java#L106)
5454
- [DeleteSecurityGroup](src/main/java/com/example/ec2/scenario/EC2Actions.java#L132)
5555
- [DescribeInstanceTypes](src/main/java/com/example/ec2/scenario/EC2Actions.java#L356)
56-
- [DescribeInstances](src/main/java/com/example/ec2/scenario/EC2Actions.java#L402)
56+
- [DescribeInstances](src/main/java/com/example/ec2/scenario/EC2Actions.java#L285)
5757
- [DescribeKeyPairs](src/main/java/com/example/ec2/scenario/EC2Actions.java#L566)
5858
- [DescribeSecurityGroups](src/main/java/com/example/ec2/scenario/EC2Actions.java#L468)
5959
- [DisassociateAddress](src/main/java/com/example/ec2/scenario/EC2Actions.java#L207)
@@ -150,4 +150,4 @@ in the `javav2` folder.
150150

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

153-
SPDX-License-Identifier: Apache-2.0
153+
SPDX-License-Identifier: Apache-2.0

javav2/example_code/firehose/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
3333

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

36-
- [PutRecord](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L92)
37-
- [PutRecordBatch](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L125)
36+
- [PutRecord](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L98)
37+
- [PutRecordBatch](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L131)
3838

3939
### Scenarios
4040

0 commit comments

Comments
 (0)