Skip to content

Commit 18ab4a5

Browse files
monadierickxbrmur
authored andcommitted
Regenerate documentation
1 parent f926952 commit 18ab4a5

File tree

2 files changed

+87
-1
lines changed

2 files changed

+87
-1
lines changed

.doc_gen/metadata/bedrock-runtime_metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ bedrock-runtime_Converse_AmazonNovaText:
134134
- python.example_code.bedrock-runtime.Converse_AmazonNovaText
135135
Swift:
136136
versions:
137-
- sdk_version: 3
137+
- sdk_version: 1
138138
github: swift/example_code/bedrock-runtime
139139
excerpts:
140140
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Amazon Bedrock Runtime code examples for the SDK for Swift
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Swift to work with Amazon Bedrock Runtime.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon Bedrock Runtime is a fully managed service that makes it easy to use foundation models from third-party providers and Amazon._
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 `swift` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
### Amazon Nova
32+
33+
- [Converse](models/amazon-nova/amazon-nova-text/Sources/Converse/main.swift#L6)
34+
35+
36+
<!--custom.examples.start-->
37+
<!--custom.examples.end-->
38+
39+
## Run the examples
40+
41+
### Instructions
42+
43+
To build any of these examples from a terminal window, navigate into its
44+
directory, then use the following command:
45+
46+
```
47+
$ swift build
48+
```
49+
50+
To build one of these examples in Xcode, navigate to the example's directory
51+
(such as the `ListUsers` directory, to build that example). Then type `xed.`
52+
to open the example directory in Xcode. You can then use standard Xcode build
53+
and run commands.
54+
55+
<!--custom.instructions.start-->
56+
<!--custom.instructions.end-->
57+
58+
59+
60+
### Tests
61+
62+
⚠ Running tests might result in charges to your AWS account.
63+
64+
65+
To find instructions for running these tests, see the [README](../../README.md#Tests)
66+
in the `swift` folder.
67+
68+
69+
70+
<!--custom.tests.start-->
71+
<!--custom.tests.end-->
72+
73+
## Additional resources
74+
75+
- [Amazon Bedrock Runtime User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html)
76+
- [Amazon Bedrock Runtime API Reference](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)
77+
- [SDK for Swift Amazon Bedrock Runtime reference](https://sdk.amazonaws.com/swift/api/awsbedrockruntime/latest/documentation/awsbedrockruntime)
78+
79+
<!--custom.resources.start-->
80+
<!--custom.resources.end-->
81+
82+
---
83+
84+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
85+
86+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)