Long totalCodeSize
The amount of storage space that you can use for all deployment packages and layer archives.
Long codeSizeUnzipped
The maximum size of a function's deployment package and layers when they're extracted.
Long codeSizeZipped
The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.
Integer concurrentExecutions
The maximum number of simultaneous function executions.
Integer unreservedConcurrentExecutions
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.
String layerName
The name or Amazon Resource Name (ARN) of the layer.
Long versionNumber
The version number.
String statementId
An identifier that distinguishes the policy from others on the same layer version.
String action
The API action that grants access to the layer. For example, lambda:GetLayerVersion
.
String principal
An account ID, or *
to grant layer usage permission to all accounts in an organization, or all
Amazon Web Services accounts (if organizationId
is not specified). For the last case, make sure that
you really do want all Amazon Web Services accounts to have usage permission to this layer.
String organizationId
With the principal set to *
, grant permission to all accounts in the specified organization.
String revisionId
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String statementId
A statement identifier that differentiates the statement from others in the same policy.
String action
The action that the principal can use on the function. For example, lambda:InvokeFunction
or
lambda:GetFunction
.
String principal
The Amazon Web Services service or account that invokes the function. If you specify a service, use
SourceArn
or SourceAccount
to limit who can invoke the function through that service.
String sourceArn
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike
operator.
String sourceAccount
For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn
to
ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted
by its owner and recreated by another account.
String eventSourceToken
For Alexa Smart Home functions, a token that must be supplied by the invoker.
String qualifier
Specify a version or alias to add permissions to a published version of the function.
String revisionId
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
String principalOrgID
The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
String functionUrlAuthType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
String statement
The permission statement that's added to the function policy.
String aliasArn
The Amazon Resource Name (ARN) of the alias.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String revisionId
A unique identifier that changes when you update the alias.
SdkInternalMap<K,V> additionalVersionWeights
The second version, and the percentage of traffic that's routed to it.
SdkInternalList<T> signingProfileVersionArns
The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.
String codeSigningConfigId
Unique identifer for the Code signing configuration.
String codeSigningConfigArn
The Amazon Resource Name (ARN) of the Code signing configuration.
String description
Code signing configuration description.
AllowedPublishers allowedPublishers
List of allowed publishers.
CodeSigningPolicies codeSigningPolicies
The code signing policy controls the validation failure action for signature mismatch or expiry.
String lastModified
The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String type
String untrustedArtifactOnDeployment
Code signing configuration policy for deployment validation failure. If you set the policy to
Enforce
, Lambda blocks the deployment request if signature validation checks fail. If you set the
policy to Warn
, Lambda allows the deployment and creates a CloudWatch log.
Default value: Warn
String type
The exception type.
String type
Integer reservedConcurrentExecutions
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
Boolean allowCredentials
Whether to allow cookies or other credentials in requests to your function URL. The default is false
.
SdkInternalList<T> allowHeaders
The HTTP headers that origins can include in requests to your function URL. For example: Date
,
Keep-Alive
, X-Custom-Header
.
SdkInternalList<T> allowMethods
The HTTP methods that are allowed when calling your function URL. For example: GET
,
POST
, DELETE
, or the wildcard character (*
).
SdkInternalList<T> allowOrigins
The origins that can access your function URL. You can list any number of specific origins, separated by a comma.
For example: https://www.example.com
, http://localhost:60905
.
Alternatively, you can grant access to all origins using the wildcard character (*
).
SdkInternalList<T> exposeHeaders
The HTTP headers in your function response that you want to expose to origins that call your function URL. For
example: Date
, Keep-Alive
, X-Custom-Header
.
Integer maxAge
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default,
this is set to 0
, which means that the browser doesn't cache results.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String aliasArn
The Amazon Resource Name (ARN) of the alias.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String revisionId
A unique identifier that changes when you update the alias.
String description
Descriptive name for this code signing configuration.
AllowedPublishers allowedPublishers
Signing profiles for this code signing configuration.
CodeSigningPolicies codeSigningPolicies
The code signing policies define the actions to take if the validation checks fail.
CodeSigningConfig codeSigningConfig
The code signing configuration.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Boolean enabled
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 10,000.
Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
Self-Managed Apache Kafka - Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process from each shard concurrently.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is infinite (-1).
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of authentication protocols or VPC components required to secure your event source.
SelfManagedEventSource selfManagedEventSource
The Self-Managed Apache Kafka cluster to send records.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String uUID
The identifier of the event source mapping.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK stream sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
String functionArn
The ARN of the Lambda function.
Date lastModified
The date that the event source mapping was last updated or that its state changed.
String lastProcessingResult
The result of the last Lambda invocation of your function.
String state
The state of the event source mapping. It can be one of the following: Creating
,
Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
String stateTransitionReason
Indicates whether a user or Lambda made the last change to the event source mapping.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
SelfManagedEventSource selfManagedEventSource
The self-managed Apache Kafka cluster for your event source.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String runtime
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
String role
The Amazon Resource Name (ARN) of the function's execution role.
String handler
The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
FunctionCode code
The code for the function.
String description
A description of the function.
Integer timeout
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.
Integer memorySize
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
Boolean publish
Set to true to publish the first version of the function during creation.
VpcConfig vpcConfig
For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
DeadLetterConfig deadLetterConfig
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
Environment environment
Environment variables that are accessible from function code during execution.
String kMSKeyArn
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
TracingConfig tracingConfig
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.
SdkInternalMap<K,V> tags
A list of tags to apply to the function.
SdkInternalList<T> layers
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
ImageConfig imageConfig
Container image configuration values that override the values in the container image Dockerfile.
String codeSigningConfigArn
To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Enter a string array with one of the valid values
(arm64 or x86_64). The default value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The alias name.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String functionUrl
The HTTP URL endpoint for your function.
String functionArn
The Amazon Resource Name (ARN) of your function.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String creationTime
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String targetArn
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
The name of the alias.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String uUID
The identifier of the event source mapping.
String uUID
The identifier of the event source mapping.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK stream sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
String functionArn
The ARN of the Lambda function.
Date lastModified
The date that the event source mapping was last updated or that its state changed.
String lastProcessingResult
The result of the last Lambda invocation of your function.
String state
The state of the event source mapping. It can be one of the following: Creating
,
Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
String stateTransitionReason
Indicates whether a user or Lambda made the last change to the event source mapping.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
SelfManagedEventSource selfManagedEventSource
The self-managed Apache Kafka cluster for your event source.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
A version number or alias name.
String functionName
The name of the Lambda function or version.
Name formats
Function name - my-function
(name-only), my-function:1
(with version).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
Specify a version to delete. You can't delete a version that's referenced by an alias.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The alias name.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The version number or alias name.
String type
String type
String type
String type
String type
String type
String type
SdkInternalMap<K,V> variables
Environment variable key-value pairs. For more information, see Using Lambda environment variables.
SdkInternalMap<K,V> variables
Environment variable key-value pairs.
EnvironmentError error
Error messages for environment variables that couldn't be applied.
Integer size
The size of the function’s /tmp directory.
String uUID
The identifier of the event source mapping.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK stream sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
String functionArn
The ARN of the Lambda function.
Date lastModified
The date that the event source mapping was last updated or that its state changed.
String lastProcessingResult
The result of the last Lambda invocation of your function.
String state
The state of the event source mapping. It can be one of the following: Creating
,
Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
String stateTransitionReason
Indicates whether a user or Lambda made the last change to the event source mapping.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
SelfManagedEventSource selfManagedEventSource
The self-managed Apache Kafka cluster for your event source.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String pattern
A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
SdkInternalList<T> filters
A list of filters.
ByteBuffer zipFile
The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
String s3Bucket
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
String s3Key
The Amazon S3 key of the deployment package.
String s3ObjectVersion
For versioned objects, the version of the deployment package object to use.
String imageUri
URI of a container image in the Amazon ECR registry.
String repositoryType
The service that's hosting the file.
String location
A presigned URL that you can use to download the deployment package.
String imageUri
URI of a container image in the Amazon ECR registry.
String resolvedImageUri
The resolved URI for the image.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
Date lastModified
The date and time that the configuration was last updated.
String functionArn
The Amazon Resource Name (ARN) of the function.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
String functionUrl
The HTTP URL endpoint for your function.
String functionArn
The Amazon Resource Name (ARN) of your function.
String creationTime
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String lastModifiedTime
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
AccountLimit accountLimit
Limits that are related to concurrency and code storage.
AccountUsage accountUsage
The number of functions and amount of storage in use.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
The name of the alias.
String aliasArn
The Amazon Resource Name (ARN) of the alias.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String revisionId
A unique identifier that changes when you update the alias.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
CodeSigningConfig codeSigningConfig
The code signing configuration
String uUID
The identifier of the event source mapping.
String uUID
The identifier of the event source mapping.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK stream sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
String functionArn
The ARN of the Lambda function.
Date lastModified
The date that the event source mapping was last updated or that its state changed.
String lastProcessingResult
The result of the last Lambda invocation of your function.
String state
The state of the event source mapping. It can be one of the following: Creating
,
Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
String stateTransitionReason
Indicates whether a user or Lambda made the last change to the event source mapping.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
SelfManagedEventSource selfManagedEventSource
The self-managed Apache Kafka cluster for your event source.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Integer reservedConcurrentExecutions
The number of simultaneous executions that are reserved for the function.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
Specify a version or alias to get details about a published version of the function.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
A version number or alias name.
Date lastModified
The date and time that the configuration was last updated.
String functionArn
The Amazon Resource Name (ARN) of the function.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
Specify a version or alias to get details about a published version of the function.
FunctionConfiguration configuration
The configuration of the function or version.
FunctionCodeLocation code
The deployment package of the function or version.
SdkInternalMap<K,V> tags
The function's tags.
Concurrency concurrency
The function's reserved concurrency.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The alias name.
String functionUrl
The HTTP URL endpoint for your function.
String functionArn
The Amazon Resource Name (ARN) of your function.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String creationTime
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String lastModifiedTime
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String arn
The ARN of the layer version.
LayerVersionContentOutput content
Details about the layer version.
String layerArn
The ARN of the layer.
String layerVersionArn
The ARN of the layer version.
String description
The description of the version.
String createdDate
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Long version
The version number.
SdkInternalList<T> compatibleRuntimes
The layer's compatible runtimes.
String licenseInfo
The layer's software license.
SdkInternalList<T> compatibleArchitectures
A list of compatible instruction set architectures.
LayerVersionContentOutput content
Details about the layer version.
String layerArn
The ARN of the layer.
String layerVersionArn
The ARN of the layer version.
String description
The description of the version.
String createdDate
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Long version
The version number.
SdkInternalList<T> compatibleRuntimes
The layer's compatible runtimes.
String licenseInfo
The layer's software license.
SdkInternalList<T> compatibleArchitectures
A list of compatible instruction set architectures.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
Specify a version or alias to get the policy for that resource.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The version number or alias name.
Integer requestedProvisionedConcurrentExecutions
The amount of provisioned concurrency requested.
Integer availableProvisionedConcurrentExecutions
The amount of provisioned concurrency available.
Integer allocatedProvisionedConcurrentExecutions
The amount of provisioned concurrency allocated.
String status
The status of the allocation process.
String statusReason
For failed allocations, the reason that provisioned concurrency could not be allocated.
String lastModified
The date and time that a user last updated the configuration, in ISO 8601 format.
SdkInternalList<T> entryPoint
Specifies the entry point to their application, which is typically the location of the runtime executable.
SdkInternalList<T> command
Specifies parameters that you want to pass in with ENTRYPOINT.
String workingDirectory
Specifies the working directory.
ImageConfig imageConfig
Configuration values that override the container image Dockerfile.
ImageConfigError error
Error response to GetFunctionConfiguration.
String type
String type
The exception type.
String type
The exception type.
String type
String type
String type
String type
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
InputStream invokeArgs
The JSON that you want to provide to your Lambda function as input.
Integer status
The status code.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String invocationType
Choose from the following options.
RequestResponse
(default) - Invoke the function synchronously. Keep the connection open until the
function returns a response or times out. The API response includes the function response and additional data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function's
dead-letter queue (if it's configured). The API response only includes a status code.
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the
function.
String logType
Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
only.
String clientContext
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
ByteBuffer payload
The JSON that you want to provide to your Lambda function as input.
You can enter the JSON directly. For example, --payload '{ "key": "value" }'
. You can also specify a
file path. For example, --payload file://payload.json
.
String qualifier
Specify a version or alias to invoke a published version of the function.
Integer statusCode
The HTTP status code is in the 200 range for a successful request. For the RequestResponse
invocation type, this status code is 200. For the Event
invocation type, this status code is 202.
For the DryRun
invocation type, the status code is 204.
String functionError
If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
String logResult
The last 4 KB of the execution log, which is base64 encoded.
ByteBuffer payload
The response from the function, or an error object.
String executedVersion
The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
String type
String type
String type
String type
String arn
The Amazon Resource Name (ARN) of the function layer.
Long codeSize
The size of the layer archive in bytes.
String signingProfileVersionArn
The Amazon Resource Name (ARN) for a signing profile version.
String signingJobArn
The Amazon Resource Name (ARN) of a signing job.
String layerName
The name of the layer.
String layerArn
The Amazon Resource Name (ARN) of the function layer.
LayerVersionsListItem latestMatchingVersion
The newest version of the layer.
String s3Bucket
The Amazon S3 bucket of the layer archive.
String s3Key
The Amazon S3 key of the layer archive.
String s3ObjectVersion
For versioned objects, the version of the layer archive object to use.
ByteBuffer zipFile
The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
String location
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
String codeSha256
The SHA-256 hash of the layer archive.
Long codeSize
The size of the layer archive in bytes.
String signingProfileVersionArn
The Amazon Resource Name (ARN) for a signing profile version.
String signingJobArn
The Amazon Resource Name (ARN) of a signing job.
String layerVersionArn
The ARN of the layer version.
Long version
The version number.
String description
The description of the version.
String createdDate
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000
.
SdkInternalList<T> compatibleRuntimes
The layer's compatible runtimes.
String licenseInfo
The layer's open-source license.
SdkInternalList<T> compatibleArchitectures
A list of compatible instruction set architectures.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionVersion
Specify a function version to only list aliases that invoke that version.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
Limit the number of aliases returned.
String nextMarker
The pagination token that's included if more results are available.
SdkInternalList<T> aliases
A list of aliases.
String nextMarker
The pagination token that's included if more results are available.
SdkInternalList<T> codeSigningConfigs
The code signing configurations
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
String marker
A pagination token returned by a previous call.
Integer maxItems
The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.
String nextMarker
A pagination token that's returned when the response doesn't contain all event source mappings.
SdkInternalList<T> eventSourceMappings
A list of event source mappings.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
The maximum number of configurations to return.
SdkInternalList<T> functionEventInvokeConfigs
A list of configurations.
String nextMarker
The pagination token that's included if more results are available.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
Maximum number of items to return.
String nextMarker
The pagination token that's included if more results are available.
SdkInternalList<T> functionArns
The function ARNs.
String masterRegion
For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example,
us-east-1
filters the list of functions to only include Lambda@Edge functions replicated from a
master function in US East (N. Virginia). If specified, you must set FunctionVersion
to
ALL
.
String functionVersion
Set to ALL
to include entries for all published versions of each function.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
The maximum number of functions to return in the response. Note that ListFunctions
returns a maximum
of 50 items in each response, even if you set the number higher.
String nextMarker
The pagination token that's included if more results are available.
SdkInternalList<T> functions
A list of Lambda functions.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs
returns a maximum of 50 items in each response, even if you set the number higher.
SdkInternalList<T> functionUrlConfigs
A list of function URL configurations.
String nextMarker
The pagination token that's included if more results are available.
String compatibleRuntime
A runtime identifier. For example, go1.x
.
String marker
A pagination token returned by a previous call.
Integer maxItems
The maximum number of layers to return.
String compatibleArchitecture
The compatible instruction set architecture.
String nextMarker
A pagination token returned when the response doesn't contain all layers.
SdkInternalList<T> layers
A list of function layers.
String compatibleRuntime
A runtime identifier. For example, go1.x
.
String layerName
The name or Amazon Resource Name (ARN) of the layer.
String marker
A pagination token returned by a previous call.
Integer maxItems
The maximum number of versions to return.
String compatibleArchitecture
The compatible instruction set architecture.
String nextMarker
A pagination token returned when the response doesn't contain all versions.
SdkInternalList<T> layerVersions
A list of versions.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
Specify a number to limit the number of configurations returned.
SdkInternalList<T> provisionedConcurrencyConfigs
A list of provisioned concurrency configurations.
String nextMarker
The pagination token that's included if more results are available.
String resource
The function's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to aliases or versions.
SdkInternalMap<K,V> tags
The function's tags.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Integer maxItems
The maximum number of versions to return. Note that ListVersionsByFunction
returns a maximum of 50
items in each response, even if you set the number higher.
String nextMarker
The pagination token that's included if more results are available.
SdkInternalList<T> versions
A list of Lambda function versions.
String destination
The Amazon Resource Name (ARN) of the destination resource.
String destination
The Amazon Resource Name (ARN) of the destination resource.
String type
String type
The exception type.
String functionArn
The Amazon Resource Name (ARN) of the alias or version.
Integer requestedProvisionedConcurrentExecutions
The amount of provisioned concurrency requested.
Integer availableProvisionedConcurrentExecutions
The amount of provisioned concurrency available.
Integer allocatedProvisionedConcurrentExecutions
The amount of provisioned concurrency allocated.
String status
The status of the allocation process.
String statusReason
For failed allocations, the reason that provisioned concurrency could not be allocated.
String lastModified
The date and time that a user last updated the configuration, in ISO 8601 format.
String type
String layerName
The name or Amazon Resource Name (ARN) of the layer.
String description
The description of the version.
LayerVersionContentInput content
The function layer archive.
SdkInternalList<T> compatibleRuntimes
A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
String licenseInfo
The layer's software license. It can be any of the following:
An SPDX license identifier. For example, MIT
.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT
.
The full text of the license.
SdkInternalList<T> compatibleArchitectures
A list of compatible instruction set architectures.
LayerVersionContentOutput content
Details about the layer version.
String layerArn
The ARN of the layer.
String layerVersionArn
The ARN of the layer version.
String description
The description of the version.
String createdDate
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Long version
The version number.
SdkInternalList<T> compatibleRuntimes
The layer's compatible runtimes.
String licenseInfo
The layer's software license.
SdkInternalList<T> compatibleArchitectures
A list of compatible instruction set architectures.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String codeSha256
Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.
String description
A description for the version to override the description in the function configuration.
String revisionId
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Integer reservedConcurrentExecutions
The number of simultaneous executions to reserve for the function.
Integer reservedConcurrentExecutions
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
A version number or alias name.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
Date lastModified
The date and time that the configuration was last updated.
String functionArn
The Amazon Resource Name (ARN) of the function.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The version number or alias name.
Integer provisionedConcurrentExecutions
The amount of provisioned concurrency to allocate for the version or alias.
Integer requestedProvisionedConcurrentExecutions
The amount of provisioned concurrency requested.
Integer availableProvisionedConcurrentExecutions
The amount of provisioned concurrency available.
Integer allocatedProvisionedConcurrentExecutions
The amount of provisioned concurrency allocated.
String status
The status of the allocation process.
String statusReason
For failed allocations, the reason that provisioned concurrency could not be allocated.
String lastModified
The date and time that a user last updated the configuration, in ISO 8601 format.
String layerName
The name or Amazon Resource Name (ARN) of the layer.
Long versionNumber
The version number.
String statementId
The identifier that was specified when the statement was added.
String revisionId
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String statementId
Statement ID of the permission to remove.
String qualifier
Specify a version or alias to remove permissions from a published version of the function.
String revisionId
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
String type
String type
The exception type.
String type
String type
String type
The exception type.
SdkInternalMap<K,V> endpoints
The list of bootstrap servers for your Kafka brokers in the following format:
"KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]
.
String type
String type
The type of authentication protocol, VPC components, or virtual host for your event source. For example:
"Type":"SASL_SCRAM_512_AUTH"
.
BASIC_AUTH
- (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
BASIC_AUTH
- (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for
SASL/PLAIN authentication of your Apache Kafka brokers.
VPC_SUBNET
- The subnets associated with your VPC. Lambda connects to these subnets to fetch data
from your self-managed Apache Kafka cluster.
VPC_SECURITY_GROUP
- The VPC security group used to manage access to your self-managed Apache Kafka
brokers.
SASL_SCRAM_256_AUTH
- The Secrets Manager ARN of your secret key used for SASL SCRAM-256
authentication of your self-managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH
- The Secrets Manager ARN of your secret key used for SASL SCRAM-512
authentication of your self-managed Apache Kafka brokers.
VIRTUAL_HOST
- (Amazon MQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this
RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
CLIENT_CERTIFICATE_TLS_AUTH
- (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of
your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password
(optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
SERVER_ROOT_CA_CERTIFICATE
- (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key
containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
String uRI
The value for your chosen configuration in Type
. For example:
"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
String type
String resource
The function's Amazon Resource Name (ARN).
SdkInternalMap<K,V> tags
A list of tags to apply to the function.
String mode
The tracing mode.
String mode
The tracing mode.
String type
String resource
The function's Amazon Resource Name (ARN).
SdkInternalList<T> tagKeys
A list of tag keys to remove from the function.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String revisionId
Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.
String aliasArn
The Amazon Resource Name (ARN) of the alias.
String name
The name of the alias.
String functionVersion
The function version that the alias invokes.
String description
A description of the alias.
AliasRoutingConfiguration routingConfig
The routing configuration of the alias.
String revisionId
A unique identifier that changes when you update the alias.
String codeSigningConfigArn
The The Amazon Resource Name (ARN) of the code signing configuration.
String description
Descriptive name for this code signing configuration.
AllowedPublishers allowedPublishers
Signing profiles for this code signing configuration.
CodeSigningPolicies codeSigningPolicies
The code signing policy.
CodeSigningConfig codeSigningConfig
The code signing configuration
String uUID
The identifier of the event source mapping.
String functionName
The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Boolean enabled
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 10,000.
Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
Self-Managed Apache Kafka - Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is infinite (-1).
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
Integer parallelizationFactor
(Streams only) The number of batches to process from each shard concurrently.
SdkInternalList<T> sourceAccessConfigurations
An array of authentication protocols or VPC components required to secure your event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String uUID
The identifier of the event source mapping.
String startingPosition
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon
MSK stream sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams.
Date startingPositionTimestamp
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
Integer batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer maximumBatchingWindowInSeconds
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize
to a value greater than 10, you must set
MaximumBatchingWindowInSeconds
to at least 1.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source.
FilterCriteria filterCriteria
(Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
String functionArn
The ARN of the Lambda function.
Date lastModified
The date that the event source mapping was last updated or that its state changed.
String lastProcessingResult
The result of the last Lambda invocation of your function.
String state
The state of the event source mapping. It can be one of the following: Creating
,
Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
String stateTransitionReason
Indicates whether a user or Lambda made the last change to the event source mapping.
DestinationConfig destinationConfig
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SdkInternalList<T> topics
The name of the Kafka topic.
SdkInternalList<T> queues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
SdkInternalList<T> sourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
SelfManagedEventSource selfManagedEventSource
The self-managed Apache Kafka cluster for your event source.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
Boolean bisectBatchOnFunctionError
(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
Integer tumblingWindowInSeconds
(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
SdkInternalList<T> functionResponseTypes
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
ByteBuffer zipFile
The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
String s3Bucket
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
String s3Key
The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
String s3ObjectVersion
For versioned objects, the version of the deployment package object to use.
String imageUri
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
Boolean publish
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
Boolean dryRun
Set to true to validate the request parameters and access permissions without modifying the function code.
String revisionId
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Enter a string array with one of the valid values
(arm64 or x86_64). The default value is x86_64
.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String role
The Amazon Resource Name (ARN) of the function's execution role.
String handler
The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
String description
A description of the function.
Integer timeout
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.
Integer memorySize
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
VpcConfig vpcConfig
For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
Environment environment
Environment variables that are accessible from function code during execution.
String runtime
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
DeadLetterConfig deadLetterConfig
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
String kMSKeyArn
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
TracingConfig tracingConfig
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.
String revisionId
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
SdkInternalList<T> layers
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
ImageConfig imageConfig
Container image configuration values that override the values in the container image Docker file.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the function.
String functionArn
The function's Amazon Resource Name (ARN).
String runtime
The runtime environment for the Lambda function.
String role
The function's execution role.
String handler
The function that Lambda calls to begin executing your function.
Long codeSize
The size of the function's deployment package, in bytes.
String description
The function's description.
Integer timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
Integer memorySize
The amount of memory available to the function at runtime.
String lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String codeSha256
The SHA256 hash of the function's deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
The function's networking configuration.
DeadLetterConfig deadLetterConfig
The function's dead letter queue.
EnvironmentResponse environment
The function's environment variables.
String kMSKeyArn
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
TracingConfigResponse tracingConfig
The function's X-Ray tracing configuration.
String masterArn
For Lambda@Edge functions, the ARN of the main function.
String revisionId
The latest updated revision of the function or alias.
SdkInternalList<T> layers
The function's layers.
String state
The current state of the function. When the state is Inactive
, you can reactivate the function by
invoking it.
String stateReason
The reason for the function's current state.
String stateReasonCode
The reason code for the function's current state. When the code is Creating
, you can't invoke or
modify the function.
String lastUpdateStatus
The status of the last update that was performed on the function. This is first set to Successful
after function creation completes.
String lastUpdateStatusReason
The reason for the last update that was performed on the function.
String lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
SdkInternalList<T> fileSystemConfigs
Connection settings for an Amazon EFS file system.
String packageType
The type of deployment package. Set to Image
for container image and set Zip
for .zip
file archive.
ImageConfigResponse imageConfigResponse
The function's image configuration values.
String signingProfileVersionArn
The ARN of the signing profile version.
String signingJobArn
The ARN of the signing job.
SdkInternalList<T> architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid
values. The default architecture value is x86_64
.
EphemeralStorage ephemeralStorage
The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.
String functionName
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
A version number or alias name.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
Date lastModified
The date and time that the configuration was last updated.
String functionArn
The Amazon Resource Name (ARN) of the function.
Integer maximumRetryAttempts
The maximum number of times to retry when the function returns an error.
Integer maximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig destinationConfig
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
String functionName
The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
The alias name.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String functionUrl
The HTTP URL endpoint for your function.
String functionArn
The Amazon Resource Name (ARN) of your function.
String authType
The type of authentication that your function URL uses. Set to AWS_IAM
if you want to restrict
access to authenticated IAM
users only. Set to NONE
if you want to bypass IAM
authentication to create a public endpoint. For more information, see Security and auth model for Lambda function
URLs.
Cors cors
The cross-origin resource sharing (CORS) settings for your function URL.
String creationTime
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String lastModifiedTime
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
SdkInternalList<T> subnetIds
A list of VPC subnet IDs.
SdkInternalList<T> securityGroupIds
A list of VPC security groups IDs.
SdkInternalList<T> subnetIds
A list of VPC subnet IDs.
SdkInternalList<T> securityGroupIds
A list of VPC security groups IDs.
String vpcId
The ID of the VPC.
Copyright © 2022. All rights reserved.