AWSSDK.Lambda
AWS Lambda
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
This document is generated from apis/lambda-2015-03-31.normal.json. See JuliaCloud/AWSCore.jl.
AWSSDK.Lambda.add_permission
AWSSDK.Lambda.create_alias
AWSSDK.Lambda.create_event_source_mapping
AWSSDK.Lambda.create_function
AWSSDK.Lambda.delete_alias
AWSSDK.Lambda.delete_event_source_mapping
AWSSDK.Lambda.delete_function
AWSSDK.Lambda.get_account_settings
AWSSDK.Lambda.get_alias
AWSSDK.Lambda.get_event_source_mapping
AWSSDK.Lambda.get_function
AWSSDK.Lambda.get_function_configuration
AWSSDK.Lambda.get_policy
AWSSDK.Lambda.invoke
AWSSDK.Lambda.invoke_async
AWSSDK.Lambda.list_aliases
AWSSDK.Lambda.list_event_source_mappings
AWSSDK.Lambda.list_functions
AWSSDK.Lambda.list_tags
AWSSDK.Lambda.list_versions_by_function
AWSSDK.Lambda.publish_version
AWSSDK.Lambda.remove_permission
AWSSDK.Lambda.tag_resource
AWSSDK.Lambda.untag_resource
AWSSDK.Lambda.update_alias
AWSSDK.Lambda.update_event_source_mapping
AWSSDK.Lambda.update_function_code
AWSSDK.Lambda.update_function_configuration
AWSSDK.Lambda.add_permission
— Function.using AWSSDK.Lambda.add_permission
add_permission([::AWSConfig], arguments::Dict)
add_permission([::AWSConfig]; FunctionName=, StatementId=, Action=, Principal=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/policy", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/policy", FunctionName=, StatementId=, Action=, Principal=, <keyword arguments>)
AddPermission Operation
Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.
For information about the push model, see AWS Lambda: How it Works.
If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission
request via the Qualifier
parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission
action.
Arguments
FunctionName = ::String
– Required
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.
StatementId = ::String
– Required
A unique statement identifier.
Action = ::String
– Required
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.
Principal = ::String
– Required
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.
SourceArn = ::String
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.
Important
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.
SourceAccount = ::String
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.
EventSourceToken = ::String
A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
Qualifier = ::String
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
Returns
AddPermissionResponse
Exceptions
ServiceException
, ResourceNotFoundException
, ResourceConflictException
, InvalidParameterValueException
, PolicyLengthExceededException
or TooManyRequestsException
.
Example: add-permission
This example adds a permission for an S3 bucket to invoke a Lambda function.
Input:
[
"Action" => "lambda:InvokeFunction",
"FunctionName" => "MyFunction",
"Principal" => "s3.amazonaws.com",
"SourceAccount" => "123456789012",
"SourceArn" => "arn:aws:s3:::examplebucket/*",
"StatementId" => "ID-1"
]
Output:
Dict(
"Statement" => "ID-1"
)
See also: AWS API Documentation
AWSSDK.Lambda.create_alias
— Function.using AWSSDK.Lambda.create_alias
create_alias([::AWSConfig], arguments::Dict)
create_alias([::AWSConfig]; FunctionName=, Name=, FunctionVersion=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/aliases", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/aliases", FunctionName=, Name=, FunctionVersion=, <keyword arguments>)
CreateAlias Operation
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
Arguments
FunctionName = ::String
– Required
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.
Name = ::String
– Required
Name for the alias you are creating.
FunctionVersion = ::String
– Required
Lambda function version for which you are creating the alias.
Description = ::String
Description of the alias.
Returns
AliasConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, ResourceConflictException
, InvalidParameterValueException
or TooManyRequestsException
.
See also: AWS API Documentation
AWSSDK.Lambda.create_event_source_mapping
— Function.using AWSSDK.Lambda.create_event_source_mapping
create_event_source_mapping([::AWSConfig], arguments::Dict)
create_event_source_mapping([::AWSConfig]; EventSourceArn=, FunctionName=, StartingPosition=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/event-source-mappings/", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/event-source-mappings/", EventSourceArn=, FunctionName=, StartingPosition=, <keyword arguments>)
CreateEventSourceMapping Operation
Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This association between a stream source and a Lambda function is called the event source mapping.
Important
This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.
Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateEventSourceMapping
action.
Arguments
EventSourceArn = ::String
– Required
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
FunctionName = ::String
– Required
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.
Enabled = ::Bool
Indicates whether AWS Lambda should begin polling the event source. By default, Enabled
is true.
BatchSize = ::Int
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 is 100 records.
StartingPosition = "TRIM_HORIZON", "LATEST" or "AT_TIMESTAMP"
– Required
The position in the stream where AWS Lambda should start reading. Valid only for Kinesis streams. For more information, see ShardIteratorType in the Amazon Kinesis API Reference.
StartingPositionTimestamp = timestamp
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.
Returns
EventSourceMappingConfiguration
Exceptions
ServiceException
, InvalidParameterValueException
, ResourceConflictException
, TooManyRequestsException
or ResourceNotFoundException
.
See also: AWS API Documentation
AWSSDK.Lambda.create_function
— Function.using AWSSDK.Lambda.create_function
create_function([::AWSConfig], arguments::Dict)
create_function([::AWSConfig]; FunctionName=, Runtime=, Role=, Handler=, Code=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/functions", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/functions", FunctionName=, Runtime=, Role=, Handler=, Code=, <keyword arguments>)
CreateFunction Operation
Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.
If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish
parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateFunction
action.
Arguments
FunctionName = ::String
– Required
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.
Runtime = "nodejs", "nodejs4.3", "nodejs6.10", "java8", "python2.7", "python3.6", "dotnetcore1.0" or "nodejs4.3-edge"
– Required
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".
Note
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. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parmaeter 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.
Role = ::String
– Required
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.
Handler = ::String
– Required
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).
Code = [ ... ]
– Required
The code for the Lambda function.
Code = [
"ZipFile" => blob,
"S3Bucket" => ::String,
"S3Key" => ::String,
"S3ObjectVersion" => ::String
]
Description = ::String
A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
Timeout = ::Int
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.
MemorySize = ::Int
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.
Publish = ::Bool
This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
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.
VpcConfig = [
"SubnetIds" => [::String, ...],
"SecurityGroupIds" => [::String, ...]
]
DeadLetterConfig = ["TargetArn" => ::String]
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
Environment = ["Variables" => ::Dict{String,String}]
KMSKeyArn = ::String
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 = ["Mode" => "Active" or "PassThrough"]
The parent object that contains your function's tracing settings.
Tags = ::Dict{String,String}
The list of tags (key-value pairs) assigned to the new function.
Returns
FunctionConfiguration
Exceptions
ServiceException
, InvalidParameterValueException
, ResourceNotFoundException
, ResourceConflictException
, TooManyRequestsException
or CodeStorageExceededException
.
Example: create-function
This example creates a Lambda function.
Input:
[
"Code" => [
],
"Description" => "",
"FunctionName" => "MyFunction",
"Handler" => "souce_file.handler_name",
"MemorySize" => 128,
"Publish" => true,
"Role" => "arn:aws:iam::123456789012:role/service-role/role-name",
"Runtime" => "nodejs4.3",
"Timeout" => 15,
"VpcConfig" => [
]
]
Output:
Dict(
"CodeSha256" => "",
"CodeSize" => 123,
"Description" => "",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:MyFunction",
"FunctionName" => "MyFunction",
"Handler" => "source_file.handler_name",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/service-role/role-name",
"Runtime" => "nodejs4.3",
"Timeout" => 123,
"Version" => "1",
"VpcConfig" => Dict(
)
)
See also: AWS API Documentation
AWSSDK.Lambda.delete_alias
— Function.using AWSSDK.Lambda.delete_alias
delete_alias([::AWSConfig], arguments::Dict)
delete_alias([::AWSConfig]; FunctionName=, Name=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", arguments::Dict)
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", FunctionName=, Name=)
DeleteAlias Operation
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
Arguments
FunctionName = ::String
– Required
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.
Name = ::String
– Required
Name of the alias to delete.
Exceptions
ServiceException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To delete a Lambda function alias
This operation deletes a Lambda function alias
Input:
[
"FunctionName" => "myFunction",
"Name" => "alias"
]
See also: AWS API Documentation
AWSSDK.Lambda.delete_event_source_mapping
— Function.using AWSSDK.Lambda.delete_event_source_mapping
delete_event_source_mapping([::AWSConfig], arguments::Dict)
delete_event_source_mapping([::AWSConfig]; UUID=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "DELETE", "/2015-03-31/event-source-mappings/{UUID}", arguments::Dict)
lambda([::AWSConfig], "DELETE", "/2015-03-31/event-source-mappings/{UUID}", UUID=)
DeleteEventSourceMapping Operation
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:DeleteEventSourceMapping
action.
Arguments
UUID = ::String
– Required
The event source mapping ID.
Returns
EventSourceMappingConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To delete a Lambda function event source mapping
This operation deletes a Lambda function event source mapping
Input:
[
"UUID" => "12345kxodurf3443"
]
Output:
Dict(
"BatchSize" => 123,
"EventSourceArn" => "arn:aws:s3:::examplebucket/*",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"LastProcessingResult" => "",
"State" => "",
"StateTransitionReason" => "",
"UUID" => "12345kxodurf3443"
)
See also: AWS API Documentation
AWSSDK.Lambda.delete_function
— Function.using AWSSDK.Lambda.delete_function
delete_function([::AWSConfig], arguments::Dict)
delete_function([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}", arguments::Dict)
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}", FunctionName=, <keyword arguments>)
DeleteFunction Operation
Deletes the specified Lambda function code and configuration.
If you are using the versioning feature and you don't specify a function version in your DeleteFunction
request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier
parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases.
When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.
This operation requires permission for the lambda:DeleteFunction
action.
Arguments
FunctionName = ::String
– Required
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.
Qualifier = ::String
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.
Exceptions
ServiceException
, ResourceNotFoundException
, TooManyRequestsException
, InvalidParameterValueException
or ResourceConflictException
.
Example: To delete a Lambda function
This operation deletes a Lambda function
Input:
[
"FunctionName" => "myFunction",
"Qualifier" => "1"
]
See also: AWS API Documentation
AWSSDK.Lambda.get_account_settings
— Function.using AWSSDK.Lambda.get_account_settings
get_account_settings([::AWSConfig], arguments::Dict)
get_account_settings([::AWSConfig]; )
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2016-08-19/account-settings/", arguments::Dict)
lambda([::AWSConfig], "GET", "/2016-08-19/account-settings/", )
GetAccountSettings Operation
Returns a customer's account settings.
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.
Arguments
Returns
GetAccountSettingsResponse
Exceptions
TooManyRequestsException
or ServiceException
.
Example: To retrieves a Lambda customer's account settings
This operation retrieves a Lambda customer's account settings
Input:
[
]
Output:
Dict(
"AccountLimit" => Dict(
),
"AccountUsage" => Dict(
)
)
See also: AWS API Documentation
AWSSDK.Lambda.get_alias
— Function.using AWSSDK.Lambda.get_alias
get_alias([::AWSConfig], arguments::Dict)
get_alias([::AWSConfig]; FunctionName=, Name=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", FunctionName=, Name=)
GetAlias Operation
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias
action.
Arguments
FunctionName = ::String
– Required
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.
Name = ::String
– Required
Name of the alias for which you want to retrieve information.
Returns
AliasConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To retrieve a Lambda function alias
This operation retrieves a Lambda function alias
Input:
[
"FunctionName" => "myFunction",
"Name" => "myFunctionAlias"
]
Output:
Dict(
"AliasArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias",
"Description" => "",
"FunctionVersion" => "1",
"Name" => "myFunctionAlias"
)
See also: AWS API Documentation
AWSSDK.Lambda.get_event_source_mapping
— Function.using AWSSDK.Lambda.get_event_source_mapping
get_event_source_mapping([::AWSConfig], arguments::Dict)
get_event_source_mapping([::AWSConfig]; UUID=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/event-source-mappings/{UUID}", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/event-source-mappings/{UUID}", UUID=)
GetEventSourceMapping Operation
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping
action.
Arguments
UUID = ::String
– Required
The AWS Lambda assigned ID of the event source mapping.
Returns
EventSourceMappingConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To retrieve a Lambda function's event source mapping
This operation retrieves a Lambda function's event source mapping
Input:
[
"UUID" => "123489-xxxxx-kdla8d89d7"
]
Output:
Dict(
"BatchSize" => 123,
"EventSourceArn" => "arn:aws:iam::123456789012:eventsource",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"LastProcessingResult" => "",
"State" => "",
"StateTransitionReason" => "",
"UUID" => "123489-xxxxx-kdla8d89d7"
)
See also: AWS API Documentation
AWSSDK.Lambda.get_function
— Function.using AWSSDK.Lambda.get_function
get_function([::AWSConfig], arguments::Dict)
get_function([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}", FunctionName=, <keyword arguments>)
GetFunction Operation
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Using the optional Qualifier
parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST
version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunction
action.
Arguments
FunctionName = ::String
– Required
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.
Qualifier = ::String
Using 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.
Returns
GetFunctionResponse
Exceptions
ServiceException
, ResourceNotFoundException
, TooManyRequestsException
or InvalidParameterValueException
.
Example: To retrieve a Lambda function's event source mapping
This operation retrieves a Lambda function's event source mapping
Input:
[
"FunctionName" => "myFunction",
"Qualifier" => "1"
]
Output:
Dict(
"Code" => Dict(
"Location" => "somelocation",
"RepositoryType" => "S3"
),
"Configuration" => Dict(
"CodeSha256" => "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
"CodeSize" => 262,
"Description" => "A starter AWS Lambda function.",
"Environment" => Dict(
"Variables" => Dict(
"S3_BUCKET" => "test"
)
),
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "nodejs4.3",
"Timeout" => 3,
"Version" => "$LATEST",
"VpcConfig" => Dict(
"SecurityGroupIds" => [
],
"SubnetIds" => [
]
)
)
)
See also: AWS API Documentation
AWSSDK.Lambda.get_function_configuration
— Function.using AWSSDK.Lambda.get_function_configuration
get_function_configuration([::AWSConfig], arguments::Dict)
get_function_configuration([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/configuration", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/configuration", FunctionName=, <keyword arguments>)
GetFunctionConfiguration Operation
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier
parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration
operation.
Arguments
FunctionName = ::String
– Required
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.
Qualifier = ::String
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.
Returns
FunctionConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, TooManyRequestsException
or InvalidParameterValueException
.
Example: To retrieve a Lambda function's event source mapping
This operation retrieves a Lambda function's event source mapping
Input:
[
"FunctionName" => "myFunction",
"Qualifier" => "1"
]
Output:
Dict(
"CodeSha256" => "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
"CodeSize" => 123,
"DeadLetterConfig" => Dict(
),
"Description" => "",
"Environment" => Dict(
),
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"KMSKeyArn" => "",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "python2.7",
"Timeout" => 123,
"Version" => "1",
"VpcConfig" => Dict(
)
)
See also: AWS API Documentation
AWSSDK.Lambda.get_policy
— Function.using AWSSDK.Lambda.get_policy
get_policy([::AWSConfig], arguments::Dict)
get_policy([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/policy", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/policy", FunctionName=, <keyword arguments>)
GetPolicy Operation
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier
parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
You need permission for the lambda:GetPolicy action.
Arguments
FunctionName = ::String
– Required
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.
Qualifier = ::String
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.
Returns
GetPolicyResponse
Exceptions
ServiceException
, ResourceNotFoundException
, TooManyRequestsException
or InvalidParameterValueException
.
Example: To retrieve a Lambda function policy
This operation retrieves a Lambda function policy
Input:
[
"FunctionName" => "myFunction",
"Qualifier" => "1"
]
Output:
Dict(
"Policy" => ""
)
See also: AWS API Documentation
AWSSDK.Lambda.invoke
— Function.using AWSSDK.Lambda.invoke
invoke([::AWSConfig], arguments::Dict)
invoke([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/invocations", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/invocations", FunctionName=, <keyword arguments>)
Invoke Operation
Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually.
If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier
parameter in the request. If you don't provide the Qualifier
parameter, the $LATEST
version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:InvokeFunction
action.
Arguments
FunctionName = ::String
– Required
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.
X-Amz-Invocation-Type = "Event", "RequestResponse" or "DryRun"
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.
X-Amz-Log-Type = "None" or "Tail"
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.
X-Amz-Client-Context = ::String
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.
Payload = blob
JSON that you want to provide to your Lambda function as input.
Qualifier = ::String
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.
Returns
InvocationResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidRequestContentException
, RequestTooLargeException
, UnsupportedMediaTypeException
, TooManyRequestsException
, InvalidParameterValueException
, EC2UnexpectedException
, SubnetIPAddressLimitReachedException
, ENILimitReachedException
, EC2ThrottledException
, EC2AccessDeniedException
, InvalidSubnetIDException
, InvalidSecurityGroupIDException
, InvalidZipFileException
, KMSDisabledException
, KMSInvalidStateException
, KMSAccessDeniedException
, KMSNotFoundException
or InvalidRuntimeException
.
Example: To invoke a Lambda function
This operation invokes a Lambda function
Input:
[
"ClientContext" => "MyApp",
"FunctionName" => "MyFunction",
"InvocationType" => "Event",
"LogType" => "Tail",
"Payload" => "fileb://file-path/input.json",
"Qualifier" => "1"
]
Output:
Dict(
"FunctionError" => "",
"LogResult" => "",
"Payload" => "?",
"StatusCode" => 123
)
See also: AWS API Documentation
AWSSDK.Lambda.invoke_async
— Function.using AWSSDK.Lambda.invoke_async
invoke_async([::AWSConfig], arguments::Dict)
invoke_async([::AWSConfig]; FunctionName=, InvokeArgs=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2014-11-13/functions/{FunctionName}/invoke-async/", arguments::Dict)
lambda([::AWSConfig], "POST", "/2014-11-13/functions/{FunctionName}/invoke-async/", FunctionName=, InvokeArgs=)
InvokeAsync Operation
Important
This API is deprecated. We recommend you use
Invoke
API (see Invoke).
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction
action.
Arguments
FunctionName = ::String
– Required
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.
InvokeArgs = blob
– Required
JSON that you want to provide to your Lambda function as input.
Returns
InvokeAsyncResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidRequestContentException
or InvalidRuntimeException
.
Example: To invoke a Lambda function asynchronously
This operation invokes a Lambda function asynchronously
Input:
[
"FunctionName" => "myFunction",
"InvokeArgs" => "fileb://file-path/input.json"
]
Output:
Dict(
"Status" => 123
)
See also: AWS API Documentation
AWSSDK.Lambda.list_aliases
— Function.using AWSSDK.Lambda.list_aliases
list_aliases([::AWSConfig], arguments::Dict)
list_aliases([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/aliases", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/aliases", FunctionName=, <keyword arguments>)
ListAliases Operation
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
Arguments
FunctionName = ::String
– Required
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.
FunctionVersion = ::String
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.
Marker = ::String
Optional string. An opaque pagination token returned from a previous ListAliases
operation. If present, indicates where to continue the listing.
MaxItems = ::Int
Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
Returns
ListAliasesResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To retrieve a Lambda function aliases
This operation retrieves a Lambda function's aliases
Input:
[
"FunctionName" => "myFunction",
"FunctionVersion" => "1",
"Marker" => "",
"MaxItems" => 123
]
Output:
Dict(
"Aliases" => [
],
"NextMarker" => ""
)
See also: AWS API Documentation
AWSSDK.Lambda.list_event_source_mappings
— Function.using AWSSDK.Lambda.list_event_source_mappings
list_event_source_mappings([::AWSConfig], arguments::Dict)
list_event_source_mappings([::AWSConfig]; <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/event-source-mappings/", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/event-source-mappings/", <keyword arguments>)
ListEventSourceMappings Operation
Returns a list of event source mappings you created using the CreateEventSourceMapping
(see CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName
parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:ListEventSourceMappings
action.
Arguments
EventSourceArn = ::String
The Amazon Resource Name (ARN) of the Amazon Kinesis stream. (This parameter is optional.)
FunctionName = ::String
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.
Marker = ::String
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.
MaxItems = ::Int
Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
Returns
ListEventSourceMappingsResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
See also: AWS API Documentation
AWSSDK.Lambda.list_functions
— Function.using AWSSDK.Lambda.list_functions
list_functions([::AWSConfig], arguments::Dict)
list_functions([::AWSConfig]; <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/", <keyword arguments>)
ListFunctions Operation
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions
action.
If you are using the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
Arguments
MasterRegion = ::String
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.
FunctionVersion = "ALL"
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).
Marker = ::String
Optional string. An opaque pagination token returned from a previous ListFunctions
operation. If present, indicates where to continue the listing.
MaxItems = ::Int
Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
Returns
ListFunctionsResponse
Exceptions
ServiceException
, TooManyRequestsException
or InvalidParameterValueException
.
Example: To retrieve a list of Lambda functions
This operation retrieves a Lambda functions
Input:
[
"Marker" => "",
"MaxItems" => 123
]
Output:
Dict(
"Functions" => [
],
"NextMarker" => ""
)
See also: AWS API Documentation
AWSSDK.Lambda.list_tags
— Function.using AWSSDK.Lambda.list_tags
list_tags([::AWSConfig], arguments::Dict)
list_tags([::AWSConfig]; ARN=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2017-03-31/tags/{ARN}", arguments::Dict)
lambda([::AWSConfig], "GET", "/2017-03-31/tags/{ARN}", ARN=)
ListTags Operation
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
Arguments
ARN = ::String
– Required
The ARN (Amazon Resource Name) of the function.
Returns
ListTagsResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
See also: AWS API Documentation
AWSSDK.Lambda.list_versions_by_function
— Function.using AWSSDK.Lambda.list_versions_by_function
list_versions_by_function([::AWSConfig], arguments::Dict)
list_versions_by_function([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/versions", arguments::Dict)
lambda([::AWSConfig], "GET", "/2015-03-31/functions/{FunctionName}/versions", FunctionName=, <keyword arguments>)
ListVersionsByFunction Operation
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
Arguments
FunctionName = ::String
– Required
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.
Marker = ::String
Optional string. An opaque pagination token returned from a previous ListVersionsByFunction
operation. If present, indicates where to continue the listing.
MaxItems = ::Int
Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
Returns
ListVersionsByFunctionResponse
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To retrieve a list of Lambda function versions
This operation retrieves a Lambda function versions
Input:
[
"FunctionName" => "myFunction",
"Marker" => "",
"MaxItems" => 123
]
Output:
Dict(
"NextMarker" => "",
"Versions" => [
]
)
See also: AWS API Documentation
AWSSDK.Lambda.publish_version
— Function.using AWSSDK.Lambda.publish_version
publish_version([::AWSConfig], arguments::Dict)
publish_version([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/versions", arguments::Dict)
lambda([::AWSConfig], "POST", "/2015-03-31/functions/{FunctionName}/versions", FunctionName=, <keyword arguments>)
PublishVersion Operation
Publishes a version of your function from the current snapshot of LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
Arguments
FunctionName = ::String
– Required
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.
CodeSha256 = ::String
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 value must match the SHA256 of the LATEST version for the publication to succeed.
Description = ::String
The description for the version you are publishing. If not provided, AWS Lambda copies the description from the LATEST version.
Returns
FunctionConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
, TooManyRequestsException
or CodeStorageExceededException
.
Example: To publish a version of a Lambda function
This operation publishes a version of a Lambda function
Input:
[
"CodeSha256" => "",
"Description" => "",
"FunctionName" => "myFunction"
]
Output:
Dict(
"CodeSha256" => "",
"CodeSize" => 123,
"Description" => "",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "python2.7",
"Timeout" => 123,
"Version" => "1",
"VpcConfig" => Dict(
)
)
See also: AWS API Documentation
AWSSDK.Lambda.remove_permission
— Function.using AWSSDK.Lambda.remove_permission
remove_permission([::AWSConfig], arguments::Dict)
remove_permission([::AWSConfig]; FunctionName=, StatementId=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", arguments::Dict)
lambda([::AWSConfig], "DELETE", "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", FunctionName=, StatementId=, <keyword arguments>)
RemovePermission Operation
You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission
request via the Qualifier
parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
Note that removal of a permission will cause an active event source to lose permission to the function.
You need permission for the lambda:RemovePermission
action.
Arguments
FunctionName = ::String
– Required
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.
StatementId = ::String
– Required
Statement ID of the permission to remove.
Qualifier = ::String
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.
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To remove a Lambda function's permissions
This operation removes a Lambda function's permissions
Input:
[
"FunctionName" => "myFunction",
"Qualifier" => "1",
"StatementId" => "role-statement-id"
]
See also: AWS API Documentation
AWSSDK.Lambda.tag_resource
— Function.using AWSSDK.Lambda.tag_resource
tag_resource([::AWSConfig], arguments::Dict)
tag_resource([::AWSConfig]; ARN=, Tags=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "POST", "/2017-03-31/tags/{ARN}", arguments::Dict)
lambda([::AWSConfig], "POST", "/2017-03-31/tags/{ARN}", ARN=, Tags=)
TagResource Operation
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null.
Arguments
ARN = ::String
– Required
The ARN (Amazon Resource Name) of the Lambda function.
Tags = ::Dict{String,String}
– Required
The list of tags (key-value pairs) you are assigning to the Lambda function.
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
See also: AWS API Documentation
AWSSDK.Lambda.untag_resource
— Function.using AWSSDK.Lambda.untag_resource
untag_resource([::AWSConfig], arguments::Dict)
untag_resource([::AWSConfig]; ARN=, tagKeys=)
using AWSCore.Services.lambda
lambda([::AWSConfig], "DELETE", "/2017-03-31/tags/{ARN}", arguments::Dict)
lambda([::AWSConfig], "DELETE", "/2017-03-31/tags/{ARN}", ARN=, tagKeys=)
UntagResource Operation
Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name).
Arguments
ARN = ::String
– Required
The ARN (Amazon Resource Name) of the function.
tagKeys = [::String, ...]
– Required
The list of tag keys to be deleted from the function.
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
See also: AWS API Documentation
AWSSDK.Lambda.update_alias
— Function.using AWSSDK.Lambda.update_alias
update_alias([::AWSConfig], arguments::Dict)
update_alias([::AWSConfig]; FunctionName=, Name=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", arguments::Dict)
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/aliases/{Name}", FunctionName=, Name=, <keyword arguments>)
UpdateAlias Operation
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
Arguments
FunctionName = ::String
– Required
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.
Name = ::String
– Required
The alias name.
FunctionVersion = ::String
Using this parameter you can change the Lambda function version to which the alias points.
Description = ::String
You can change the description of the alias using this parameter.
Returns
AliasConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
or TooManyRequestsException
.
Example: To update a Lambda function alias
This operation updates a Lambda function alias
Input:
[
"Description" => "",
"FunctionName" => "myFunction",
"FunctionVersion" => "1",
"Name" => "functionAlias"
]
Output:
Dict(
"AliasArn" => "arn:aws:lambda:us-west-2:123456789012:function:functionAlias",
"Description" => "",
"FunctionVersion" => "1",
"Name" => "functionAlias"
)
See also: AWS API Documentation
AWSSDK.Lambda.update_event_source_mapping
— Function.using AWSSDK.Lambda.update_event_source_mapping
update_event_source_mapping([::AWSConfig], arguments::Dict)
update_event_source_mapping([::AWSConfig]; UUID=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "PUT", "/2015-03-31/event-source-mappings/{UUID}", arguments::Dict)
lambda([::AWSConfig], "PUT", "/2015-03-31/event-source-mappings/{UUID}", UUID=, <keyword arguments>)
UpdateEventSourceMapping Operation
You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.
If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName
parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.
This operation requires permission for the lambda:UpdateEventSourceMapping
action.
Arguments
UUID = ::String
– Required
The event source mapping identifier.
FunctionName = ::String
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.
Enabled = ::Bool
Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.
BatchSize = ::Int
The maximum number of stream records that can be sent to your Lambda function for a single invocation.
Returns
EventSourceMappingConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
, TooManyRequestsException
or ResourceConflictException
.
Example: To update a Lambda function event source mapping
This operation updates a Lambda function event source mapping
Input:
[
"BatchSize" => 123,
"Enabled" => true,
"FunctionName" => "myFunction",
"UUID" => "1234xCy789012"
]
Output:
Dict(
"BatchSize" => 123,
"EventSourceArn" => "arn:aws:s3:::examplebucket/*",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"LastProcessingResult" => "",
"State" => "",
"StateTransitionReason" => "",
"UUID" => "1234xCy789012"
)
See also: AWS API Documentation
AWSSDK.Lambda.update_function_code
— Function.using AWSSDK.Lambda.update_function_code
update_function_code([::AWSConfig], arguments::Dict)
update_function_code([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/code", arguments::Dict)
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/code", FunctionName=, <keyword arguments>)
UpdateFunctionCode Operation
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode
action.
Arguments
FunctionName = ::String
– Required
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.
ZipFile = blob
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.
S3Bucket = ::String
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.
S3Key = ::String
The Amazon S3 object (the deployment package) key name you want to upload.
S3ObjectVersion = ::String
The Amazon S3 object (the deployment package) version you want to upload.
Publish = ::Bool
This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
DryRun = ::Bool
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 the provided code will also be computed and returned in the response.
Returns
FunctionConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
, TooManyRequestsException
or CodeStorageExceededException
.
Example: To update a Lambda function's code
This operation updates a Lambda function's code
Input:
[
"FunctionName" => "myFunction",
"Publish" => true,
"S3Bucket" => "myBucket",
"S3Key" => "myKey",
"S3ObjectVersion" => "1",
"ZipFile" => "fileb://file-path/file.zip"
]
Output:
Dict(
"CodeSha256" => "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
"CodeSize" => 123,
"Description" => "",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "python2.7",
"Timeout" => 123,
"Version" => "1",
"VpcConfig" => Dict(
)
)
See also: AWS API Documentation
AWSSDK.Lambda.update_function_configuration
— Function.using AWSSDK.Lambda.update_function_configuration
update_function_configuration([::AWSConfig], arguments::Dict)
update_function_configuration([::AWSConfig]; FunctionName=, <keyword arguments>)
using AWSCore.Services.lambda
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/configuration", arguments::Dict)
lambda([::AWSConfig], "PUT", "/2015-03-31/functions/{FunctionName}/configuration", FunctionName=, <keyword arguments>)
UpdateFunctionConfiguration Operation
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration
action.
Arguments
FunctionName = ::String
– Required
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.
Role = ::String
The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
Handler = ::String
The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export
value in your function.
Description = ::String
A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
Timeout = ::Int
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.
MemorySize = ::Int
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 = [
"SubnetIds" => [::String, ...],
"SecurityGroupIds" => [::String, ...]
]
Environment = ["Variables" => ::Dict{String,String}]
The parent object that contains your environment's configuration settings.
Runtime = "nodejs", "nodejs4.3", "nodejs6.10", "java8", "python2.7", "python3.6", "dotnetcore1.0" or "nodejs4.3-edge"
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 Python runtime v3.6, set the value to "python3.6".
Note
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. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. 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 = ["TargetArn" => ::String]
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
KMSKeyArn = ::String
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 = ["Mode" => "Active" or "PassThrough"]
The parent object that contains your function's tracing settings.
Returns
FunctionConfiguration
Exceptions
ServiceException
, ResourceNotFoundException
, InvalidParameterValueException
, TooManyRequestsException
or ResourceConflictException
.
Example: To update a Lambda function's configuration
This operation updates a Lambda function's configuration
Input:
[
"Description" => "",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "python2.7",
"Timeout" => 123,
"VpcConfig" => [
]
]
Output:
Dict(
"CodeSha256" => "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
"CodeSize" => 123,
"Description" => "",
"FunctionArn" => "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName" => "myFunction",
"Handler" => "index.handler",
"LastModified" => "2016-11-21T19:49:20.006+0000",
"MemorySize" => 128,
"Role" => "arn:aws:iam::123456789012:role/lambda_basic_execution",
"Runtime" => "python2.7",
"Timeout" => 123,
"Version" => "1",
"VpcConfig" => Dict(
)
)
See also: AWS API Documentation