@aws-sdk/client-lambda 3.655.0 → 3.656.0

package/dist-types/commands/PublishVersionCommand.d.ts

@@ -195,6 +195,48 @@ declare const PublishVersionCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To publish a version of a Lambda function
+ * ```javascript
+ * // This operation publishes a version of a Lambda function
+ * const input = {
+ *   "CodeSha256": "",
+ *   "Description": "",
+ *   "FunctionName": "myFunction"
+ * };
+ * const command = new PublishVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=",
+ *   "CodeSize": 5797206,
+ *   "Description": "Process image objects from Amazon S3.",
+ *   "Environment": {
+ *     "Variables": {
+ *       "BUCKET": "my-bucket-1xpuxmplzrlbh",
+ *       "PREFIX": "inbound"
+ *     }
+ *   },
+ *   "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
+ *   "FunctionName": "my-function",
+ *   "Handler": "index.handler",
+ *   "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
+ *   "LastModified": "2020-04-10T19:06:32.563+0000",
+ *   "LastUpdateStatus": "Successful",
+ *   "MemorySize": 256,
+ *   "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727",
+ *   "Role": "arn:aws:iam::123456789012:role/lambda-role",
+ *   "Runtime": "nodejs12.x",
+ *   "State": "Active",
+ *   "Timeout": 5,
+ *   "TracingConfig": {
+ *     "Mode": "Active"
+ *   },
+ *   "Version": "1"
+ * }
+ * *\/
+ * // example id: to-publish-a-version-of-a-lambda-function-1481650704986
+ * ```
+ *
  */
 export declare class PublishVersionCommand extends PublishVersionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/PutFunctionConcurrencyCommand.d.ts

@@ -79,6 +79,23 @@ declare const PutFunctionConcurrencyCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To configure a reserved concurrency limit for a function
+ * ```javascript
+ * // The following example configures 100 reserved concurrent executions for the my-function function.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "ReservedConcurrentExecutions": 100
+ * };
+ * const command = new PutFunctionConcurrencyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReservedConcurrentExecutions": 100
+ * }
+ * *\/
+ * // example id: to-configure-a-reserved-concurrency-limit-for-a-function-1586491405956
+ * ```
+ *
  */
 export declare class PutFunctionConcurrencyCommand extends PutFunctionConcurrencyCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/PutFunctionEventInvokeConfigCommand.d.ts

@@ -102,6 +102,31 @@ declare const PutFunctionEventInvokeConfigCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To configure error handling for asynchronous invocation
+ * ```javascript
+ * // The following example sets a maximum event age of one hour and disables retries for the specified function.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "MaximumEventAgeInSeconds": 3600,
+ *   "MaximumRetryAttempts": 0
+ * };
+ * const command = new PutFunctionEventInvokeConfigCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DestinationConfig": {
+ *     "OnFailure": {},
+ *     "OnSuccess": {}
+ *   },
+ *   "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST",
+ *   "LastModified": "${timestamp}",
+ *   "MaximumEventAgeInSeconds": 3600,
+ *   "MaximumRetryAttempts": 0
+ * }
+ * *\/
+ * // example id: to-configure-error-handling-for-asynchronous-invocation-1586491524021
+ * ```
+ *
  */
 export declare class PutFunctionEventInvokeConfigCommand extends PutFunctionEventInvokeConfigCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/PutProvisionedConcurrencyConfigCommand.d.ts

@@ -77,6 +77,27 @@ declare const PutProvisionedConcurrencyConfigCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To allocate provisioned concurrency
+ * ```javascript
+ * // The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "ProvisionedConcurrentExecutions": 100,
+ *   "Qualifier": "BLUE"
+ * };
+ * const command = new PutProvisionedConcurrencyConfigCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AllocatedProvisionedConcurrentExecutions": 0,
+ *   "LastModified": "2019-11-21T19:32:12+0000",
+ *   "RequestedProvisionedConcurrentExecutions": 100,
+ *   "Status": "IN_PROGRESS"
+ * }
+ * *\/
+ * // example id: to-allocate-provisioned-concurrency-1586491651377
+ * ```
+ *
  */
 export declare class PutProvisionedConcurrencyConfigCommand extends PutProvisionedConcurrencyConfigCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/RemoveLayerVersionPermissionCommand.d.ts

@@ -83,6 +83,19 @@ declare const RemoveLayerVersionPermissionCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To delete layer-version permissions
+ * ```javascript
+ * // The following example deletes permission for an account to configure a layer version.
+ * const input = {
+ *   "LayerName": "my-layer",
+ *   "StatementId": "xaccount",
+ *   "VersionNumber": 1
+ * };
+ * const command = new RemoveLayerVersionPermissionCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-layer-version-permissions-1586491829416
+ * ```
+ *
  */
 export declare class RemoveLayerVersionPermissionCommand extends RemoveLayerVersionPermissionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/RemovePermissionCommand.d.ts

@@ -87,6 +87,19 @@ declare const RemovePermissionCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To remove a Lambda function's permissions
+ * ```javascript
+ * // The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "Qualifier": "PROD",
+ *   "StatementId": "xaccount"
+ * };
+ * const command = new RemovePermissionCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-a-lambda-functions-permissions-1481661337021
+ * ```
+ *
  */
 export declare class RemovePermissionCommand extends RemovePermissionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/TagResourceCommand.d.ts

@@ -71,6 +71,20 @@ declare const TagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To add tags to an existing Lambda function
+ * ```javascript
+ * // The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.
+ * const input = {
+ *   "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
+ *   "Tags": {
+ *     "DEPARTMENT": "Department A"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-add-tags-to-an-existing-lambda-function-1586491890446
+ * ```
+ *
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -71,6 +71,20 @@ declare const UntagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To remove tags from an existing Lambda function
+ * ```javascript
+ * // The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.
+ * const input = {
+ *   "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
+ *   "TagKeys": [
+ *     "DEPARTMENT"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-tags-from-an-existing-lambda-function-1586491956425
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateAliasCommand.d.ts

@@ -101,6 +101,38 @@ declare const UpdateAliasCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To update a function alias
+ * ```javascript
+ * // The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "FunctionVersion": "2",
+ *   "Name": "BLUE",
+ *   "RoutingConfig": {
+ *     "AdditionalVersionWeights": {
+ *       "1": 0.7
+ *     }
+ *   }
+ * };
+ * const command = new UpdateAliasCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE",
+ *   "Description": "Production environment BLUE.",
+ *   "FunctionVersion": "2",
+ *   "Name": "BLUE",
+ *   "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93",
+ *   "RoutingConfig": {
+ *     "AdditionalVersionWeights": {
+ *       "1": 0.7
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-update-a-function-alias-1481650817950
+ * ```
+ *
  */
 export declare class UpdateAliasCommand extends UpdateAliasCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateEventSourceMappingCommand.d.ts

@@ -302,6 +302,32 @@ declare const UpdateEventSourceMappingCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To update a Lambda function event source mapping
+ * ```javascript
+ * // This operation updates a Lambda function event source mapping
+ * const input = {
+ *   "BatchSize": 123,
+ *   "Enabled": true,
+ *   "FunctionName": "myFunction",
+ *   "UUID": "1234xCy789012"
+ * };
+ * const command = new UpdateEventSourceMappingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "BatchSize": 123,
+ *   "EventSourceArn": "arn:aws:s3:::examplebucket/*",
+ *   "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
+ *   "LastModified": "2016-11-21T19:49:20.006+0000",
+ *   "LastProcessingResult": "",
+ *   "State": "",
+ *   "StateTransitionReason": "",
+ *   "UUID": "1234xCy789012"
+ * }
+ * *\/
+ * // example id: to-update-a-lambda-function-event-source-mapping-1481650907413
+ * ```
+ *
  */
 export declare class UpdateEventSourceMappingCommand extends UpdateEventSourceMappingCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateFunctionCodeCommand.d.ts

@@ -223,6 +223,39 @@ declare const UpdateFunctionCodeCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To update a Lambda function's code
+ * ```javascript
+ * // The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the contents of the specified zip file in Amazon S3.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "S3Bucket": "my-bucket-1xpuxmplzrlbh",
+ *   "S3Key": "function.zip"
+ * };
+ * const command = new UpdateFunctionCodeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=",
+ *   "CodeSize": 308,
+ *   "Description": "",
+ *   "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function",
+ *   "FunctionName": "my-function",
+ *   "Handler": "index.handler",
+ *   "LastModified": "2019-08-14T22:26:11.234+0000",
+ *   "MemorySize": 128,
+ *   "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6",
+ *   "Role": "arn:aws:iam::123456789012:role/lambda-role",
+ *   "Runtime": "nodejs12.x",
+ *   "Timeout": 3,
+ *   "TracingConfig": {
+ *     "Mode": "PassThrough"
+ *   },
+ *   "Version": "$LATEST"
+ * }
+ * *\/
+ * // example id: to-update-a-lambda-functions-code-1481650992672
+ * ```
+ *
  */
 export declare class UpdateFunctionCodeCommand extends UpdateFunctionCodeCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateFunctionConfigurationCommand.d.ts

@@ -263,6 +263,38 @@ declare const UpdateFunctionConfigurationCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To update a Lambda function's configuration
+ * ```javascript
+ * // The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.
+ * const input = {
+ *   "FunctionName": "my-function",
+ *   "MemorySize": 256
+ * };
+ * const command = new UpdateFunctionConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=",
+ *   "CodeSize": 308,
+ *   "Description": "",
+ *   "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function",
+ *   "FunctionName": "my-function",
+ *   "Handler": "index.handler",
+ *   "LastModified": "2019-08-14T22:26:11.234+0000",
+ *   "MemorySize": 256,
+ *   "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6",
+ *   "Role": "arn:aws:iam::123456789012:role/lambda-role",
+ *   "Runtime": "nodejs12.x",
+ *   "Timeout": 3,
+ *   "TracingConfig": {
+ *     "Mode": "PassThrough"
+ *   },
+ *   "Version": "$LATEST"
+ * }
+ * *\/
+ * // example id: to-update-a-lambda-functions-configuration-1481651096447
+ * ```
+ *
  */
 export declare class UpdateFunctionConfigurationCommand extends UpdateFunctionConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateFunctionEventInvokeConfigCommand.d.ts

@@ -93,6 +93,36 @@ declare const UpdateFunctionEventInvokeConfigCommand_base: {
  * <p>Base exception class for all service exceptions from Lambda service.</p>
  *
  * @public
+ * @example To update an asynchronous invocation configuration
+ * ```javascript
+ * // The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.
+ * const input = {
+ *   "DestinationConfig": {
+ *     "OnFailure": {
+ *       "Destination": "arn:aws:sqs:us-east-2:123456789012:destination"
+ *     }
+ *   },
+ *   "FunctionName": "my-function"
+ * };
+ * const command = new UpdateFunctionEventInvokeConfigCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DestinationConfig": {
+ *     "OnFailure": {
+ *       "Destination": "arn:aws:sqs:us-east-2:123456789012:destination"
+ *     },
+ *     "OnSuccess": {}
+ *   },
+ *   "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST",
+ *   "LastModified": 1573687896.493,
+ *   "MaximumEventAgeInSeconds": 3600,
+ *   "MaximumRetryAttempts": 0
+ * }
+ * *\/
+ * // example id: to-update-an-asynchronous-invocation-configuration-1586492061186
+ * ```
+ *
  */
 export declare class UpdateFunctionEventInvokeConfigCommand extends UpdateFunctionEventInvokeConfigCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-lambda",
   "description": "AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native",
-  "version": "3.655.0",
+  "version": "3.656.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-lambda",