feat(clients): update command documentation examples as of 2024-09-20

Author: awstools

clients/client-lambda/src/commands/AddLayerVersionPermissionCommand.ts

@@ -99,6 +99,27 @@ export interface AddLayerVersionPermissionCommandOutput extends AddLayerVersionP
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To add permissions to a layer version
+ * ```javascript
+ * // The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.
+ * const input = {
+ *   "Action": "lambda:GetLayerVersion",
+ *   "LayerName": "my-layer",
+ *   "Principal": "223456789012",
+ *   "StatementId": "xaccount",
+ *   "VersionNumber": 1
+ * };
+ * const command = new AddLayerVersionPermissionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c",
+ *   "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}"
+ * }
+ * *\/
+ * // example id: to-add-permissions-to-a-layer-version-1586479797163
+ * ```
+ *
  */
 export class AddLayerVersionPermissionCommand extends $Command
   .classBuilder<

clients/client-lambda/src/commands/AddPermissionCommand.ts

@@ -114,6 +114,46 @@ export interface AddPermissionCommandOutput extends AddPermissionResponse, __Met
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To grant Amazon S3 permission to invoke a function
+ * ```javascript
+ * // The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.
+ * const input = {
+ *   "Action": "lambda:InvokeFunction",
+ *   "FunctionName": "my-function",
+ *   "Principal": "s3.amazonaws.com",
+ *   "SourceAccount": "123456789012",
+ *   "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*",
+ *   "StatementId": "s3"
+ * };
+ * const command = new AddPermissionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}"
+ * }
+ * *\/
+ * // example id: add-permission-1474651469455
+ * ```
+ *
+ * @example To grant another account permission to invoke a function
+ * ```javascript
+ * // The following example adds permission for account 223456789012 invoke a Lambda function named my-function.
+ * const input = {
+ *   "Action": "lambda:InvokeFunction",
+ *   "FunctionName": "my-function",
+ *   "Principal": "223456789012",
+ *   "StatementId": "xaccount"
+ * };
+ * const command = new AddPermissionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}"
+ * }
+ * *\/
+ * // example id: add-permission-1474651469456
+ * ```
+ *
  */
 export class AddPermissionCommand extends $Command
   .classBuilder<