Add SoS metadata and readme

shepazon · shepazon · commit e3929db38e3f · 2025-01-03T19:04:23.000Z
diff --git a/.doc_gen/metadata/lambda_metadata.yaml b/.doc_gen/metadata/lambda_metadata.yaml
@@ -172,6 +172,15 @@ lambda_CreateFunction:
             - snippet_tags:
                 - lambda.rust.scenario.create_function
                 - lambda.rust.scenario.prepare_function
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.lambda-basics.imports
+                - swift.lambda-basics.CreateFunction
   services:
     lambda: {CreateFunction}
 lambda_DeleteFunction:
@@ -380,6 +389,15 @@ lambda_Invoke:
             - snippet_tags:
                 - lambda.rust.scenario.invoke
                 - lambda.rust.scenario.log_invoke_output
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.lambda-basics.imports
+                - swift.lambda-basics.Invoke
   services:
     lambda: {Invoke}
 lambda_GetFunction:
@@ -474,6 +492,15 @@ lambda_GetFunction:
           excerpts:
             - snippet_tags:
                 - lambda.rust.scenario.get_function
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.lambda-basics.imports
+                - swift.lambda-basics.GetFunctionInput
   services:
     lambda: {GetFunction}
 lambda_UpdateFunctionCode:
@@ -569,6 +596,15 @@ lambda_UpdateFunctionCode:
             - snippet_tags:
                 - lambda.rust.scenario.update_function_code
                 - lambda.rust.scenario.prepare_function
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.lambda-basics.imports
+                - swift.lambda-basics.UpdateFunctionCode
   services:
     lambda: {UpdateFunctionCode}
 lambda_UpdateFunctionConfiguration:
@@ -748,6 +784,15 @@ lambda_ListFunctions:
           excerpts:
             - snippet_tags:
                 - lambda.rust.scenario.list_functions
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.lambda-basics.imports
+                - swift.lambda-basics.ListFunctionsPaginated
   services:
     lambda: {ListFunctions}
 lambda_Scenario_GettingStartedFunctions:
@@ -937,5 +982,23 @@ lambda_Scenario_GettingStartedFunctions:
                 This file is src/bin/scenario.rs in the crate.
               snippet_files:
                 - rustv1/examples/lambda/src/bin/scenario.rs
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/lambda/basics
+          excerpts:
+            - description: Define the first &LAM; function, which simply increments the specified value.
+              snippet_files:
+                - swift/example_code/lambda/basics/increment/Package.swift
+                - swift/example_code/lambda/basics/increment/Sources/increment.swift
+            - description: Define the second &LAM; function, which performs an arithmetic operation on two numbers.
+              snippet_files:
+                - swift/example_code/lambda/basics/calculator/Package.swift
+                - swift/example_code/lambda/basics/calculator/Sources/calculator.swift
+            - description: Define the main program that will invoke the two &LAM; functions.
+              snippet_files:
+                - swift/example_code/lambda/basics/lambda-basics/Package.swift
+                - swift/example_code/lambda/basics/lambda-basics/Sources/entry.swift
+                - swift/example_code/lambda/basics/lambda-basics/Sources/ExampleError.swift
   services:
     lambda: {CreateFunction, DeleteFunction, Invoke, GetFunction, ListFunctions, UpdateFunctionCode, UpdateFunctionConfiguration}
diff --git a/swift/example_code/lambda/README.md b/swift/example_code/lambda/README.md
@@ -0,0 +1,116 @@
+# Lambda code examples for the SDK for Swift
+
+## Overview
+
+Shows how to use the AWS SDK for Swift to work with AWS Lambda.
+
+<!--custom.overview.start-->
+<!--custom.overview.end-->
+
+_Lambda allows you to run code without provisioning or managing servers._
+
+## ⚠ Important
+
+* 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/).
+* Running the tests might result in charges to your AWS account.
+* 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).
+* 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).
+
+<!--custom.important.start-->
+<!--custom.important.end-->
+
+## Code examples
+
+### Prerequisites
+
+For prerequisites, see the [README](../../README.md#Prerequisites) in the `swift` folder.
+
+
+<!--custom.prerequisites.start-->
+<!--custom.prerequisites.end-->
+
+### Basics
+
+Code examples that show you how to perform the essential operations within a service.
+
+- [Learn the basics](basics/increment/Package.swift)
+
+
+### Single actions
+
+Code excerpts that show you how to call individual service functions.
+
+- [CreateFunction](basics/lambda-basics/Sources/entry.swift#L177)
+- [GetFunction](basics/lambda-basics/Sources/entry.swift#L142)
+- [Invoke](basics/lambda-basics/Sources/entry.swift#L313)
+- [ListFunctions](basics/lambda-basics/Sources/entry.swift#L283)
+- [UpdateFunctionCode](basics/lambda-basics/Sources/entry.swift#L236)
+
+
+<!--custom.examples.start-->
+<!--custom.examples.end-->
+
+## Run the examples
+
+### Instructions
+
+To build any of these examples from a terminal window, navigate into its
+directory, then use the following command:
+
+```
+$ swift build
+```
+
+To build one of these examples in Xcode, navigate to the example's directory
+Then type `xed.` to open the example directory in Xcode. You can then use
+standard Xcode build and run commands.
+
+<!--custom.instructions.start-->
+<!--custom.instructions.end-->
+
+
+#### Learn the basics
+
+This example shows you how to do the following:
+
+- Create an IAM role and Lambda function, then upload handler code.
+- Invoke the function with a single parameter and get results.
+- Update the function code and configure with an environment variable.
+- Invoke the function with new parameters and get results. Display the returned execution log.
+- List the functions for your account, then clean up resources.
+
+<!--custom.basic_prereqs.lambda_Scenario_GettingStartedFunctions.start-->
+<!--custom.basic_prereqs.lambda_Scenario_GettingStartedFunctions.end-->
+
+
+<!--custom.basics.lambda_Scenario_GettingStartedFunctions.start-->
+<!--custom.basics.lambda_Scenario_GettingStartedFunctions.end-->
+
+
+### Tests
+
+⚠ Running tests might result in charges to your AWS account.
+
+
+To find instructions for running these tests, see the [README](../../README.md#Tests)
+in the `swift` folder.
+
+
+
+<!--custom.tests.start-->
+<!--custom.tests.end-->
+
+## Additional resources
+
+- [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html)
+- [Lambda API Reference](https://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html)
+- [SDK for Swift Lambda reference](https://sdk.amazonaws.com/swift/api/awslambda/latest/documentation/awslambda)
+
+<!--custom.resources.start-->
+<!--custom.resources.end-->
+
+---
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/swift/example_code/lambda/basics/lambda-basics/Sources/entry.swift b/swift/example_code/lambda/basics/lambda-basics/Sources/entry.swift
@@ -4,14 +4,16 @@
 /// An example that demonstrates how to watch an transcribe event stream to
 /// transcribe audio from a file to the console.
 
-// snippet-start:[swift.lambda-basics.imports]
+// snippet-start:[swift.lambda-basics.imports-all]
 import ArgumentParser
-import AWSClientRuntime
 import AWSIAM
+import SmithyWaitersAPI
+// snippet-start:[swift.lambda-basics.imports]
+import AWSClientRuntime
 import AWSLambda
 import Foundation
-import SmithyWaitersAPI
 // snippet-end:[swift.lambda-basics.imports]
+// snippet-end:[swift.lambda-basics.imports-all]
 
 // snippet-start:[swift.lambda-basics.InvokeInput.types]
 /// Represents the contents of the requests being received from the client.
@@ -157,7 +159,7 @@ struct ExampleCommand: ParsableCommand {
 
         return true
     }
-    // snippet-start:[swift.lambda-basics.GetFunctionInput]
+    // snippet-end:[swift.lambda-basics.GetFunctionInput]
 
     // snippet-start:[swift.lambda-basics.CreateFunction.wait]
     /// Create the specified AWS Lambda function.
@@ -193,7 +195,6 @@ struct ExampleCommand: ParsableCommand {
                 )
             )
         } catch {
-            dump(error)
             return false
         }
         // snippet-end:[swift.lambda-basics.CreateFunction]
@@ -218,7 +219,7 @@ struct ExampleCommand: ParsableCommand {
     }
     // snippet-end:[swift.lambda-basics.CreateFunction.wait]
 
-    // snippet-start:[swift.lambda-basics.UpdateFunction.wait]
+    // snippet-start:[swift.lambda-basics.UpdateFunctionCode.wait]
     /// Update the AWS Lambda function with new code to run when the function
     /// is invoked.
     /// 
@@ -232,7 +233,7 @@ struct ExampleCommand: ParsableCommand {
     ///   Otherwise, returns `false`.
     func updateFunctionCode(lambdaClient: LambdaClient, name: String,
                             path: String) async throws -> Bool {
-        // snippet-start:[swift.lambda-basics.UpdateFunction]
+        // snippet-start:[swift.lambda-basics.UpdateFunctionCode]
         let zipUrl = URL(fileURLWithPath: path)
         let zipData: Data
 
@@ -257,7 +258,7 @@ struct ExampleCommand: ParsableCommand {
         } catch {
             return false
         }
-        // snippet-start:[swift.lambda-basics.UpdateFunction.wait]
+        // snippet-end:[swift.lambda-basics.UpdateFunctionCode]
 
         let output = try await lambdaClient.waitUntilFunctionUpdatedV2(
             options: WaiterOptions(
@@ -277,7 +278,7 @@ struct ExampleCommand: ParsableCommand {
                 return false
         }
     }
-    // snippet-end:[swift.lambda-basics.UpdateFunction.wait]
+    // snippet-end:[swift.lambda-basics.UpdateFunctionCode.wait]
 
     // snippet-start:[swift.lambda-basics.ListFunctionsPaginated]
     /// Returns an array containing the names of all AWS Lambda functions
@@ -309,7 +310,7 @@ struct ExampleCommand: ParsableCommand {
     }
     // snippet-end:[swift.lambda-basics.ListFunctionsPaginated]
 
-    // snippet-start:[swift.lambda-basics.InvokeInput]
+    // snippet-start:[swift.lambda-basics.Invoke]
     /// Invoke the Lambda function to increment a value.
     /// 
     /// - Parameters:
@@ -344,7 +345,7 @@ struct ExampleCommand: ParsableCommand {
             throw ExampleError.invokeError
         }
     }
-    // snippet-end:[swift.lambda-basics.InvokeInput]
+    // snippet-end:[swift.lambda-basics.Invoke]
 
     /// Invoke the calculator Lambda function.
     /// 
