Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Account
Limit Limits that are related to concurrency and storage. All file and storage sizes are in bytes.
- Account
Usage The number of functions and amount of storage in use.
- Alias
Configuration Provides configuration information about a Lambda function alias.
- Alias
Routing Configuration The traffic-shifting configuration of a Lambda function alias.
- Allowed
Publishers List of signing profiles that can sign a code package.
- Amazon
Managed Kafka Event Source Config Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- Code
Signing Config Details about a Code signing configuration.
- Code
Signing Policies Code signing configuration policies specify the validation failure action for signature mismatch or expiry.
- Concurrency
- Cors
The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
- Dead
Letter Config The dead-letter queue for failed asynchronous invocations.
- Destination
Config A configuration object that specifies the destination of an event after Lambda processes it.
- Document
DbEvent Source Config Specific configuration settings for a DocumentDB event source.
- Environment
A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
- Environment
Error Error messages for environment variables that couldn't be applied.
- Environment
Response The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.
- Ephemeral
Storage The size of the function's
/tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).- Event
Source Mapping Configuration A mapping between an Amazon Web Services resource and a Lambda function. For details, see
CreateEventSourceMapping
.- Event
Source Mapping Metrics Config The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.
- File
System Config Details about the connection between a Lambda function and an Amazon EFS file system.
- Filter
A structure within a
FilterCriteria
object that defines an event filtering pattern.- Filter
Criteria An object that contains the filters for an event source.
- Filter
Criteria Error An object that contains details about an error related to filter criteria encryption.
- Function
Code The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.
- Function
Code Location Details about a function's deployment package.
- Function
Configuration Details about a function's configuration.
- Function
Event Invoke Config - Function
UrlConfig Details about a Lambda function URL.
- Image
Config Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
- Image
Config Error Error response to
GetFunctionConfiguration
.- Image
Config Response Response to a
GetFunctionConfiguration
request.- Invoke
Response Stream Update A chunk of the streamed response payload.
- Invoke
With Response Stream Complete Event A response confirming that the event stream is complete.
- Layer
An Lambda layer.
- Layer
Version Content Input A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
- Layer
Version Content Output Details about a version of an Lambda layer.
- Layer
Versions List Item Details about a version of an Lambda layer.
- Layers
List Item Details about an Lambda layer.
- Logging
Config The function's Amazon CloudWatch Logs configuration settings.
- OnFailure
A destination for events that failed processing.
- OnSuccess
A destination for events that were processed successfully.
To retain records of successful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.
- Provisioned
Concurrency Config List Item Details about the provisioned concurrency configuration for a function alias or version.
- Provisioned
Poller Config The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source. An event poller is a compute unit that provides approximately 5 MBps of throughput.
- Runtime
Version Config The ARN of the runtime and any errors that occured.
- Runtime
Version Error Any error returned when the runtime version information for the function could not be retrieved.
- Scaling
Config (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.
- Self
Managed Event Source The self-managed Apache Kafka cluster for your event source.
- Self
Managed Kafka Event Source Config Specific configuration settings for a self-managed Apache Kafka event source.
- Snap
Start The function's Lambda SnapStart setting. Set
ApplyOn
toPublishedVersions
to create a snapshot of the initialized execution environment when you publish a function version.- Snap
Start Response The function's SnapStart setting.
- Source
Access Configuration To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
- Tags
Error An object that contains details about an error related to retrieving tags.
- Tracing
Config The function's X-Ray tracing configuration. To sample and record incoming requests, set
Mode
toActive
.- Tracing
Config Response The function's X-Ray tracing configuration.
- VpcConfig
The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC.
- VpcConfig
Response The VPC security groups and subnets that are attached to a Lambda function.
Enums§
- Application
LogLevel - When writing a match expression against
ApplicationLogLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Architecture
- When writing a match expression against
Architecture
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Code
Signing Policy - When writing a match expression against
CodeSigningPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - EndPoint
Type - When writing a match expression against
EndPointType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Source Mapping Metric - When writing a match expression against
EventSourceMappingMetric
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Source Position - When writing a match expression against
EventSourcePosition
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Full
Document - When writing a match expression against
FullDocument
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Function
Response Type - When writing a match expression against
FunctionResponseType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Function
UrlAuth Type - When writing a match expression against
FunctionUrlAuthType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Function
Version - When writing a match expression against
FunctionVersion
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Invocation
Type - When writing a match expression against
InvocationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Invoke
Mode - When writing a match expression against
InvokeMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Invoke
With Response Stream Response Event An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a
InvokeComplete
object.- Last
Update Status - When writing a match expression against
LastUpdateStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Last
Update Status Reason Code - When writing a match expression against
LastUpdateStatusReasonCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - LogFormat
- When writing a match expression against
LogFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - LogType
- When writing a match expression against
LogType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Type - When writing a match expression against
PackageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Provisioned
Concurrency Status Enum - When writing a match expression against
ProvisionedConcurrencyStatusEnum
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recursive
Loop - When writing a match expression against
RecursiveLoop
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Response
Streaming Invocation Type - When writing a match expression against
ResponseStreamingInvocationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Runtime
- When writing a match expression against
Runtime
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Snap
Start Apply On - When writing a match expression against
SnapStartApplyOn
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Snap
Start Optimization Status - When writing a match expression against
SnapStartOptimizationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Access Type - When writing a match expression against
SourceAccessType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - State
- When writing a match expression against
State
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - State
Reason Code - When writing a match expression against
StateReasonCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - System
LogLevel - When writing a match expression against
SystemLogLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Throttle
Reason - When writing a match expression against
ThrottleReason
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Tracing
Mode - When writing a match expression against
TracingMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Update
Runtime On - When writing a match expression against
UpdateRuntimeOn
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.