@aws-sdk/client-lambda 3.218.0 → 3.219.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist-cjs/endpoint/ruleset.js +1 -1
  2. package/dist-cjs/models/models_0.js +90 -4
  3. package/dist-cjs/protocols/Aws_restJson1.js +83 -0
  4. package/dist-cjs/waiters/index.js +1 -0
  5. package/dist-cjs/waiters/waitForPublishedVersionActive.js +54 -0
  6. package/dist-es/endpoint/ruleset.js +1 -1
  7. package/dist-es/models/models_0.js +81 -0
  8. package/dist-es/protocols/Aws_restJson1.js +84 -1
  9. package/dist-es/waiters/index.js +1 -0
  10. package/dist-es/waiters/waitForPublishedVersionActive.js +49 -0
  11. package/dist-types/Lambda.d.ts +77 -80
  12. package/dist-types/commands/AddPermissionCommand.d.ts +13 -13
  13. package/dist-types/commands/CreateFunctionCommand.d.ts +26 -27
  14. package/dist-types/commands/DeleteFunctionCommand.d.ts +2 -3
  15. package/dist-types/commands/InvokeCommand.d.ts +10 -8
  16. package/dist-types/commands/ListFunctionsCommand.d.ts +4 -4
  17. package/dist-types/commands/PutFunctionConcurrencyCommand.d.ts +1 -1
  18. package/dist-types/commands/RemovePermissionCommand.d.ts +2 -2
  19. package/dist-types/commands/UpdateFunctionCodeCommand.d.ts +12 -15
  20. package/dist-types/commands/UpdateFunctionConfigurationCommand.d.ts +7 -7
  21. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  22. package/dist-types/models/models_0.d.ts +339 -209
  23. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  24. package/dist-types/ts3.4/models/models_0.d.ts +70 -0
  25. package/dist-types/ts3.4/waiters/index.d.ts +1 -0
  26. package/dist-types/ts3.4/waiters/waitForPublishedVersionActive.d.ts +11 -0
  27. package/dist-types/waiters/index.d.ts +1 -0
  28. package/dist-types/waiters/waitForPublishedVersionActive.d.ts +14 -0
  29. package/package.json +1 -1
@@ -9,27 +9,27 @@ export interface CreateFunctionCommandOutput extends FunctionConfiguration, __Me
9
9
  }
10
10
  /**
11
11
  * <p>Creates a Lambda function. To create a function, you need a <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html">deployment package</a> and an <a href="https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role">execution role</a>. The
12
- * deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services
13
- * services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.</p>
12
+ * deployment package is a .zip file archive or container image that contains your function code. The execution role
13
+ * grants the function permission to use Amazon Web Services, such as Amazon CloudWatch Logs for log
14
+ * streaming and X-Ray for request tracing.</p>
14
15
  *
15
- * <p>You set the package type to <code>Image</code> if the deployment package is a
16
- * <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html">container image</a>. For a container image,
17
- * the code property must include the URI of a container image in the Amazon ECR registry.
18
- * You do not need to specify the handler and runtime properties. </p>
16
+ * <p>If the deployment package is a <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html">container
17
+ * image</a>, then you set the package type to <code>Image</code>. For a container image, the code property
18
+ * must include the URI of a container image in the Amazon ECR registry. You do not need to specify the
19
+ * handler and runtime properties.</p>
19
20
  *
20
- * <p>You set the package type to <code>Zip</code> if the deployment package is a <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip">.zip file
21
- * archive</a>. For a .zip file archive, the code property specifies the location of the
22
- * .zip file. You must also specify the handler and runtime properties. The code in the
23
- * deployment package must be compatible with the target instruction set architecture of the
24
- * function (<code>x86-64</code> or <code>arm64</code>). If you do not specify the architecture, the default value is
21
+ * <p>If the deployment package is a <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip">.zip file archive</a>, then
22
+ * you set the package type to <code>Zip</code>. For a .zip file archive, the code property specifies the location of
23
+ * the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must
24
+ * be compatible with the target instruction set architecture of the function (<code>x86-64</code> or
25
+ * <code>arm64</code>). If you do not specify the architecture, then the default value is
25
26
  * <code>x86-64</code>.</p>
26
27
  *
27
- * <p>When you create a function, Lambda provisions an instance of the function and its supporting resources. If
28
- * your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or
29
- * modify the function. The <code>State</code>, <code>StateReason</code>, and <code>StateReasonCode</code> fields in
30
- * the response from <a>GetFunctionConfiguration</a> indicate when the function is ready to invoke. For
31
- * more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">Function
32
- * States</a>.</p>
28
+ * <p>When you create a function, Lambda provisions an instance of the function and its supporting
29
+ * resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't
30
+ * invoke or modify the function. The <code>State</code>, <code>StateReason</code>, and <code>StateReasonCode</code>
31
+ * fields in the response from <a>GetFunctionConfiguration</a> indicate when the function is ready to
32
+ * invoke. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">Lambda function states</a>.</p>
33
33
  *
34
34
  * <p>A function has an unpublished version, and can have published versions and aliases. The unpublished version
35
35
  * changes when you update your function's code and configuration. A published version is a snapshot of your function
@@ -42,19 +42,18 @@ export interface CreateFunctionCommandOutput extends FunctionConfiguration, __Me
42
42
  * to both the unpublished and published versions of the function, and include tags (<a>TagResource</a>)
43
43
  * and per-function concurrency limits (<a>PutFunctionConcurrency</a>).</p>
44
44
  *
45
- * <p>You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function,
46
- * specify the ARN of a code-signing configuration. When a user
47
- * attempts to deploy a code package with <a>UpdateFunctionCode</a>, Lambda checks that the code
48
- * package has a valid signature from a trusted publisher. The code-signing configuration
49
- * includes set set of signing profiles, which define the trusted publishers for this function.</p>
45
+ * <p>You can use code signing if your deployment package is a .zip file archive. To enable code signing for this
46
+ * function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with
47
+ * <a>UpdateFunctionCode</a>, Lambda checks that the code package has a valid signature from
48
+ * a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted
49
+ * publishers for this function.</p>
50
50
  *
51
- * <p>If another account or an Amazon Web Services service invokes your function, use <a>AddPermission</a> to grant
52
- * permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version,
53
- * or on an alias.</p>
51
+ * <p>If another Amazon Web Services account or an Amazon Web Service invokes your function, use <a>AddPermission</a> to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.</p>
54
52
  *
55
53
  * <p>To invoke your function directly, use <a>Invoke</a>. To invoke your function in response to events
56
- * in other Amazon Web Services services, create an event source mapping (<a>CreateEventSourceMapping</a>), or configure a
57
- * function trigger in the other service. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html">Invoking Functions</a>.</p>
54
+ * in other Amazon Web Services, create an event source mapping (<a>CreateEventSourceMapping</a>),
55
+ * or configure a function trigger in the other service. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html">Invoking Lambda
56
+ * functions</a>.</p>
58
57
  * @example
59
58
  * Use a bare-bones client and the command you need to make an API call.
60
59
  * ```javascript
@@ -11,9 +11,8 @@ export interface DeleteFunctionCommandOutput extends __MetadataBearer {
11
11
  * <p>Deletes a Lambda function. To delete a specific function version, use the <code>Qualifier</code> parameter.
12
12
  * Otherwise, all versions and aliases are deleted.</p>
13
13
  *
14
- * <p>To delete Lambda event source mappings that invoke a function, use <a>DeleteEventSourceMapping</a>.
15
- * For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you
16
- * originally configured it.</p>
14
+ * <p>To delete Lambda event source mappings that invoke a function, use <a>DeleteEventSourceMapping</a>. For Amazon Web Services and resources that invoke your function
15
+ * directly, delete the trigger in the service where you originally configured it.</p>
17
16
  * @example
18
17
  * Use a bare-bones client and the command you need to make an API call.
19
18
  * ```javascript
@@ -17,21 +17,23 @@ export interface InvokeCommandOutput extends InvocationResponse, __MetadataBeare
17
17
  *
18
18
  * <p>When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,
19
19
  * client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an
20
- * error, Lambda executes the function up to two more times. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/retries-on-errors.html">Retry Behavior</a>.</p>
20
+ * error, Lambda executes the function up to two more times. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html">Error handling and automatic retries in
21
+ * Lambda</a>.</p>
21
22
  *
22
23
  * <p>For <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html">asynchronous invocation</a>,
23
24
  * Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity
24
25
  * to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple
25
- * times, even if no error occurs. To retain events that were not processed, configure your function with a <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq">dead-letter queue</a>.</p>
26
+ * times, even if no error occurs. To retain events that were not processed, configure your function with a <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq">dead-letter queue</a>.</p>
26
27
  *
27
28
  * <p>The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that
28
- * prevent your function from executing, such as permissions errors, <a href="https://docs.aws.amazon.com/lambda/latest/dg/limits.html">limit errors</a>, or issues with your function's code and configuration.
29
- * For example, Lambda returns <code>TooManyRequestsException</code> if executing the function would cause you to
30
- * exceed a concurrency limit at either the account level (<code>ConcurrentInvocationLimitExceeded</code>) or
31
- * function level (<code>ReservedFunctionConcurrentInvocationLimitExceeded</code>).</p>
29
+ * prevent your function from executing, such as permissions errors, <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">quota</a> errors, or issues with your function's code and
30
+ * configuration. For example, Lambda returns <code>TooManyRequestsException</code> if running the
31
+ * function would cause you to exceed a concurrency limit at either the account level
32
+ * (<code>ConcurrentInvocationLimitExceeded</code>) or function level
33
+ * (<code>ReservedFunctionConcurrentInvocationLimitExceeded</code>).</p>
32
34
  *
33
- * <p>For functions with a long timeout, your client might be disconnected during synchronous invocation while it
34
- * waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long
35
+ * <p>For functions with a long timeout, your client might disconnect during synchronous invocation while it waits
36
+ * for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long
35
37
  * connections with timeout or keep-alive settings.</p>
36
38
  *
37
39
  * <p>This operation requires permission for the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html">lambda:InvokeFunction</a> action. For details on how to set up
@@ -11,11 +11,11 @@ export interface ListFunctionsCommandOutput extends ListFunctionsResponse, __Met
11
11
  * <p>Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50
12
12
  * functions per call.</p>
13
13
  * <p>Set <code>FunctionVersion</code> to <code>ALL</code> to include all published versions of each function in
14
- * addition to the unpublished version. </p>
14
+ * addition to the unpublished version.</p>
15
15
  * <note>
16
- * <p>The <code>ListFunctions</code> action returns a subset of the <a>FunctionConfiguration</a> fields.
17
- * To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode)
18
- * for a function or version, use <a>GetFunction</a>.</p>
16
+ * <p>The <code>ListFunctions</code> operation returns a subset of the <a>FunctionConfiguration</a> fields.
17
+ * To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason,
18
+ * LastUpdateStatusReasonCode) for a function or version, use <a>GetFunction</a>.</p>
19
19
  * </note>
20
20
  * @example
21
21
  * Use a bare-bones client and the command you need to make an API call.
@@ -16,7 +16,7 @@ export interface PutFunctionConcurrencyCommandOutput extends Concurrency, __Meta
16
16
  * the current setting for a function.</p>
17
17
  * <p>Use <a>GetAccountSettings</a> to see your Regional concurrency limit. You can reserve concurrency
18
18
  * for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for
19
- * functions that aren't configured with a per-function limit. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html">Managing Concurrency</a>.</p>
19
+ * functions that aren't configured with a per-function limit. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-scaling.html">Lambda function scaling</a>.</p>
20
20
  * @example
21
21
  * Use a bare-bones client and the command you need to make an API call.
22
22
  * ```javascript
@@ -8,8 +8,8 @@ export interface RemovePermissionCommandInput extends RemovePermissionRequest {
8
8
  export interface RemovePermissionCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Revokes function-use permission from an Amazon Web Services service or another account. You can get the ID of the statement
12
- * from the output of <a>GetPolicy</a>.</p>
11
+ * <p>Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You
12
+ * can get the ID of the statement from the output of <a>GetPolicy</a>.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -8,27 +8,24 @@ export interface UpdateFunctionCodeCommandInput extends UpdateFunctionCodeReques
8
8
  export interface UpdateFunctionCodeCommandOutput extends FunctionConfiguration, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed
12
- * by a trusted publisher. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-trustedcode.html">Configuring code signing</a>.</p>
11
+ * <p>Updates a Lambda function's code. If code signing is enabled for the function, the code package
12
+ * must be signed by a trusted publisher. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html">Configuring code signing for Lambda</a>.</p>
13
13
  *
14
- * <p>If the function's package type is <code>Image</code>, you must specify the code package in <code>ImageUri</code> as
15
- * the URI of a
16
- * <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html">container image</a>
17
- * in the Amazon ECR registry.
18
- * </p>
14
+ * <p>If the function's package type is <code>Image</code>, then you must specify the code package in
15
+ * <code>ImageUri</code> as the URI of a <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html">container image</a> in the Amazon ECR registry.</p>
19
16
  *
20
- * <p>If the function's package type is <code>Zip</code>, you must specify the deployment
21
- * package as a <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip">.zip file
22
- * archive</a>. Enter the Amazon S3 bucket and key of the code .zip file location.
23
- * You can also provide the function code inline using the <code>ZipFile</code> field. </p>
24
- * <p>The code in the deployment package must be compatible with the target instruction set
25
- * architecture of the function (<code>x86-64</code> or <code>arm64</code>). </p>
17
+ * <p>If the function's package type is <code>Zip</code>, then you must specify the deployment package as a <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip">.zip file
18
+ * archive</a>. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide
19
+ * the function code inline using the <code>ZipFile</code> field.</p>
20
+ * <p>The code in the deployment package must be compatible with the target instruction set architecture of the
21
+ * function (<code>x86-64</code> or <code>arm64</code>).</p>
26
22
  *
27
23
  * <p>The function's code is locked when you publish a version. You can't modify the code of a published version,
28
24
  * only the unpublished version.</p>
29
25
  * <note>
30
- * <p>For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if
31
- * you update the image tag to a new image, Lambda does not automatically update the function.</p>
26
+ * <p>For a function defined as a container image, Lambda resolves the image tag to an image digest. In
27
+ * Amazon ECR, if you update the image tag to a new image, Lambda does not automatically
28
+ * update the function.</p>
32
29
  * </note>
33
30
  * @example
34
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,19 +10,19 @@ export interface UpdateFunctionConfigurationCommandOutput extends FunctionConfig
10
10
  /**
11
11
  * <p>Modify the version-specific settings of a Lambda function.</p>
12
12
  *
13
- * <p>When you update a function, Lambda provisions an instance of the function and its supporting resources. If
14
- * your function connects to a VPC, this process can take a minute. During this time, you can't modify the function,
15
- * but you can still invoke it. The <code>LastUpdateStatus</code>, <code>LastUpdateStatusReason</code>, and
16
- * <code>LastUpdateStatusReasonCode</code> fields in the response from <a>GetFunctionConfiguration</a>
13
+ * <p>When you update a function, Lambda provisions an instance of the function and its supporting
14
+ * resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify
15
+ * the function, but you can still invoke it. The <code>LastUpdateStatus</code>, <code>LastUpdateStatusReason</code>,
16
+ * and <code>LastUpdateStatusReasonCode</code> fields in the response from <a>GetFunctionConfiguration</a>
17
17
  * indicate when the update is complete and the function is processing events with the new configuration. For more
18
- * information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">Function
19
- * States</a>.</p>
18
+ * information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">Lambda
19
+ * function states</a>.</p>
20
20
  *
21
21
  * <p>These settings can vary between versions of a function and are locked when you publish a version. You can't
22
22
  * modify the configuration of a published version, only the unpublished version.</p>
23
23
  *
24
24
  * <p>To configure function concurrency, use <a>PutFunctionConcurrency</a>. To grant invoke permissions
25
- * to an account or Amazon Web Services service, use <a>AddPermission</a>.</p>
25
+ * to an Amazon Web Services account or Amazon Web Service, use <a>AddPermission</a>.</p>
26
26
  * @example
27
27
  * Use a bare-bones client and the command you need to make an API call.
28
28
  * ```javascript
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;