Long totalCodeSize
Maximum size, in bytes, of a code package you can upload per region. The default size is 75 GB.
Long codeSizeUnzipped
Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.
Long codeSizeZipped
Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.
Integer concurrentExecutions
Number of simultaneous executions of your function per region. For more information or to request a limit increase for concurrent executions, see Lambda Function Concurrent Executions. The default limit is 1000.
Integer unreservedConcurrentExecutions
The number of concurrent executions available to functions that do not have concurrency limits set. For more information, see concurrent-executions.
String functionName
Name of the Lambda function whose resource policy you are updating by adding a new permission.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
String statementId
A unique statement identifier.
String action
The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with
lambda:
followed by the API name . For example, lambda:CreateFunction
. You can use
wildcard (lambda:*
) to grant permission for all AWS Lambda actions.
String principal
The principal who is getting this permission. It can be Amazon S3 service Principal (
s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are
granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com
. For
example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by
invoking your function.
String sourceArn
This is optional; however, when granting permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function.
If you add a permission without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function.
String sourceAccount
This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if
the SourceArn
identifies a bucket, then this is the bucket owner's account ID. You can use this
additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket
owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to
specify all sources (that is, you don't specify the SourceArn
) owned by a specific account.
String eventSourceToken
A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
String qualifier
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example PROD
, then the permission is valid only for requests made
using the alias ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String statement
The permission statement you specified in the request. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.
String aliasArn
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias
called BETA
that points to a helloworld function version, the ARN is
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
String name
Alias name.
String functionVersion
Function version to which the alias points.
String description
Alias description.
AliasRoutingConfiguration routingConfig
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String revisionId
Represents the latest updated revision of the function or alias.
SdkInternalMap<K,V> additionalVersionWeights
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty
string, 100 percent of traffic will invoke function-version
. For more information, see
lambda-traffic-shifting-using-aliases.
String type
Integer reservedConcurrentExecutions
The number of concurrent executions reserved for this function. For more information, see concurrent-executions.
String functionName
Name of the Lambda function for which you want to create an alias. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
Name for the alias you are creating.
String functionVersion
Lambda function version for which you are creating the alias.
String description
Description of the alias.
AliasRoutingConfiguration routingConfig
Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String aliasArn
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias
called BETA
that points to a helloworld function version, the ARN is
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
String name
Alias name.
String functionVersion
Function version to which the alias points.
String description
Alias description.
AliasRoutingConfiguration routingConfig
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String revisionId
Represents the latest updated revision of the function or alias.
String eventSourceArn
The Amazon Resource Name (ARN) of the event source. Any record added to this source could cause AWS Lambda to
invoke your Lambda function, it depends on the BatchSize
. AWS Lambda POSTs the event's records to
your Lambda function as JSON.
String functionName
The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).
If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).
Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
Boolean enabled
Indicates whether AWS Lambda should begin polling the event source. By default, Enabled
is true.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default for Amazon Kinesis and Amazon DynamoDB is 100 records. For SQS, the default is 1.
String startingPosition
The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading. For more information, see
GetShardIterator in the Amazon Kinesis API Reference Guide or GetShardIterator in the Amazon DynamoDB API Reference Guide. The AT_TIMESTAMP
value is
supported only for Kinesis
streams.
Date startingPositionTimestamp
The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). Valid only for Kinesis streams.
String uUID
The AWS Lambda assigned opaque identifier for the mapping.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.
Date lastModified
The UTC time string indicating the last time the event mapping was updated.
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.
String state
The state of the event source mapping. It can be Creating
, Enabled
,
Disabled
, Enabling
, Disabling
, Updating
, or
Deleting
.
String stateTransitionReason
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
String functionName
The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String runtime
The runtime environment for the Lambda function you are uploading.
To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use the .NET Core runtime v1.0, set the value to "dotnetcore1.0". To use the .NET Core runtime v2.0, set the value to "dotnetcore2.0".
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works.
String handler
The function within your code that Lambda calls to begin execution. For Node.js, it is the
module-name.export value in your function. For Java, it can be
package.class-name::handler
or package.class-name
. For more information, see Lambda Function
Handler (Java).
FunctionCode code
The code for the Lambda function.
String description
A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
Boolean publish
This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
VpcConfig vpcConfig
If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
Environment environment
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.
TracingConfig tracingConfig
The parent object that contains your function's tracing settings.
SdkInternalMap<K,V> tags
The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
String targetArn
String functionName
The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
Name of the alias to delete.
String uUID
The event source mapping ID.
String uUID
The AWS Lambda assigned opaque identifier for the mapping.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.
Date lastModified
The UTC time string indicating the last time the event mapping was updated.
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.
String state
The state of the event source mapping. It can be Creating
, Enabled
,
Disabled
, Enabling
, Disabling
, Updating
, or
Deleting
.
String stateTransitionReason
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
String functionName
The name of the function you are removing concurrent execution limits from. For more information, see concurrent-executions.
String functionName
The Lambda function to delete.
You can specify the function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). If you
are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version
or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID
qualifier (for example, account-id:Thumbnail
). Note that the length constraint applies only to the
ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
Using this optional parameter you can specify a function version (but not the $LATEST
version) to
direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing
to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version
but not the $LATEST
, that is, you cannot specify $LATEST
as the value of this
parameter. The $LATEST
version can be deleted only when you want to delete all the function versions
and aliases.
You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias.
If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases.
String type
String type
String type
SdkInternalMap<K,V> variables
The key-value pairs that represent your environment's configuration settings.
SdkInternalMap<K,V> variables
The key-value pairs returned that represent your environment's configuration settings or error information.
EnvironmentError error
String uUID
The AWS Lambda assigned opaque identifier for the mapping.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.
Date lastModified
The UTC time string indicating the last time the event mapping was updated.
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.
String state
The state of the event source mapping. It can be Creating
, Enabled
,
Disabled
, Enabling
, Disabling
, Updating
, or
Deleting
.
String stateTransitionReason
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
ByteBuffer zipFile
The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions in the AWS Lambda Developer Guide.
String s3Bucket
Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.
String s3Key
The Amazon S3 object (the deployment package) key name you want to upload.
String s3ObjectVersion
The Amazon S3 object (the deployment package) version you want to upload.
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
AccountLimit accountLimit
AccountUsage accountUsage
String functionName
Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
Name of the alias for which you want to retrieve information.
String aliasArn
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias
called BETA
that points to a helloworld function version, the ARN is
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
String name
Alias name.
String functionVersion
Function version to which the alias points.
String description
Alias description.
AliasRoutingConfiguration routingConfig
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String revisionId
Represents the latest updated revision of the function or alias.
String uUID
The AWS Lambda assigned ID of the event source mapping.
String uUID
The AWS Lambda assigned opaque identifier for the mapping.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.
Date lastModified
The UTC time string indicating the last time the event mapping was updated.
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.
String state
The state of the event source mapping. It can be Creating
, Enabled
,
Disabled
, Enabling
, Disabling
, Updating
, or
Deleting
.
String stateTransitionReason
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
String functionName
The name of the Lambda function for which you want to retrieve the configuration information.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
String qualifier
Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.
If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the
$LATEST
function version.
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
String functionName
The Lambda function name.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
String qualifier
Use this optional parameter to specify a function version or an alias name. If you specify function version, the
API uses qualified function ARN for the request and returns information about the specific Lambda function
version. If you specify an alias name, the API uses the alias ARN and returns information about the function
version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and
returns information about the $LATEST
version of the Lambda function.
FunctionConfiguration configuration
FunctionCodeLocation code
SdkInternalMap<K,V> tags
Returns the list of tags associated with the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
Concurrency concurrency
The concurrent execution limit set for this function. For more information, see concurrent-executions.
String functionName
Function name whose resource policy you want to retrieve.
You can specify the function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). If you
are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version
or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID
qualifier (for example, account-id:Thumbnail
). Note that the length constraint applies only to the
ARN. If you specify only the function name, it is limited to 64 characters in length.
String qualifier
You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.
String type
String type
String type
String type
String type
String type
String functionName
The Lambda function name. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
InputStream invokeArgs
JSON that you want to provide to your Lambda function as input.
Integer status
It will be 202 upon success.
String functionName
The Lambda function name.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
String invocationType
By default, the Invoke
API assumes RequestResponse
invocation type. You can optionally
request asynchronous execution by specifying Event
as the InvocationType
. You can also
use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the
caller is authorized to invoke the function and if the inputs are valid. You request this by specifying
DryRun
as the InvocationType
. This is useful in a cross-account scenario when you want
to verify access to a function without running it.
String logType
You can set this optional parameter to Tail
in the request only if you specify the
InvocationType
parameter with value RequestResponse
. In this case, AWS Lambda returns
the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result
header.
String clientContext
Using the ClientContext
you can pass client-specific information to the Lambda function you are
invoking. You can then process the client information in your Lambda function as you choose through the context
variable. For an example of a ClientContext
JSON, see PutEvents in the Amazon Mobile
Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.
ByteBuffer payload
JSON that you want to provide to your Lambda function as input.
String qualifier
You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.
If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of
the $LATEST
version.
Integer statusCode
The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be
202. For the DryRun
invocation type the status code will be 204.
String functionError
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will
have one of two values; Handled
or Unhandled
. Handled
errors are errors
that are reported by the function while the Unhandled
errors are those detected and reported by AWS
Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report
an Handled
error, see Programming Model.
String logResult
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is
RequestResponse
and the logs were requested.
ByteBuffer payload
It is the JSON representation of the object returned by the Lambda function. This is present only if the
invocation type is RequestResponse
.
In the event of a function error this field contains a message describing the error. For the Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the
message.
String executedVersion
The function version that has been executed. This value is returned only if the invocation type is
RequestResponse
. For more information, see lambda-traffic-shifting-using-aliases.
String type
String type
String type
String type
String functionName
Lambda function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionVersion
If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.
String marker
Optional string. An opaque pagination token returned from a previous ListAliases
operation. If
present, indicates where to continue the listing.
Integer maxItems
Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
String nextMarker
A string, present if there are more aliases.
SdkInternalList<T> aliases
A list of aliases.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream, or an SQS queue. (This parameter is optional.)
String functionName
The name of the Lambda function.
You can specify the function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). If you
are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version
or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID
qualifier (for example, account-id:Thumbnail
). Note that the length constraint applies only to the
ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Optional string. An opaque pagination token returned from a previous ListEventSourceMappings
operation. If present, specifies to continue the list from where the returning call left off.
Integer maxItems
Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
String nextMarker
A string, present if there are more event source mappings.
SdkInternalList<T> eventSourceMappings
An array of EventSourceMappingConfiguration
objects.
String masterRegion
Optional string. If not specified, will return only regular function versions (i.e., non-replicated versions).
Valid values are:
The region from which the functions are replicated. For example, if you specify us-east-1
, only
functions replicated from that region will be returned.
ALL
: Will return all functions from any region. If specified, you also must specify a valid
FunctionVersion parameter.
String functionVersion
Optional string. If not specified, only the unqualified functions ARNs (Amazon Resource Names) will be returned.
Valid value:
ALL
: Will return all versions, including $LATEST
which will have fully qualified ARNs
(Amazon Resource Names).
String marker
Optional string. An opaque pagination token returned from a previous ListFunctions
operation. If
present, indicates where to continue the listing.
Integer maxItems
Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
String nextMarker
A string, present if there are more functions.
SdkInternalList<T> functions
A list of Lambda functions.
String resource
The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
SdkInternalMap<K,V> tags
The list of tags assigned to the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
String functionName
Function name whose versions to list. You can specify a function name (for example, Thumbnail
) or
you can specify Amazon Resource Name (ARN) of the function (for example,
arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify a
partial ARN (for example, account-id:Thumbnail
). Note that the length constraint applies only to the
ARN. If you specify only the function name, it is limited to 64 characters in length.
String marker
Optional string. An opaque pagination token returned from a previous ListVersionsByFunction
operation. If present, indicates where to continue the listing.
Integer maxItems
Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
String nextMarker
A string, present if there are more function versions.
SdkInternalList<T> versions
A list of Lambda function versions.
String type
String type
String functionName
The Lambda function name. You can specify a function name (for example, Thumbnail
) or you can
specify Amazon Resource Name (ARN) of the function (for example,
arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify a
partial ARN (for example, account-id:Thumbnail
). Note that the length constraint applies only to the
ARN. If you specify only the function name, it is limited to 64 characters in length.
String codeSha256
The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.
String description
The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
String functionName
The name of the function you are setting concurrent execution limits on. For more information, see concurrent-executions.
Integer reservedConcurrentExecutions
The concurrent execution limit reserved for this function. For more information, see concurrent-executions.
Integer reservedConcurrentExecutions
The number of concurrent executions reserved for this function. For more information, see concurrent-executions.
String functionName
Lambda function whose resource policy you want to remove a permission from.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the 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
You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String type
String type
String type
String type
String type
String type
String resource
The ARN (Amazon Resource Name) of the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
SdkInternalMap<K,V> tags
The list of tags (key-value pairs) you are assigning to the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
String mode
Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.
String mode
The tracing mode associated with your Lambda function.
String type
String resource
The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
SdkInternalList<T> tagKeys
The list of tag keys to be deleted from the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
String functionName
The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String name
The alias name.
String functionVersion
Using this parameter you can change the Lambda function version to which the alias points.
String description
You can change the description of the alias using this parameter.
AliasRoutingConfiguration routingConfig
Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String aliasArn
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias
called BETA
that points to a helloworld function version, the ARN is
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
String name
Alias name.
String functionVersion
Function version to which the alias points.
String description
Alias description.
AliasRoutingConfiguration routingConfig
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
String revisionId
Represents the latest updated revision of the function or alias.
String uUID
The event source mapping identifier.
String functionName
The Lambda function to which you want the stream records sent.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Boolean enabled
Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.
Integer batchSize
The maximum number of stream records that can be sent to your Lambda function for a single invocation.
String uUID
The AWS Lambda assigned opaque identifier for the mapping.
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.
Date lastModified
The UTC time string indicating the last time the event mapping was updated.
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.
String state
The state of the event source mapping. It can be Creating
, Enabled
,
Disabled
, Enabling
, Disabling
, Updating
, or
Deleting
.
String stateTransitionReason
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
String functionName
The existing Lambda function name whose code you want to replace.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters
in length.
ByteBuffer zipFile
The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.
String s3Bucket
Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.
String s3Key
The Amazon S3 object (the deployment package) key name you want to upload.
String s3ObjectVersion
The Amazon S3 object (the deployment package) version you want to upload.
Boolean publish
This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
Boolean dryRun
This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a
version as an atomic operation. It will do all necessary computation and validation of your code but will not
upload it or a publish a version. Each time this operation is invoked, the CodeSha256
hash value of
the provided code will also be computed and returned in the response.
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
String functionName
The name of the Lambda function.
You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name
(ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS
Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the
length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character
in length.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
String handler
The function that Lambda calls to begin executing your function. For Node.js, it is the
module-name.export
value in your function.
String description
A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
Integer timeout
The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
VpcConfig vpcConfig
Environment environment
The parent object that contains your environment's configuration settings.
String runtime
The runtime environment for the Lambda function.
To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use the .NET Core runtime v1.0, set the value to "dotnetcore1.0". To use the .NET Core runtime v2.0, set the value to "dotnetcore2.0".
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.
TracingConfig tracingConfig
The parent object that contains your function's tracing settings.
String revisionId
An optional value you can use to ensure you are updating the latest update of the function version or alias. If
the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias,
it will fail with an error message, advising you to retrieve the latest function version or alias
RevisionID
using either or .
String functionName
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
String runtime
The runtime environment for the Lambda function.
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
String handler
The function Lambda calls to begin executing your function.
Long codeSize
The size, in bytes, of the function .zip file you uploaded.
String description
The user-provided description.
Integer timeout
The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
Integer memorySize
The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
String lastModified
The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.
String codeSha256
It is the SHA256 hash of your function deployment package.
String version
The version of the Lambda function.
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.
DeadLetterConfig deadLetterConfig
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.
EnvironmentResponse environment
The parent object that contains your environment's configuration settings.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.
TracingConfigResponse tracingConfig
The parent object that contains your function's tracing settings.
String masterArn
Returns the ARN (Amazon Resource Name) of the master function.
String revisionId
Represents the latest updated revision of the function or alias.
SdkInternalList<T> subnetIds
A list of one or more subnet IDs in your VPC.
SdkInternalList<T> securityGroupIds
A list of one or more security groups IDs in your VPC.
SdkInternalList<T> subnetIds
A list of subnet IDs associated with the Lambda function.
SdkInternalList<T> securityGroupIds
A list of security group IDs associated with the Lambda function.
String vpcId
The VPC ID associated with you Lambda function.
Copyright © 2018. All rights reserved.