@datafire/amazonaws_lambda
Client library for AWS Lambda
Installation and Usage
npm install --save @datafire/amazonaws_lambda
let amazonaws_lambda = require('@datafire/amazonaws_lambda').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_lambda.InvokeAsync({
"FunctionName": "",
"InvokeArgs": ""
}).then(data => {
console.log(data);
});
Description
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.
Actions
InvokeAsync
amazonaws_lambda.InvokeAsync({
"FunctionName": "",
"InvokeArgs": ""
}, context)
Input
- input
object
- FunctionName required
string
- InvokeArgs required BlobStream
- FunctionName required
Output
Output schema unknown
ListEventSourceMappings
amazonaws_lambda.ListEventSourceMappings({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- MaxItems
Output
CreateEventSourceMapping
amazonaws_lambda.CreateEventSourceMapping({
"EventSourceArn": "",
"FunctionName": "",
"StartingPosition": ""
}, context)
Input
- input
object
- BatchSize BatchSize
- Enabled Enabled
- EventSourceArn required Arn
- FunctionName required FunctionName
- StartingPosition required EventSourcePosition
- StartingPositionTimestamp Date
Output
Output schema unknown
DeleteEventSourceMapping
amazonaws_lambda.DeleteEventSourceMapping({
"UUID": ""
}, context)
Input
- input
object
- UUID required
string
- UUID required
Output
Output schema unknown
GetEventSourceMapping
amazonaws_lambda.GetEventSourceMapping({
"UUID": ""
}, context)
Input
- input
object
- UUID required
string
- UUID required
Output
UpdateEventSourceMapping
amazonaws_lambda.UpdateEventSourceMapping({
"UUID": ""
}, context)
Input
- input
object
- UUID required
string
- BatchSize BatchSize
- Enabled Enabled
- FunctionName FunctionName
- UUID required
Output
Output schema unknown
CreateFunction
amazonaws_lambda.CreateFunction({
"FunctionName": "",
"Runtime": "",
"Role": "",
"Handler": "",
"Code": {}
}, context)
Input
- input
object
- Code required FunctionCode
- DeadLetterConfig DeadLetterConfig
- Description Description
- Environment Environment
- FunctionName required FunctionName
- Handler required Handler
- KMSKeyArn KMSKeyArn
- MemorySize MemorySize
- Publish Boolean
- Role required RoleArn
- Runtime required Runtime
- Tags Tags
- Timeout Timeout
- TracingConfig TracingConfig
- VpcConfig VpcConfig
Output
Output schema unknown
ListFunctions
amazonaws_lambda.ListFunctions({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- MaxItems
Output
- output ListFunctionsResponse
DeleteFunction
amazonaws_lambda.DeleteFunction({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
Output schema unknown
GetFunction
amazonaws_lambda.GetFunction({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
- output GetFunctionResponse
ListAliases
amazonaws_lambda.ListAliases({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
- output ListAliasesResponse
CreateAlias
amazonaws_lambda.CreateAlias({
"FunctionName": "",
"Name": "",
"FunctionVersion": ""
}, context)
Input
- input
object
- FunctionName required
string
- Description Description
- FunctionVersion required Version
- Name required Alias
- RoutingConfig AliasRoutingConfiguration
- FunctionName required
Output
Output schema unknown
DeleteAlias
amazonaws_lambda.DeleteAlias({
"FunctionName": "",
"Name": ""
}, context)
Input
- input
object
- FunctionName required
string
- Name required
string
- FunctionName required
Output
Output schema unknown
GetAlias
amazonaws_lambda.GetAlias({
"FunctionName": "",
"Name": ""
}, context)
Input
- input
object
- FunctionName required
string
- Name required
string
- FunctionName required
Output
- output AliasConfiguration
UpdateAlias
amazonaws_lambda.UpdateAlias({
"FunctionName": "",
"Name": ""
}, context)
Input
- input
object
- FunctionName required
string
- Name required
string
- Description Description
- FunctionVersion Version
- RevisionId String
- RoutingConfig AliasRoutingConfiguration
- FunctionName required
Output
- output AliasConfiguration
UpdateFunctionCode
amazonaws_lambda.UpdateFunctionCode({
"FunctionName": ""
}, context)
Input
- input
object
Output
- output FunctionConfiguration
GetFunctionConfiguration
amazonaws_lambda.GetFunctionConfiguration({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
- output FunctionConfiguration
UpdateFunctionConfiguration
amazonaws_lambda.UpdateFunctionConfiguration({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- DeadLetterConfig DeadLetterConfig
- Description Description
- Environment Environment
- Handler Handler
- KMSKeyArn KMSKeyArn
- MemorySize MemorySize
- RevisionId String
- Role RoleArn
- Runtime Runtime
- Timeout Timeout
- TracingConfig TracingConfig
- VpcConfig VpcConfig
- FunctionName required
Output
- output FunctionConfiguration
Invoke
amazonaws_lambda.Invoke({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- Payload Blob
- FunctionName required
Output
- output InvocationResponse
GetPolicy
amazonaws_lambda.GetPolicy({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
- output GetPolicyResponse
AddPermission
amazonaws_lambda.AddPermission({
"FunctionName": "",
"StatementId": "",
"Action": "",
"Principal": ""
}, context)
Input
- input
object
- FunctionName required
string
- Action required Action
- EventSourceToken EventSourceToken
- Principal required Principal
- RevisionId String
- SourceAccount SourceOwner
- SourceArn Arn
- StatementId required StatementId
- FunctionName required
Output
Output schema unknown
RemovePermission
amazonaws_lambda.RemovePermission({
"FunctionName": "",
"StatementId": ""
}, context)
Input
- input
object
- FunctionName required
string
- StatementId required
string
- FunctionName required
Output
Output schema unknown
ListVersionsByFunction
amazonaws_lambda.ListVersionsByFunction({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
PublishVersion
amazonaws_lambda.PublishVersion({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- CodeSha256 String
- Description Description
- RevisionId String
- FunctionName required
Output
Output schema unknown
GetAccountSettings
amazonaws_lambda.GetAccountSettings({}, context)
Input
- input
object
Output
- output GetAccountSettingsResponse
UntagResource
amazonaws_lambda.UntagResource({
"ARN": ""
}, context)
Input
- input
object
- ARN required
string
- ARN required
Output
Output schema unknown
ListTags
amazonaws_lambda.ListTags({
"ARN": ""
}, context)
Input
- input
object
- ARN required
string
- ARN required
Output
- output ListTagsResponse
TagResource
amazonaws_lambda.TagResource({
"ARN": "",
"Tags": []
}, context)
Input
- input
object
- ARN required
string
- Tags required Tags
- ARN required
Output
Output schema unknown
DeleteFunctionConcurrency
amazonaws_lambda.DeleteFunctionConcurrency({
"FunctionName": ""
}, context)
Input
- input
object
- FunctionName required
string
- FunctionName required
Output
Output schema unknown
PutFunctionConcurrency
amazonaws_lambda.PutFunctionConcurrency({
"FunctionName": "",
"ReservedConcurrentExecutions": 0
}, context)
Input
- input
object
- FunctionName required
string
- ReservedConcurrentExecutions required ReservedConcurrentExecutions
- FunctionName required
Output
- output Concurrency
Definitions
AccountLimit
- AccountLimit
object
: Provides limits of code size and concurrency associated with the current account and region.- CodeSizeUnzipped Long
- CodeSizeZipped Long
- ConcurrentExecutions Integer
- TotalCodeSize Long
- UnreservedConcurrentExecutions UnreservedConcurrentExecutions
AccountUsage
- AccountUsage
object
: Provides code size usage and function count associated with the current account and region.
Action
- Action
string
AddPermissionRequest
- AddPermissionRequest
object
:- Action required Action
- EventSourceToken EventSourceToken
- Principal required Principal
- RevisionId String
- SourceAccount SourceOwner
- SourceArn Arn
- StatementId required StatementId
AddPermissionResponse
- AddPermissionResponse
object
:- Statement String
AdditionalVersion
- AdditionalVersion
string
AdditionalVersionWeights
- AdditionalVersionWeights
array
- items
object
- key AdditionalVersion
- value Weight
- items
Alias
- Alias
string
AliasConfiguration
- AliasConfiguration
object
: Provides configuration information about a Lambda function version alias.- AliasArn FunctionArn
- Description Description
- FunctionVersion Version
- Name Alias
- RevisionId String
- RoutingConfig AliasRoutingConfiguration
AliasList
- AliasList
array
- items AliasConfiguration
AliasRoutingConfiguration
- AliasRoutingConfiguration
object
: The parent object that implements what percentage of traffic will invoke each function version. For more information, see lambda-traffic-shifting-using-aliases.- AdditionalVersionWeights AdditionalVersionWeights
Arn
- Arn
string
BatchSize
- BatchSize
integer
Blob
- Blob
string
BlobStream
- BlobStream
string
Boolean
- Boolean
boolean
CodeStorageExceededException
- CodeStorageExceededException
object
: You have exceeded your maximum total code size per account. Limits
Concurrency
- Concurrency
object
- ReservedConcurrentExecutions ReservedConcurrentExecutions
CreateAliasRequest
- CreateAliasRequest
object
- Description Description
- FunctionVersion required Version
- Name required Alias
- RoutingConfig AliasRoutingConfiguration
CreateEventSourceMappingRequest
- CreateEventSourceMappingRequest
object
:- BatchSize BatchSize
- Enabled Enabled
- EventSourceArn required Arn
- FunctionName required FunctionName
- StartingPosition required EventSourcePosition
- StartingPositionTimestamp Date
CreateFunctionRequest
- CreateFunctionRequest
object
:- Code required FunctionCode
- DeadLetterConfig DeadLetterConfig
- Description Description
- Environment Environment
- FunctionName required FunctionName
- Handler required Handler
- KMSKeyArn KMSKeyArn
- MemorySize MemorySize
- Publish Boolean
- Role required RoleArn
- Runtime required Runtime
- Tags Tags
- Timeout Timeout
- TracingConfig TracingConfig
- VpcConfig VpcConfig
Date
- Date
string
DeadLetterConfig
- DeadLetterConfig
object
: The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.- TargetArn ResourceArn
DeleteAliasRequest
- DeleteAliasRequest
object
DeleteEventSourceMappingRequest
- DeleteEventSourceMappingRequest
object
:
DeleteFunctionConcurrencyRequest
- DeleteFunctionConcurrencyRequest
object
DeleteFunctionRequest
- DeleteFunctionRequest
object
Description
- Description
string
EC2AccessDeniedException
EC2ThrottledException
- EC2ThrottledException
object
: AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
EC2UnexpectedException
- EC2UnexpectedException
object
: AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
ENILimitReachedException
- ENILimitReachedException
object
: AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
Enabled
- Enabled
boolean
Environment
- Environment
object
: The parent object that contains your environment's configuration settings.- Variables EnvironmentVariables
EnvironmentError
- EnvironmentError
object
: The parent object that contains error information associated with your configuration settings.- ErrorCode String
- Message SensitiveString
EnvironmentResponse
- EnvironmentResponse
object
: The parent object returned that contains your environment's configuration settings or any error information associated with your configuration settings.- Error EnvironmentError
- Variables EnvironmentVariables
EnvironmentVariableName
- EnvironmentVariableName
string
EnvironmentVariableValue
- EnvironmentVariableValue
string
EnvironmentVariables
- EnvironmentVariables
array
- items
object
- items
EventSourceMappingConfiguration
- EventSourceMappingConfiguration
object
: Describes mapping between an Amazon Kinesis stream and a Lambda function.
EventSourceMappingsList
- EventSourceMappingsList
array
EventSourcePosition
- EventSourcePosition
string
(values: TRIM_HORIZON, LATEST, AT_TIMESTAMP)
EventSourceToken
- EventSourceToken
string
FunctionArn
- FunctionArn
string
FunctionCode
- FunctionCode
object
: The code for the Lambda function.- S3Bucket S3Bucket
- S3Key S3Key
- S3ObjectVersion S3ObjectVersion
- ZipFile Blob
FunctionCodeLocation
- FunctionCodeLocation
object
: The object for the Lambda function location.
FunctionConfiguration
- FunctionConfiguration
object
: A complex type that describes function metadata.- CodeSha256 String
- CodeSize Long
- DeadLetterConfig DeadLetterConfig
- Description Description
- Environment EnvironmentResponse
- FunctionArn NameSpacedFunctionArn
- FunctionName NamespacedFunctionName
- Handler Handler
- KMSKeyArn KMSKeyArn
- LastModified Timestamp
- MasterArn FunctionArn
- MemorySize MemorySize
- RevisionId String
- Role RoleArn
- Runtime Runtime
- Timeout Timeout
- TracingConfig TracingConfigResponse
- Version Version
- VpcConfig VpcConfigResponse
FunctionList
- FunctionList
array
- items FunctionConfiguration
FunctionName
- FunctionName
string
FunctionVersion
- FunctionVersion
string
(values: ALL)
GetAccountSettingsRequest
- GetAccountSettingsRequest
object
GetAccountSettingsResponse
- GetAccountSettingsResponse
object
- AccountLimit AccountLimit
- AccountUsage AccountUsage
GetAliasRequest
- GetAliasRequest
object
GetEventSourceMappingRequest
- GetEventSourceMappingRequest
object
:
GetFunctionConfigurationRequest
- GetFunctionConfigurationRequest
object
:
GetFunctionRequest
- GetFunctionRequest
object
:
GetFunctionResponse
- GetFunctionResponse
object
: This response contains the object for the Lambda function location (see FunctionCodeLocation.- Code FunctionCodeLocation
- Concurrency Concurrency
- Configuration FunctionConfiguration
- Tags Tags
GetPolicyRequest
- GetPolicyRequest
object
:
GetPolicyResponse
Handler
- Handler
string
HttpStatus
- HttpStatus
integer
Integer
- Integer
integer
InvalidParameterValueException
- InvalidParameterValueException
object
: One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in theCreateFunction
or theUpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this exception.
InvalidRequestContentException
- InvalidRequestContentException
object
: The request body could not be parsed as JSON.
InvalidRuntimeException
- InvalidRuntimeException
object
: The runtime or runtime version specified is not supported.
InvalidSecurityGroupIDException
- InvalidSecurityGroupIDException
object
: The Security Group ID provided in the Lambda function VPC configuration is invalid.
InvalidSubnetIDException
- InvalidSubnetIDException
object
: The Subnet ID provided in the Lambda function VPC configuration is invalid.
InvalidZipFileException
- InvalidZipFileException
object
: AWS Lambda could not unzip the function zip file.
InvocationRequest
- InvocationRequest
object
:- Payload Blob
InvocationResponse
- InvocationResponse
object
: Upon success, returns an empty response. Otherwise, throws an exception.- Payload Blob
InvocationType
- InvocationType
string
(values: Event, RequestResponse, DryRun)
InvokeAsyncRequest
- InvokeAsyncRequest
object
:- InvokeArgs required BlobStream
InvokeAsyncResponse
- InvokeAsyncResponse
object
: Upon success, it returns empty response. Otherwise, throws an exception.
KMSAccessDeniedException
- KMSAccessDeniedException
object
: Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
KMSDisabledException
- KMSDisabledException
object
: Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
KMSInvalidStateException
- KMSInvalidStateException
object
: Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.
KMSKeyArn
- KMSKeyArn
string
KMSNotFoundException
- KMSNotFoundException
object
: Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
ListAliasesRequest
- ListAliasesRequest
object
ListAliasesResponse
ListEventSourceMappingsRequest
- ListEventSourceMappingsRequest
object
:
ListEventSourceMappingsResponse
- ListEventSourceMappingsResponse
object
: Contains a list of event sources (see EventSourceMappingConfiguration)- EventSourceMappings EventSourceMappingsList
- NextMarker String
ListFunctionsRequest
- ListFunctionsRequest
object
:
ListFunctionsResponse
- ListFunctionsResponse
object
: Contains a list of AWS Lambda function configurations (see FunctionConfiguration.- Functions FunctionList
- NextMarker String
ListTagsRequest
- ListTagsRequest
object
ListTagsResponse
- ListTagsResponse
object
- Tags Tags
ListVersionsByFunctionRequest
- ListVersionsByFunctionRequest
object
:
ListVersionsByFunctionResponse
- ListVersionsByFunctionResponse
object
:- NextMarker String
- Versions FunctionList
LogType
- LogType
string
(values: None, Tail)
Long
- Long
integer
MasterRegion
- MasterRegion
string
MaxListItems
- MaxListItems
integer
MemorySize
- MemorySize
integer
NameSpacedFunctionArn
- NameSpacedFunctionArn
string
NamespacedFunctionName
- NamespacedFunctionName
string
NamespacedStatementId
- NamespacedStatementId
string
PolicyLengthExceededException
- PolicyLengthExceededException
object
: Lambda function access policy is limited to 20 KB.
PreconditionFailedException
- PreconditionFailedException
object
: The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call theGetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource.
Principal
- Principal
string
PublishVersionRequest
- PublishVersionRequest
object
:- CodeSha256 String
- Description Description
- RevisionId String
PutFunctionConcurrencyRequest
- PutFunctionConcurrencyRequest
object
- ReservedConcurrentExecutions required ReservedConcurrentExecutions
Qualifier
- Qualifier
string
RemovePermissionRequest
- RemovePermissionRequest
object
:
RequestTooLargeException
- RequestTooLargeException
object
: The request payload exceeded theInvoke
request body JSON input limit. For more information, see Limits.
ReservedConcurrentExecutions
- ReservedConcurrentExecutions
integer
ResourceArn
- ResourceArn
string
ResourceConflictException
ResourceNotFoundException
- ResourceNotFoundException
object
: The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
RoleArn
- RoleArn
string
Runtime
- Runtime
string
(values: nodejs, nodejs4.3, nodejs6.10, java8, python2.7, python3.6, dotnetcore1.0, dotnetcore2.0, nodejs4.3-edge, go1.x)
S3Bucket
- S3Bucket
string
S3Key
- S3Key
string
S3ObjectVersion
- S3ObjectVersion
string
SecurityGroupId
- SecurityGroupId
string
SecurityGroupIds
- SecurityGroupIds
array
- items SecurityGroupId
SensitiveString
- SensitiveString
string
ServiceException
- ServiceException
object
: The AWS Lambda service encountered an internal error.
SourceOwner
- SourceOwner
string
StatementId
- StatementId
string
String
- String
string
SubnetIPAddressLimitReachedException
- SubnetIPAddressLimitReachedException
object
: AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
SubnetId
- SubnetId
string
SubnetIds
- SubnetIds
array
- items SubnetId
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagResourceRequest
- TagResourceRequest
object
- Tags required Tags
TagValue
- TagValue
string
Tags
ThrottleReason
- ThrottleReason
string
(values: ConcurrentInvocationLimitExceeded, FunctionInvocationRateLimitExceeded, ReservedFunctionConcurrentInvocationLimitExceeded, ReservedFunctionInvocationRateLimitExceeded, CallerRateLimitExceeded)
Timeout
- Timeout
integer
Timestamp
- Timestamp
string
TooManyRequestsException
- TooManyRequestsException
object
:- Reason ThrottleReason
- Type String
- message String
TracingConfig
- TracingConfig
object
: The parent object that contains your function's tracing settings.- Mode TracingMode
TracingConfigResponse
- TracingConfigResponse
object
: Parent object of the tracing information associated with your Lambda function.- Mode TracingMode
TracingMode
- TracingMode
string
(values: Active, PassThrough)
UnreservedConcurrentExecutions
- UnreservedConcurrentExecutions
integer
UnsupportedMediaTypeException
- UnsupportedMediaTypeException
object
: The content type of theInvoke
request body is not JSON.
UntagResourceRequest
- UntagResourceRequest
object
UpdateAliasRequest
- UpdateAliasRequest
object
- Description Description
- FunctionVersion Version
- RevisionId String
- RoutingConfig AliasRoutingConfiguration
UpdateEventSourceMappingRequest
- UpdateEventSourceMappingRequest
object
:- BatchSize BatchSize
- Enabled Enabled
- FunctionName FunctionName
UpdateFunctionCodeRequest
- UpdateFunctionCodeRequest
object
:
UpdateFunctionConfigurationRequest
- UpdateFunctionConfigurationRequest
object
:- DeadLetterConfig DeadLetterConfig
- Description Description
- Environment Environment
- Handler Handler
- KMSKeyArn KMSKeyArn
- MemorySize MemorySize
- RevisionId String
- Role RoleArn
- Runtime Runtime
- Timeout Timeout
- TracingConfig TracingConfig
- VpcConfig VpcConfig
Version
- Version
string
VpcConfig
- VpcConfig
object
: 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.- SecurityGroupIds SecurityGroupIds
- SubnetIds SubnetIds
VpcConfigResponse
- VpcConfigResponse
object
: VPC configuration associated with your Lambda function.- SecurityGroupIds SecurityGroupIds
- SubnetIds SubnetIds
- VpcId VpcId
VpcId
- VpcId
string
Weight
- Weight
number