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.
License: Apache 2.0 License
Resources
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
InvokeAsyncRequest
|
object |
Properties
InvokeArgs
|
BlobStream |
The JSON that you want to provide to your Lambda function as input. |
||||
|
||||||
Examples
{
"FunctionName": "myFunction",
"InvokeArgs": "fileb:\/\/file-path\/input.json"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
InvokeAsyncResponse
|
object |
A success response ( |
Properties
Status
|
HttpStatus |
The status code. |
||||
|
||||||
Examples
{
"Status": 123
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestContentException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRuntimeException
|
Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
Marker
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListEventSourceMappingsRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListEventSourceMappingsResponse
|
object |
Properties
EventSourceMappings
|
EventSourceMappingsList |
A list of event source mappings. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
NextMarker
|
String |
A pagination token that's returned when the response doesn't contain all event source mappings. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateEventSourceMappingRequest
|
object |
Properties
StartingPositionTimestamp
|
Date |
With |
||||
|
||||||
StartingPosition
|
EventSourcePosition |
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. |
||||
|
||||||
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch.
|
||||
|
||||||
Enabled
|
Enabled |
Disables the event source mapping to pause polling and invocation. |
||||
|
||||||
FunctionName
|
FunctionName |
The name of the Lambda function. Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. |
||||
|
||||||
EventSourceArn
|
Arn |
The Amazon Resource Name (ARN) of the event source.
|
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EventSourceMappingConfiguration
|
object |
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details. |
Properties
StateTransitionReason
|
String |
The cause of the last state change, either |
||||
|
||||||
State
|
String |
The state of the event source mapping. It can be one of the following: |
||||
|
||||||
LastProcessingResult
|
String |
The result of the last AWS Lambda invocation of your Lambda function. |
||||
|
||||||
LastModified
|
Date |
The date that the event source mapping was last updated. |
||||
|
||||||
FunctionArn
|
FunctionArn |
The ARN of the Lambda function. |
||||
|
||||||
EventSourceArn
|
Arn |
The Amazon Resource Name (ARN) of the event source. |
||||
|
||||||
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch. |
||||
|
||||||
UUID
|
String |
The identifier of the event source mapping. |
||||
|
||||||
Examples
{
"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"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
Request
Path
| Name | Data Type | Description |
|---|---|---|
UUID
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteEventSourceMappingRequest
|
object |
Examples
{
"UUID": "12345kxodurf3443"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EventSourceMappingConfiguration
|
object |
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details. |
Properties
StateTransitionReason
|
String |
The cause of the last state change, either |
||||
|
||||||
State
|
String |
The state of the event source mapping. It can be one of the following: |
||||
|
||||||
LastProcessingResult
|
String |
The result of the last AWS Lambda invocation of your Lambda function. |
||||
|
||||||
LastModified
|
Date |
The date that the event source mapping was last updated. |
||||
|
||||||
FunctionArn
|
FunctionArn |
The ARN of the Lambda function. |
||||
|
||||||
EventSourceArn
|
Arn |
The Amazon Resource Name (ARN) of the event source. |
||||
|
||||||
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch. |
||||
|
||||||
UUID
|
String |
The identifier of the event source mapping. |
||||
|
||||||
Examples
{
"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"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
Request
Path
| Name | Data Type | Description |
|---|---|---|
UUID
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetEventSourceMappingRequest
|
object |
Examples
{
"UUID": "123489-xxxxx-kdla8d89d7"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EventSourceMappingConfiguration
|
object |
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details. |
Properties
StateTransitionReason
|
String |
The cause of the last state change, either |
||||
|
||||||
State
|
String |
The state of the event source mapping. It can be one of the following: |
||||
|
||||||
LastProcessingResult
|
String |
The result of the last AWS Lambda invocation of your Lambda function. |
||||
|
||||||
LastModified
|
Date |
The date that the event source mapping was last updated. |
||||
|
||||||
FunctionArn
|
FunctionArn |
The ARN of the Lambda function. |
||||
|
||||||
EventSourceArn
|
Arn |
The Amazon Resource Name (ARN) of the event source. |
||||
|
||||||
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch. |
||||
|
||||||
UUID
|
String |
The identifier of the event source mapping. |
||||
|
||||||
Examples
{
"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"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
Request
Path
| Name | Data Type | Description |
|---|---|---|
UUID
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
UpdateEventSourceMappingRequest
|
object |
Properties
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch.
|
||||
|
||||||
Enabled
|
Enabled |
Disables the event source mapping to pause polling and invocation. |
||||
|
||||||
FunctionName
|
FunctionName |
The name of the Lambda function. Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. |
||||
|
||||||
Examples
{
"BatchSize": 123,
"Enabled": true,
"FunctionName": "myFunction",
"UUID": "1234xCy789012"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EventSourceMappingConfiguration
|
object |
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details. |
Properties
StateTransitionReason
|
String |
The cause of the last state change, either |
||||
|
||||||
State
|
String |
The state of the event source mapping. It can be one of the following: |
||||
|
||||||
LastProcessingResult
|
String |
The result of the last AWS Lambda invocation of your Lambda function. |
||||
|
||||||
LastModified
|
Date |
The date that the event source mapping was last updated. |
||||
|
||||||
FunctionArn
|
FunctionArn |
The ARN of the Lambda function. |
||||
|
||||||
EventSourceArn
|
Arn |
The Amazon Resource Name (ARN) of the event source. |
||||
|
||||||
BatchSize
|
BatchSize |
The maximum number of items to retrieve in a single batch. |
||||
|
||||||
UUID
|
String |
The identifier of the event source mapping. |
||||
|
||||||
Examples
{
"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"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
Marker
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListFunctionsRequest
|
object |
Examples
{
"Marker": "",
"MaxItems": 123
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListFunctionsResponse
|
object |
A list of Lambda functions. |
Properties
Functions
|
FunctionList |
A list of Lambda functions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NextMarker
|
String |
The pagination token that's included if more results are available. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Functions": [],
"NextMarker": ""
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Deletes a Lambda function alias.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Name
|
string | |
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAliasRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Name": "alias"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Returns details about a Lambda function alias.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Name
|
string | |
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetAliasRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Name": "myFunctionAlias"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
AliasConfiguration
|
object |
Provides configuration information about a Lambda function alias. |
Properties
RevisionId
|
String |
A unique identifier that changes when you update the alias. |
||||||||||||||
|
||||||||||||||||
RoutingConfig
|
AliasRoutingConfiguration |
The routing configuration of the alias. |
||||||||||||||
Properties
|
||||||||||||||||
Description
|
Description |
A description of the alias. |
||||||||||||||
|
||||||||||||||||
FunctionVersion
|
Version |
The function version that the alias invokes. |
||||||||||||||
|
||||||||||||||||
Name
|
Alias |
The name of the alias. |
||||||||||||||
|
||||||||||||||||
AliasArn
|
FunctionArn |
The Amazon Resource Name (ARN) of the alias. |
||||||||||||||
|
||||||||||||||||
Examples
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias",
"Description": "",
"FunctionVersion": "1",
"Name": "functionAlias"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Updates the configuration of a Lambda function alias.
Request
Path
| Name | Data Type | Description |
|---|---|---|
Name
|
string | |
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
UpdateAliasRequest
|
object |
Properties
RevisionId
|
String |
Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it. |
||||||||||||||
|
||||||||||||||||
RoutingConfig
|
AliasRoutingConfiguration |
The routing configuration of the alias. |
||||||||||||||
Properties
|
||||||||||||||||
Description
|
Description |
A description of the alias. |
||||||||||||||
|
||||||||||||||||
FunctionVersion
|
Version |
The function version that the alias invokes. |
||||||||||||||
|
||||||||||||||||
Examples
{
"Description": "",
"FunctionName": "myFunction",
"FunctionVersion": "1",
"Name": "functionAlias"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
AliasConfiguration
|
object |
Provides configuration information about a Lambda function alias. |
Properties
RevisionId
|
String |
A unique identifier that changes when you update the alias. |
||||||||||||||
|
||||||||||||||||
RoutingConfig
|
AliasRoutingConfiguration |
The routing configuration of the alias. |
||||||||||||||
Properties
|
||||||||||||||||
Description
|
Description |
A description of the alias. |
||||||||||||||
|
||||||||||||||||
FunctionVersion
|
Version |
The function version that the alias invokes. |
||||||||||||||
|
||||||||||||||||
Name
|
Alias |
The name of the alias. |
||||||||||||||
|
||||||||||||||||
AliasArn
|
FunctionArn |
The Amazon Resource Name (ARN) of the alias. |
||||||||||||||
|
||||||||||||||||
Examples
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias",
"Description": "",
"FunctionVersion": "1",
"Name": "functionAlias"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Returns a list of aliases for a Lambda function.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListAliasesRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"FunctionVersion": "1",
"Marker": "",
"MaxItems": 123
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAliasesResponse
|
object |
Properties
Aliases
|
AliasList |
A list of aliases. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextMarker
|
String |
The pagination token that's included if more results are available. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Examples
{
"Aliases": [],
"NextMarker": ""
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateAliasRequest
|
object |
Properties
RoutingConfig
|
AliasRoutingConfiguration |
The routing configuration of the alias. |
||||||||||||||
Properties
|
||||||||||||||||
Description
|
Description |
A description of the alias. |
||||||||||||||
|
||||||||||||||||
FunctionVersion
|
Version |
The function version that the alias invokes. |
||||||||||||||
|
||||||||||||||||
Name
|
Alias |
The name of the alias. |
||||||||||||||
|
||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AliasConfiguration
|
object |
Provides configuration information about a Lambda function alias. |
Properties
RevisionId
|
String |
A unique identifier that changes when you update the alias. |
||||||||||||||
|
||||||||||||||||
RoutingConfig
|
AliasRoutingConfiguration |
The routing configuration of the alias. |
||||||||||||||
Properties
|
||||||||||||||||
Description
|
Description |
A description of the alias. |
||||||||||||||
|
||||||||||||||||
FunctionVersion
|
Version |
The function version that the alias invokes. |
||||||||||||||
|
||||||||||||||||
Name
|
Alias |
The name of the alias. |
||||||||||||||
|
||||||||||||||||
AliasArn
|
FunctionArn |
The Amazon Resource Name (ARN) of the alias. |
||||||||||||||
|
||||||||||||||||
Examples
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias",
"Description": "",
"FunctionVersion": "1",
"Name": "functionAlias"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Updates a Lambda function's code.
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
UpdateFunctionCodeRequest
|
object |
Properties
RevisionId
|
String |
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it. |
||||
|
||||||
DryRun
|
Boolean |
Set to true to validate the request parameters and access permissions without modifying the function code. |
||||
|
||||||
Publish
|
Boolean |
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately. |
||||
|
||||||
S3ObjectVersion
|
S3ObjectVersion |
For versioned objects, the version of the deployment package object to use. |
||||
|
||||||
S3Key
|
S3Key |
The Amazon S3 key of the deployment package. |
||||
|
||||||
S3Bucket
|
S3Bucket |
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. |
||||
|
||||||
ZipFile
|
Blob |
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you. |
||||
|
||||||
Examples
{
"FunctionName": "myFunction",
"Publish": true,
"S3Bucket": "myBucket",
"S3Key": "myKey",
"S3ObjectVersion": "1",
"ZipFile": "fileb:\/\/file-path\/file.zip"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
FunctionConfiguration
|
object |
Details about a function's configuration. |
Properties
Layers
|
LayersReferenceList |
The function's layers. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
RevisionId
|
String |
The latest updated revision of the function or alias. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MasterArn
|
FunctionArn |
For Lambda@Edge functions, the ARN of the master function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TracingConfig
|
TracingConfigResponse |
The function's AWS X-Ray tracing configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Environment
|
EnvironmentResponse |
The function's environment variables. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
The function's dead letter queue. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
VpcConfig
|
VpcConfigResponse |
The function's networking configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Version
|
Version |
The version of the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSha256
|
String |
The SHA256 hash of the function's deployment package. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
LastModified
|
Timestamp |
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The memory that's allocated to the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
The function's description. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSize
|
Long |
The size of the function's deployment package, in bytes. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Handler
|
Handler |
The function that Lambda calls to begin executing your function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Role
|
RoleArn |
The function's execution role. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Runtime
|
Runtime |
The runtime environment for the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionArn
|
NameSpacedFunctionArn |
The function's Amazon Resource Name (ARN). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionName
|
NamespacedFunctionName |
The name of the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
CodeStorageExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetFunctionConfigurationRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Qualifier": "1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
FunctionConfiguration
|
object |
Details about a function's configuration. |
Properties
Layers
|
LayersReferenceList |
The function's layers. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
RevisionId
|
String |
The latest updated revision of the function or alias. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MasterArn
|
FunctionArn |
For Lambda@Edge functions, the ARN of the master function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TracingConfig
|
TracingConfigResponse |
The function's AWS X-Ray tracing configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Environment
|
EnvironmentResponse |
The function's environment variables. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
The function's dead letter queue. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
VpcConfig
|
VpcConfigResponse |
The function's networking configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Version
|
Version |
The version of the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSha256
|
String |
The SHA256 hash of the function's deployment package. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
LastModified
|
Timestamp |
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The memory that's allocated to the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
The function's description. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSize
|
Long |
The size of the function's deployment package, in bytes. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Handler
|
Handler |
The function that Lambda calls to begin executing your function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Role
|
RoleArn |
The function's execution role. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Runtime
|
Runtime |
The runtime environment for the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionArn
|
NameSpacedFunctionArn |
The function's Amazon Resource Name (ARN). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionName
|
NamespacedFunctionName |
The name of the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Modify the version-specifc settings of a Lambda function.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
UpdateFunctionConfigurationRequest
|
object |
Properties
Layers
|
LayerList |
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
RevisionId
|
String |
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
TracingConfig
|
TracingConfig |
Set |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Runtime
|
Runtime |
The identifier of the function's runtime. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Environment
|
Environment |
Environment variables that are accessible from function code during execution. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
VpcConfig
|
VpcConfig |
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Description
|
Description |
A description of the function. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Handler
|
Handler |
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Role
|
RoleArn |
The Amazon Resource Name (ARN) of the function's execution role. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Examples
{
"Description": "",
"FunctionName": "myFunction",
"Handler": "index.handler",
"MemorySize": 128,
"Role": "arn:aws:iam::123456789012:role\/lambda_basic_execution",
"Runtime": "python2.7",
"Timeout": 123,
"VpcConfig": []
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
FunctionConfiguration
|
object |
Details about a function's configuration. |
Properties
Layers
|
LayersReferenceList |
The function's layers. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
RevisionId
|
String |
The latest updated revision of the function or alias. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MasterArn
|
FunctionArn |
For Lambda@Edge functions, the ARN of the master function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TracingConfig
|
TracingConfigResponse |
The function's AWS X-Ray tracing configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Environment
|
EnvironmentResponse |
The function's environment variables. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
The function's dead letter queue. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
VpcConfig
|
VpcConfigResponse |
The function's networking configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Version
|
Version |
The version of the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSha256
|
String |
The SHA256 hash of the function's deployment package. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
LastModified
|
Timestamp |
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The memory that's allocated to the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
The function's description. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSize
|
Long |
The size of the function's deployment package, in bytes. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Handler
|
Handler |
The function that Lambda calls to begin executing your function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Role
|
RoleArn |
The function's execution role. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Runtime
|
Runtime |
The runtime environment for the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionArn
|
NameSpacedFunctionArn |
The function's Amazon Resource Name (ARN). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionName
|
NamespacedFunctionName |
The name of the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
InvocationRequest
|
object |
Properties
Payload
|
Blob |
The JSON that you want to provide to your Lambda function as input. |
||||
|
||||||
Examples
{
"ClientContext": "MyApp",
"FunctionName": "MyFunction",
"InvocationType": "Event",
"LogType": "Tail",
"Payload": "fileb:\/\/file-path\/input.json",
"Qualifier": "1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
InvocationResponse
|
object |
Properties
Payload
|
Blob |
The response from the function, or an error object. |
||||
|
||||||
StatusCode
|
Integer |
The HTTP status code is in the 200 range for a successful request. For the |
||||
|
||||||
Examples
{
"FunctionError": "",
"LogResult": "",
"Payload": "?",
"StatusCode": 123
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestContentException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestTooLargeException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedMediaTypeException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
EC2UnexpectedException
|
Body
| Name | Data Type | Description |
|---|---|---|
SubnetIPAddressLimitReachedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ENILimitReachedException
|
Body
| Name | Data Type | Description |
|---|---|---|
EC2ThrottledException
|
Body
| Name | Data Type | Description |
|---|---|---|
EC2AccessDeniedException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSubnetIDException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSecurityGroupIDException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidZipFileException
|
Body
| Name | Data Type | Description |
|---|---|---|
KMSDisabledException
|
Body
| Name | Data Type | Description |
|---|---|---|
KMSInvalidStateException
|
Body
| Name | Data Type | Description |
|---|---|---|
KMSAccessDeniedException
|
Body
| Name | Data Type | Description |
|---|---|---|
KMSNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRuntimeException
|
Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
Request
Path
| Name | Data Type | Description |
|---|---|---|
StatementId
|
string | |
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
RemovePermissionRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Qualifier": "1",
"StatementId": "role-statement-id"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Returns the resource-based IAM policy for a function, version, or alias.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetPolicyRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Qualifier": "1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
AddPermissionRequest
|
object |
Properties
RevisionId
|
String |
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it. |
||||
|
||||||
EventSourceToken
|
EventSourceToken |
For Alexa Smart Home functions, a token that must be supplied by the invoker. |
||||
|
||||||
SourceAccount
|
SourceOwner |
For AWS services, the ID of the account that owns the resource. Use this instead of |
||||
|
||||||
SourceArn
|
Arn |
For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. |
||||
|
||||||
Principal
|
Principal |
The AWS service or account that invokes the function. If you specify a service, use |
||||
|
||||||
Action
|
Action |
The action that the principal can use on the function. For example, |
||||
|
||||||
StatementId
|
StatementId |
A statement identifier that differentiates the statement from others in the same policy. |
||||
|
||||||
Examples
{
"Action": "lambda:InvokeFunction",
"FunctionName": "MyFunction",
"Principal": "s3.amazonaws.com",
"SourceAccount": "123456789012",
"SourceArn": "arn:aws:s3:::examplebucket\/*",
"StatementId": "ID-1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddPermissionResponse
|
object |
Properties
Statement
|
String |
The permission statement that's added to the function policy. |
||||
|
||||||
Examples
{
"Statement": "ID-1"
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
PolicyLengthExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Returns a list of versions, with the version-specific configuration of each.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListVersionsByFunctionRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Marker": "",
"MaxItems": 123
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListVersionsByFunctionResponse
|
object |
Properties
Versions
|
FunctionList |
A list of Lambda function versions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NextMarker
|
String |
The pagination token that's included if more results are available. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"NextMarker": "",
"Versions": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PublishVersionRequest
|
object |
Properties
RevisionId
|
String |
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it. |
||||
|
||||||
Description
|
Description |
A description for the version to override the description in the function configuration. |
||||
|
||||||
CodeSha256
|
String |
Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode. |
||||
|
||||||
Examples
{
"CodeSha256": "",
"Description": "",
"FunctionName": "myFunction"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
FunctionConfiguration
|
object |
Details about a function's configuration. |
Properties
Layers
|
LayersReferenceList |
The function's layers. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
RevisionId
|
String |
The latest updated revision of the function or alias. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MasterArn
|
FunctionArn |
For Lambda@Edge functions, the ARN of the master function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TracingConfig
|
TracingConfigResponse |
The function's AWS X-Ray tracing configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Environment
|
EnvironmentResponse |
The function's environment variables. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
The function's dead letter queue. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
VpcConfig
|
VpcConfigResponse |
The function's networking configuration. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Version
|
Version |
The version of the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSha256
|
String |
The SHA256 hash of the function's deployment package. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
LastModified
|
Timestamp |
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The memory that's allocated to the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
The function's description. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CodeSize
|
Long |
The size of the function's deployment package, in bytes. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Handler
|
Handler |
The function that Lambda calls to begin executing your function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Role
|
RoleArn |
The function's execution role. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Runtime
|
Runtime |
The runtime environment for the Lambda function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionArn
|
NameSpacedFunctionArn |
The function's Amazon Resource Name (ARN). |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
FunctionName
|
NamespacedFunctionName |
The name of the function. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
CodeStorageExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
PreconditionFailedException
|
Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteFunctionRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Qualifier": "1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceConflictException
|
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
Request
Path
| Name | Data Type | Description |
|---|---|---|
FunctionName
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetFunctionRequest
|
object |
Examples
{
"FunctionName": "myFunction",
"Qualifier": "1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetFunctionResponse
|
object |
Properties
Concurrency
|
Concurrency |
The function's reserved concurrency. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tags
|
Tags |
The function's tags. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code
|
FunctionCodeLocation |
The deployment package of the function or version. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Configuration
|
FunctionConfiguration |
The configuration of the function or version. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Examples |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Code": {
"Location": "somelocation",
"RepositoryType": "S3"
},
"Configuration": {
"CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=",
"CodeSize": 262,
"Description": "A starter AWS Lambda function.",
"Environment": {
"Variables": {
"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": "nodejs8.10",
"Timeout": 3,
"Version": "$LATEST",
"VpcConfig": {
"SecurityGroupIds": [],
"SubnetIds": []
}
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRequestsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterValueException
|
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateFunctionRequest
|
object |
Properties
Layers
|
LayerList |
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Tags
|
Tags |
A list of tags to apply to the function. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
TracingConfig
|
TracingConfig |
Set |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
KMSKeyArn
|
KMSKeyArn |
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Environment
|
Environment |
Environment variables that are accessible from function code during execution. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
DeadLetterConfig
|
DeadLetterConfig |
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
VpcConfig
|
VpcConfig |
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Publish
|
Boolean |
Set to true to publish the first version of the function during creation. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
MemorySize
|
MemorySize |
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Timeout
|
Timeout |
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Description
|
Description |
A description of the function. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Code
|
FunctionCode |
The code for the function. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Handler
|
Handler |
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Role
|
RoleArn |
The Amazon Resource Name (ARN) of the function's execution role. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Runtime
|
Runtime |
The identifier of the function's runtime. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
FunctionName
|
FunctionName |
The name of the Lambda function. Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Code": [],
"Description": "",
"FunctionName": "MyFunction",
"Handler": "souce_file.handler_name",
"MemorySize": 128,
"Publish": true,
"Role": "arn:aws:iam::123456789012:role\/service-role\/role-name",
"Runtime": "nodejs8.10",
"Timeout": 15,
"VpcConfig": []
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
FunctionConfiguration
|
object |
Details about a function's configuration. |
Properties
Layers
|
LayersReferenceList |
The function's layers. |
|||||||||
| |||||||||||