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.
- Callback
Details Contains details about a callback operation in a durable execution, including the callback token and timeout configuration.
- Callback
Failed Details Contains details about a failed callback operation, including error information and the reason for failure.
- Callback
Options Configuration options for callback operations in durable executions, including timeout settings and retry behavior.
- Callback
Started Details Contains details about a callback operation that has started, including timing information and callback metadata.
- Callback
Succeeded Details Contains details about a successfully completed callback operation, including the result data and completion timestamp.
- Callback
Timed OutDetails Contains details about a callback operation that timed out, including timeout duration and any partial results.
- Capacity
Provider A capacity provider manages compute resources for Lambda functions.
- Capacity
Provider Config Configuration for the capacity provider that manages compute resources for Lambda functions.
- Capacity
Provider Permissions Config Configuration that specifies the permissions required for the capacity provider to manage compute resources.
- Capacity
Provider Scaling Config Configuration that defines how the capacity provider scales compute instances based on demand and policies.
- Capacity
Provider VpcConfig VPC configuration that specifies the network settings for compute instances managed by the capacity provider.
- Chained
Invoke Details Contains details about a chained function invocation in a durable execution, including the target function and invocation parameters.
- Chained
Invoke Failed Details Contains details about a failed chained function invocation, including error information and failure reason.
- Chained
Invoke Options Configuration options for chained function invocations in durable executions, including retry settings and timeout configuration.
- Chained
Invoke Started Details Contains details about a chained function invocation that has started execution, including start time and execution context.
- Chained
Invoke Stopped Details Details about a chained invocation that was stopped.
- Chained
Invoke Succeeded Details Details about a chained invocation that succeeded.
- Chained
Invoke Timed OutDetails Details about a chained invocation that timed out.
- Checkpoint
Updated Execution State Contains operations that have been updated since the last checkpoint, such as completed asynchronous work like timers or callbacks.
- 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
- Context
Details Details about a durable execution context.
- Context
Failed Details Details about a context that failed.
- Context
Options Configuration options for a durable execution context.
- Context
Started Details Details about a context that has started.
- Context
Succeeded Details Details about a context that succeeded.
- 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. For more information, see Adding a destination.
- Document
DbEvent Source Config Specific configuration settings for a DocumentDB event source.
- Durable
Config Configuration settings for durable functions, including execution timeout and retention period for execution history.
- 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
/tmpdirectory 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).- Error
Object An object that contains error information.
- Event
An event that occurred during the execution of a durable function.
- Event
Error Error information for an event.
- Event
Input Input information for an event.
- Event
Result Result information for an event.
- 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.
- Execution
Information about a durable execution.
- Execution
Details Details about a durable execution.
- Execution
Failed Details Details about a failed durable execution.
- Execution
Started Details Details about a durable execution that started.
- Execution
Stopped Details Details about a durable execution that stopped.
- Execution
Succeeded Details Details about a durable execution that succeeded.
- Execution
Timed OutDetails Details about a durable execution that timed out.
- File
System Config Details about the connection between a Lambda function and an Amazon EFS file system.
- Filter
A structure within a
FilterCriteriaobject 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
Scaling Config Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.
- Function
UrlConfig Details about a Lambda function URL.
- Function
Versions ByCapacity Provider List Item Information about a function version that uses a specific capacity provider, including its ARN and current state.
- 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
GetFunctionConfigurationrequest.- Instance
Requirements Specifications that define the characteristics and constraints for compute instances used by the capacity provider.
- Invocation
Completed Details Details about a function invocation that completed.
- 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.
- Kafka
Schema Registry Access Config Specific access configuration settings that tell Lambda how to authenticate with your schema registry.
If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.
If you're working with a Confluent schema registry, choose the authentication method in the
Typefield, and provide the Secrets Manager secret ARN in theURIfield.- Kafka
Schema Registry Config Specific configuration settings for a Kafka schema registry.
- Kafka
Schema Validation Config Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.
- Lambda
Managed Instances Capacity Provider Config Configuration for Lambda-managed instances used by the capacity provider.
- 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. For more information, see Adding a destination.
- 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.
OnSuccessis not supported inCreateEventSourceMappingorUpdateEventSourceMappingrequests.- Operation
Information about an operation within a durable execution.
- Operation
Update An update to be applied to an operation during checkpointing.
- 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.
- Retry
Details Information about retry attempts for an operation.
- 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
ApplyOntoPublishedVersionsto 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.
- Step
Details Details about a step operation.
- Step
Failed Details Details about a step that failed.
- Step
Options Configuration options for a step operation.
- Step
Started Details Details about a step that has started.
- Step
Succeeded Details Details about a step that succeeded.
- Tags
Error An object that contains details about an error related to retrieving tags.
- Target
Tracking Scaling Policy A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.
- Tenancy
Config Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation.
- Trace
Header Contains trace headers for the Lambda durable execution.
- Tracing
Config The function's X-Ray tracing configuration. To sample and record incoming requests, set
ModetoActive.- 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.
- Wait
Cancelled Details Details about a wait operation that was cancelled.
- Wait
Details Details about a wait operation.
- Wait
Options Specifies how long to pause the durable execution.
- Wait
Started Details Details about a wait operation that has started.
- Wait
Succeeded Details Details about a wait operation that succeeded.
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. - Capacity
Provider Predefined Metric Type - When writing a match expression against
CapacityProviderPredefinedMetricType, 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. - Capacity
Provider Scaling Mode - When writing a match expression against
CapacityProviderScalingMode, 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. - Capacity
Provider State - When writing a match expression against
CapacityProviderState, 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. - Event
Type - When writing a match expression against
EventType, 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. - Execution
Status - When writing a match expression against
ExecutionStatus, 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. - Function
Version Latest Published - When writing a match expression against
FunctionVersionLatestPublished, 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
InvokeCompleteobject.- Kafka
Schema Registry Auth Type - When writing a match expression against
KafkaSchemaRegistryAuthType, 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. - Kafka
Schema Validation Attribute - When writing a match expression against
KafkaSchemaValidationAttribute, 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 - 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. - Operation
Action - When writing a match expression against
OperationAction, 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. - Operation
Status - When writing a match expression against
OperationStatus, 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. - Operation
Type - When writing a match expression against
OperationType, 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. - Schema
Registry Event Record Format - When writing a match expression against
SchemaRegistryEventRecordFormat, 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. - Tenant
Isolation Mode - When writing a match expression against
TenantIsolationMode, 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.