Skip to content

Commit d2fdd87

Browse files
author
awstools
committed
docs(client-lambda): Documentation-only updates for Lambda to clarify a number of existing actions and properties.
1 parent fe761fa commit d2fdd87

File tree

3 files changed

+44
-30
lines changed

3 files changed

+44
-30
lines changed

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

+4
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ export interface InvokeAsyncCommandOutput extends InvokeAsyncResponse, __Metadat
3737
* <p>For asynchronous function invocation, use <a>Invoke</a>.</p>
3838
* </important>
3939
* <p>Invokes a function asynchronously.</p>
40+
* <note>
41+
* <p>If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not
42+
* propagated to the function, even if X-Ray active tracing is turned on.</p>
43+
* </note>
4044
* @example
4145
* Use a bare-bones client and the command you need to make an API call.
4246
* ```javascript

clients/client-lambda/src/models/models_0.ts

+25-15
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,15 @@ export interface OnFailure {
741741
/**
742742
* @public
743743
* <p>The Amazon Resource Name (ARN) of the destination resource.</p>
744+
* <p>To retain records of <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations">asynchronous invocations</a>,
745+
* you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,
746+
* or Amazon EventBridge event bus as the destination.</p>
747+
* <p>To retain records of failed invocations from <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations">Kinesis and
748+
* DynamoDB event sources</a>, you can configure an Amazon SNS topic or
749+
* Amazon SQS queue as the destination.</p>
750+
* <p>To retain records of failed invocations from <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination">self-managed Kafka</a> or
751+
* <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination">Amazon MSK</a>,
752+
* you can configure an Amazon SNS topic or Amazon SQS queue as the destination.</p>
744753
*/
745754
Destination?: string;
746755
}
@@ -1036,7 +1045,7 @@ export interface CreateEventSourceMappingRequest {
10361045
* </li>
10371046
* <li>
10381047
* <p>
1039-
* <b>Amazon Managed Streaming for Apache Kafka</b> – The ARN of the cluster.</p>
1048+
* <b>Amazon Managed Streaming for Apache Kafka</b> – The ARN of the cluster or the ARN of the VPC connection (for <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc">cross-account event source mappings</a>).</p>
10401049
* </li>
10411050
* <li>
10421051
* <p>
@@ -1164,7 +1173,7 @@ export interface CreateEventSourceMappingRequest {
11641173

11651174
/**
11661175
* @public
1167-
* <p>(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.</p>
1176+
* <p>(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.</p>
11681177
*/
11691178
DestinationConfig?: DestinationConfig;
11701179

@@ -1577,8 +1586,8 @@ export interface Environment {
15771586

15781587
/**
15791588
* @public
1580-
* <p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but it can be any
1581-
* whole number between 512 and 10,240 MB.</p>
1589+
* <p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole
1590+
* number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.</p>
15821591
*/
15831592
export interface EphemeralStorage {
15841593
/**
@@ -1677,14 +1686,14 @@ export interface LoggingConfig {
16771686
/**
16781687
* @public
16791688
* <p>Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the
1680-
* selected level and lower.</p>
1689+
* selected level of detail and lower, where <code>TRACE</code> is the highest level and <code>FATAL</code> is the lowest.</p>
16811690
*/
16821691
ApplicationLogLevel?: ApplicationLogLevel;
16831692

16841693
/**
16851694
* @public
16861695
* <p>Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the
1687-
* selected level and lower.</p>
1696+
* selected level of detail and lower, where <code>DEBUG</code> is the highest level and <code>WARN</code> is the lowest.</p>
16881697
*/
16891698
SystemLogLevel?: SystemLogLevel;
16901699

@@ -2010,7 +2019,7 @@ export interface CreateFunctionRequest {
20102019
/**
20112020
* @public
20122021
* <p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole
2013-
* number between 512 and 10,240 MB.</p>
2022+
* number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.</p>
20142023
*/
20152024
EphemeralStorage?: EphemeralStorage;
20162025

@@ -2547,8 +2556,8 @@ export interface FunctionConfiguration {
25472556

25482557
/**
25492558
* @public
2550-
* <p>The size of the functions <code>/tmp</code> directory in MB. The default value is 512, but it can be any
2551-
* whole number between 512 and 10,240 MB.</p>
2559+
* <p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole
2560+
* number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.</p>
25522561
*/
25532562
EphemeralStorage?: EphemeralStorage;
25542563

@@ -4447,7 +4456,8 @@ export interface InvocationRequest {
44474456
/**
44484457
* @public
44494458
* <p>Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context
4450-
* object.</p>
4459+
* object. Lambda passes the <code>ClientContext</code> object to your function for
4460+
* synchronous invocations only.</p>
44514461
*/
44524462
ClientContext?: string;
44534463

@@ -5194,7 +5204,7 @@ export interface ListEventSourceMappingsRequest {
51945204
* </li>
51955205
* <li>
51965206
* <p>
5197-
* <b>Amazon Managed Streaming for Apache Kafka</b> – The ARN of the cluster.</p>
5207+
* <b>Amazon Managed Streaming for Apache Kafka</b> – The ARN of the cluster or the ARN of the VPC connection (for <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc">cross-account event source mappings</a>).</p>
51985208
* </li>
51995209
* <li>
52005210
* <p>
@@ -5562,7 +5572,7 @@ export interface ListFunctionUrlConfigsResponse {
55625572
export interface ListLayersRequest {
55635573
/**
55645574
* @public
5565-
* <p>A runtime identifier. For example, <code>go1.x</code>.</p>
5575+
* <p>A runtime identifier. For example, <code>java21</code>.</p>
55665576
* <p>The following list includes deprecated runtimes. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy">Runtime deprecation policy</a>.</p>
55675577
*/
55685578
CompatibleRuntime?: Runtime;
@@ -5686,7 +5696,7 @@ export interface ListLayersResponse {
56865696
export interface ListLayerVersionsRequest {
56875697
/**
56885698
* @public
5689-
* <p>A runtime identifier. For example, <code>go1.x</code>.</p>
5699+
* <p>A runtime identifier. For example, <code>java21</code>.</p>
56905700
* <p>The following list includes deprecated runtimes. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy">Runtime deprecation policy</a>.</p>
56915701
*/
56925702
CompatibleRuntime?: Runtime;
@@ -6805,7 +6815,7 @@ export interface UpdateEventSourceMappingRequest {
68056815

68066816
/**
68076817
* @public
6808-
* <p>(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.</p>
6818+
* <p>(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.</p>
68096819
*/
68106820
DestinationConfig?: DestinationConfig;
68116821

@@ -7096,7 +7106,7 @@ export interface UpdateFunctionConfigurationRequest {
70967106
/**
70977107
* @public
70987108
* <p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole
7099-
* number between 512 and 10,240 MB.</p>
7109+
* number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.</p>
71007110
*/
71017111
EphemeralStorage?: EphemeralStorage;
71027112

0 commit comments

Comments
 (0)