Skip to content

Commit 8c5e8a9

Browse files
authored
Merge branch 'awsdocs:main' into main
2 parents 05cfaac + 103927a commit 8c5e8a9

File tree

199 files changed

+5386
-629
lines changed

Some content is hidden

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

199 files changed

+5386
-629
lines changed

.doc_gen/metadata/batch_metadata.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,6 @@ batch_CreateComputeEnvironment:
174174
services:
175175
batch: {CreateComputeEnvironment}
176176
batch_Scenario:
177-
title: Learn core operations for'&BATCHlong; using an &AWS; SDK
178-
title_abbrev: Learn &BATCH; core operations
179177
synopsis_list:
180178
- Create an &BATCH; compute environment.
181179
- Check the status of the compute environment.
@@ -185,7 +183,7 @@ batch_Scenario:
185183
- Get a list of jobs applicable to the job queue.
186184
- Check the status of job.
187185
- Delete &BATCH; resources.
188-
category: Scenarios
186+
category: Basics
189187
languages:
190188
Java:
191189
versions:

.doc_gen/metadata/bedrock-runtime_metadata.yaml

Lines changed: 208 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ bedrock-runtime_Hello:
2121
- description:
2222
snippet_files:
2323
- javascriptv3/example_code/bedrock-runtime/hello.js
24+
25+
Python:
26+
versions:
27+
- sdk_version: 3
28+
github: python/example_code/bedrock-runtime
29+
sdkguide:
30+
excerpts:
31+
- description: Send a prompt to a model with the InvokeModel operation.
32+
snippet_tags:
33+
- bedrock-runtime.example_code.hello_bedrock_invoke.complete
34+
- description: Send a user message to a model with the Converse operation.
35+
snippet_tags:
36+
- bedrock-runtime.example_code.hello_bedrock_converse.complete
37+
2438
services:
2539
bedrock-runtime: {InvokeModel}
2640

@@ -69,6 +83,46 @@ bedrock-runtime_Converse_Ai21LabsJurassic2:
6983
services:
7084
bedrock-runtime: {Converse}
7185

86+
bedrock-runtime_Converse_AmazonNovaText:
87+
title: Invoke Amazon Nova on &BR; using Bedrock's Converse API
88+
title_abbrev: "Converse"
89+
synopsis: send a text message to Amazon Nova, using Bedrock's Converse API.
90+
category: Amazon Nova
91+
languages:
92+
Java:
93+
versions:
94+
- sdk_version: 2
95+
github: javav2/example_code/bedrock-runtime
96+
excerpts:
97+
- description: Send a text message to Amazon Nova using Bedrock's Converse API with the async Java client.
98+
snippet_tags:
99+
- bedrock-runtime.java2.ConverseAsync_AmazonNovaText
100+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
101+
snippet_tags:
102+
- bedrock-runtime.java2.Converse_AmazonNovaText
103+
.NET:
104+
versions:
105+
- sdk_version: 3
106+
github: dotnetv3/Bedrock-runtime
107+
excerpts:
108+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
109+
snippet_tags:
110+
- BedrockRuntime.dotnetv3.Converse_AmazonNovaText
111+
- description: Send a conversation of messages to Amazon Nova using Bedrock's Converse API with a tool configuration.
112+
genai: some
113+
snippet_tags:
114+
- Bedrock.ConverseTool.dotnetv3.SendConverseRequest
115+
Python:
116+
versions:
117+
- sdk_version: 3
118+
github: python/example_code/bedrock-runtime
119+
excerpts:
120+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
121+
snippet_tags:
122+
- python.example_code.bedrock-runtime.Converse_AmazonNovaText
123+
services:
124+
bedrock-runtime: {Converse}
125+
72126
bedrock-runtime_Converse_AmazonTitanText:
73127
title: Invoke Amazon Titan Text on &BR; using Bedrock's Converse API
74128
title_abbrev: "Converse"
@@ -113,6 +167,60 @@ bedrock-runtime_Converse_AmazonTitanText:
113167
services:
114168
bedrock-runtime: {Converse}
115169

170+
bedrock-runtime_Scenario_ToolUse:
171+
title: "A tool use example illustrating how to connect AI models on &BR; with a custom tool or API"
172+
title_abbrev: "Tool use with the Converse API"
173+
synopsis: "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."
174+
category: Scenarios
175+
languages:
176+
.NET:
177+
versions:
178+
- sdk_version: 3
179+
github: dotnetv3/Bedrock-runtime/Scenarios/ConverseToolScenario
180+
excerpts:
181+
- description: "The primary execution of the scenario flow. This scenario orchestrates the conversation between the user, the &BR; Converse API, and a weather tool."
182+
genai: some
183+
snippet_tags:
184+
- Bedrock.ConverseTool.dotnetv3.Scenario
185+
- description: "The weather tool used by the demo. This file defines the tool specification and implements the logic to retrieve weather data using from the Open-Meteo API."
186+
genai: some
187+
snippet_tags:
188+
- Bedrock.ConverseTool.dotnetv3.WeatherTool
189+
- description: "The Converse API action with a tool configuration."
190+
genai: some
191+
snippet_tags:
192+
- Bedrock.ConverseTool.dotnetv3.SendConverseRequest
193+
Python:
194+
versions:
195+
- sdk_version: 3
196+
github: python/example_code/bedrock-runtime
197+
excerpts:
198+
- description: "The primary execution script of the demo. This script orchestrates the conversation between the user, the &BR; Converse API, and a weather tool."
199+
snippet_files:
200+
- python/example_code/bedrock-runtime/cross-model-scenarios/tool_use_demo/tool_use_demo.py
201+
- description: "The weather tool used by the demo. This script defines the tool specification and implements the logic to retrieve weather data using from the Open-Meteo API."
202+
snippet_files:
203+
- python/example_code/bedrock-runtime/cross-model-scenarios/tool_use_demo/weather_tool.py
204+
Rust:
205+
versions:
206+
- sdk_version: 1
207+
github: rustv1/examples/bedrock-runtime
208+
excerpts:
209+
- description: "The primary scenario and logic for the demo. This orchestrates the conversation between the user, the &BR; Converse API, and a weather tool."
210+
snippet_tags:
211+
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use
212+
- description: "The weather tool used by the demo. This script defines the tool specification and implements the logic to retrieve weather data using from the Open-Meteo API."
213+
snippet_tags:
214+
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.weather-tool
215+
- description: "Utilities to print the Message Content Blocks."
216+
snippet_tags:
217+
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.user-interface
218+
- description: "Use statements, Error utility, and constants."
219+
snippet_tags:
220+
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.supporting
221+
services:
222+
bedrock-runtime: {Converse}
223+
116224
bedrock-runtime_Converse_AnthropicClaude:
117225
title: Invoke Anthropic Claude on &BR; using Bedrock's Converse API
118226
title_abbrev: "Converse"
@@ -301,6 +409,39 @@ bedrock-runtime_Converse_Mistral:
301409
bedrock-runtime: {Converse}
302410

303411
# Converse Stream
412+
bedrock-runtime_ConverseStream_AmazonNovaText:
413+
title: Invoke Amazon Nova on &BR; using Bedrock's Converse API with a response stream
414+
title_abbrev: "ConverseStream"
415+
synopsis: send a text message to Amazon Nova, using Bedrock's Converse API and process the response stream in real-time.
416+
category: Amazon Nova
417+
languages:
418+
Java:
419+
versions:
420+
- sdk_version: 2
421+
github: javav2/example_code/bedrock-runtime
422+
excerpts:
423+
- description: Send a text message to Amazon Nova using Bedrock's Converse API and process the response stream in real-time.
424+
snippet_tags:
425+
- bedrock-runtime.java2.ConverseStream_AmazonNovaText
426+
.NET:
427+
versions:
428+
- sdk_version: 3
429+
github: dotnetv3/Bedrock-runtime
430+
excerpts:
431+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API and process the response stream in real-time.
432+
snippet_tags:
433+
- BedrockRuntime.dotnetv3.ConverseStream_AmazonNovaText
434+
Python:
435+
versions:
436+
- sdk_version: 3
437+
github: python/example_code/bedrock-runtime
438+
excerpts:
439+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API and process the response stream in real-time.
440+
snippet_tags:
441+
- python.example_code.bedrock-runtime.ConverseStream_AmazonNovaText
442+
services:
443+
bedrock-runtime: {ConverseStream}
444+
304445
bedrock-runtime_ConverseStream_AmazonTitanText:
305446
title: Invoke Amazon Titan Text on &BR; using Bedrock's Converse API with a response stream
306447
title_abbrev: "ConverseStream"
@@ -590,6 +731,14 @@ bedrock-runtime_InvokeModel_TitanText:
590731
- description: Use the Invoke Model API to send a text message.
591732
snippet_tags:
592733
- bedrock-runtime.java2.InvokeModel_AmazonTitanText
734+
Kotlin:
735+
versions:
736+
- sdk_version: 1
737+
github: kotlin/services/bedrock-runtime
738+
excerpts:
739+
- description: Use the Invoke Model API to generate a short story.
740+
snippet_tags:
741+
- bedrock-runtime.kotlin.InvokeModel_AmazonTitanText
593742
.NET:
594743
versions:
595744
- sdk_version: 3
@@ -1072,6 +1221,39 @@ bedrock-runtime_InvokeModelWithResponseStream_MistralAi:
10721221
bedrock-runtime: {InvokeModelWithResponseStream}
10731222

10741223
# Image Generation Models
1224+
bedrock-runtime_InvokeModel_AmazonNovaImageGeneration:
1225+
title: Invoke Amazon Nova Canvas on &BR; to generate an image
1226+
title_abbrev: "InvokeModel"
1227+
synopsis: invoke Amazon Nova Canvas on &BR; to generate an image.
1228+
category: Amazon Nova Canvas
1229+
languages:
1230+
Java:
1231+
versions:
1232+
- sdk_version: 2
1233+
github: javav2/example_code/bedrock-runtime
1234+
excerpts:
1235+
- description: Create an image with Amazon Nova Canvas.
1236+
snippet_tags:
1237+
- bedrock-runtime.java2.InvokeModel_AmazonNovaImageGeneration
1238+
.NET:
1239+
versions:
1240+
- sdk_version: 3
1241+
github: dotnetv3/Bedrock-runtime
1242+
excerpts:
1243+
- description: Create an image with Amazon Nova Canvas.
1244+
snippet_tags:
1245+
- BedrockRuntime.dotnetv3.InvokeModel_AmazonNovaImageGeneration
1246+
Python:
1247+
versions:
1248+
- sdk_version: 3
1249+
github: python/example_code/bedrock-runtime
1250+
excerpts:
1251+
- description: Create an image with the Amazon Nova Canvas.
1252+
snippet_tags:
1253+
- python.example_code.bedrock-runtime.InvokeModel_AmazonNovaImageGeneration
1254+
services:
1255+
bedrock-runtime: {InvokeModel}
1256+
10751257
bedrock-runtime_InvokeModel_TitanImageGenerator:
10761258
title: Invoke Amazon Titan Image on &BR; to generate an image
10771259
title_abbrev: "InvokeModel"
@@ -1191,6 +1373,32 @@ bedrock-runtime_InvokeModelWithResponseStream_TitanTextEmbeddings:
11911373
bedrock-runtime: {InvokeModel}
11921374

11931375
# Tool use scenarios
1376+
bedrock-runtime_Scenario_ToolUseDemo_AmazonNova:
1377+
title: "A tool use demo illustrating how to connect AI models on &BR; with a custom tool or API"
1378+
title_abbrev: "Scenario: Tool use with the Converse API"
1379+
synopsis: "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."
1380+
category: Amazon Nova
1381+
languages:
1382+
.NET:
1383+
versions:
1384+
- sdk_version: 3
1385+
github: dotnetv3/Bedrock-runtime/Scenarios/ConverseToolScenario
1386+
excerpts:
1387+
- description: "The primary execution of the scenario flow. This scenario orchestrates the conversation between the user, the &BR; Converse API, and a weather tool."
1388+
genai: some
1389+
snippet_tags:
1390+
- Bedrock.ConverseTool.dotnetv3.Scenario
1391+
- description: "The weather tool used by the demo. This file defines the tool specification and implements the logic to retrieve weather data using from the Open-Meteo API."
1392+
genai: some
1393+
snippet_tags:
1394+
- Bedrock.ConverseTool.dotnetv3.WeatherTool
1395+
- description: "The Converse API action with a tool configuration."
1396+
genai: some
1397+
snippet_tags:
1398+
- Bedrock.ConverseTool.dotnetv3.SendConverseRequest
1399+
services:
1400+
bedrock-runtime: {Converse}
1401+
11941402
bedrock-runtime_Scenario_ToolUseDemo_AnthropicClaude:
11951403
title: "A tool use demo illustrating how to connect AI models on &BR; with a custom tool or API"
11961404
title_abbrev: "Scenario: Tool use with the Converse API"
@@ -1225,7 +1433,6 @@ bedrock-runtime_Scenario_ToolUseDemo_AnthropicClaude:
12251433
- description: "Use statements, Error utility, and constants."
12261434
snippet_tags:
12271435
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.supporting
1228-
12291436
services:
12301437
bedrock-runtime: {Converse}
12311438

.doc_gen/metadata/iam_metadata.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -889,6 +889,15 @@ iam_UpdateAccessKey:
889889
- description:
890890
snippet_tags:
891891
- iam.cpp.update_access_key.code
892+
Bash:
893+
versions:
894+
- sdk_version: 2
895+
github: aws-cli/bash-linux/iam
896+
sdkguide:
897+
excerpts:
898+
- description:
899+
snippet_tags:
900+
- aws-cli.bash-linux.iam.UpdateAccessKey
892901
services:
893902
iam: {UpdateAccessKey}
894903
iam_Scenario_ManageAccessKeys:

.doc_gen/metadata/iot_metadata.yaml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,18 @@ iot_CreateThing:
429429
services:
430430
iot: {CreateThing}
431431
iot_Scenario:
432-
synopsis: work with &IoT; device management.
432+
synopsis_list:
433+
- Create an &IoT; Thing.
434+
- Generate a device certificate.
435+
- Update an &IoT; Thing with Attributes.
436+
- Return a unique endpoint.
437+
- List your &IoT; certificates.
438+
- Create an &IoT; shadow.
439+
- Write out state information.
440+
- Creates a rule.
441+
- List your rules.
442+
- Search things using the Thing name.
443+
- Delete an &IoT; Thing.
433444
category: Basics
434445
languages:
435446
Kotlin:

.doc_gen/metadata/iot_sitewise_metadata.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,16 @@ iotsitewise_CreateAssetModel:
444444
services:
445445
iotsitewise: {CreateAssetModel}
446446
iotsitewise_Scenario:
447-
synopsis: learn core operations for &ITSWlong; using an &AWS; SDK.
447+
synopsis_list:
448+
- Create an &ITSWlong; Asset Model.
449+
- Create an &ITSWlong; Asset.
450+
- Retrieve the property ID values.
451+
- Send data to an &ITSWlong; Asset.
452+
- Retrieve the value of the &ITSWlong; Asset property.
453+
- Create an &ITSWlong; Portal.
454+
- Create an &ITSWlong; Gateway.
455+
- Describe the &ITSWlong; Gateway.
456+
- Delete the &ITSWlong; Assets.
448457
category: Basics
449458
languages:
450459
Java:

.doc_gen/metadata/redshift_metadata.yaml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,14 @@ redshift_ExecuteStatement:
346346
services:
347347
redshift: {ExecuteStatement}
348348
redshift_Scenario:
349-
synopsis: learn core operations for &RS; using an &AWS; SDK.
349+
synopsis_list:
350+
- Create a Redshift cluster.
351+
- List databases in the cluster.
352+
- Create a table named Movies.
353+
- Populate the Movies table.
354+
- Query the Movies table by year.
355+
- Modify the Redshift cluster.
356+
- Delete the Amazon Redshift cluster.
350357
category: Basics
351358
languages:
352359
Go:

0 commit comments

Comments
 (0)