`@aws-lite/lambda`

Maintained by: @architect

Install

npm i @aws-lite/lambda

Optionally install types:

npm i -D @aws-lite/lambda-types

Methods

`AddLayerVersionPermission`

Canonical AWS API doc

Properties

Action (string) [required]: The API action that grants access to the layer, for example lambda:GetLayerVersion
LayerName (string) [required]: Name or ARN of the layer
StatementId (string) [required]: ID to distinguish the policy from other policies on the same layer version
VersionNumber (number) [required]: The version number of the layer
OrganizationId (string): When Principal is set to *, permission will be granted to all accounts in the specified organization
Principal (string): Account ID being granted permissions. Use * along with the OrganizationId to grant permissions to all accounts in the specified organization
RevisionId (string): Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it

Example

await aws.Lambda.AddLayerVersionPermission({
  Action: String, // required
  LayerName: String, // required
  StatementId: String, // required
  VersionNumber: Number, // required
  OrganizationId: String,
  Principal: String,
  RevisionId: String,
})

`AddPermission`

Canonical AWS API doc

Properties

Action (string) [required]: Action that the principal can use on the function, for example, lambda:InvokeFunction
FunctionName (string) [required]: The name of the Lambda function, version, or alias
Principal (string) [required]: The AWS service or AWS account that invokes the function
StatementId (string) [required]: A statement identifier that differentiates the statement from others in the same policy
EventSourceToken (string): A token that Alexa Smart Home requires from the invoker
FunctionUrlAuthType (string): The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint
PrincipalOrgID (string): The identifier for your organization in AWS Organizations
Qualifier (string): Specify a version or alias to invoke a published version of the function
RevisionId (string): Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it
SourceAccount (string): ID of the AWS account that owns the resource
SourceArn (string): ARN of the AWS resource that invokes the function, such as an Amazon S3 bucket

Example

await aws.Lambda.AddPermission({
  Action: String, // required
  FunctionName: String, // required
  Principal: String, // required
  StatementId: String, // required
  EventSourceToken: String,
  FunctionUrlAuthType: String,
  PrincipalOrgID: String,
  Qualifier: String,
  RevisionId: String,
  SourceAccount: String,
  SourceArn: String,
})

`CreateAlias`

Canonical AWS API doc

Properties

FunctionName (string) [required]

The name of the Lambda function, version, or alias

FunctionVersion (string) [required]

Version of the aliased function

Name (string) [required]

Name of the alias

Description (string)

Description of the function

RoutingConfig (object)

Configure function version weights

Example

await aws.Lambda.CreateAlias({
  FunctionName: String, // required
  FunctionVersion: String, // required
  Name: String, // required
  Description: String,
  RoutingConfig: Object,
})

`CreateCodeSigningConfig`

Canonical AWS API doc

Properties

AllowedPublishers (object) [required]: Signing profiles for this code signing configuration; More details (AWS)
Description (string): Description of the function

Example

await aws.Lambda.CreateCodeSigningConfig({
  AllowedPublishers: Object, // required
  CodeSigningPolicies: Object,
  Description: String,
})

`CreateFunction`

Canonical AWS API doc

Code payload to be run in Lambda; object can contain: ImageUri (ECR image), S3Bucket + S3Key + S3ObjectVersion (S3 bucket in the same region, key, and optional version), or ZipFile (base64-encoded zip)

More details (AWS)

Description (string)

Description of the function

Environment (object)

Environment variable configuration

More details (AWS)

FileSystemConfigs (array)

EFS file system connection settings

More details (AWS)

ImageConfig (object)

Container image configuration (overrides Docker file)

More details (AWS)

SnapStart (object)

SnapStart settings

More details (AWS)

VpcConfig (object)

VPC networking configuration

Example

await aws.Lambda.CreateFunction({
  Code: Object, // required
  FunctionName: String, // required
  Role: String, // required
  Architectures: Array,
  CodeSigningConfigArn: String,
  DeadLetterConfig: Object,
  Description: String,
  Environment: Object,
  EphemeralStorage: Object,
  FileSystemConfigs: Array,
  Handler: String,
  ImageConfig: Object,
  KMSKeyArn: String,
  Layers: Array,
  MemorySize: Number,
  PackageType: String,
  Publish: Boolean,
  Runtime: String,
  SnapStart: Object,
  Tags: Array,
  Timeout: Number,
  TracingConfig: Object,
  VpcConfig: Object,
})

`DeleteAlias`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Name (string) [required]: Name of the alias

Example

await aws.Lambda.DeleteAlias({
  FunctionName: String, // required
  Name: String, // required
})

`DeleteCodeSigningConfig`

Canonical AWS API doc

Properties

CodeSigningConfigArn (string) [required]: ARN of the code signing configuration

Example

await aws.Lambda.DeleteCodeSigningConfig({
  CodeSigningConfigArn: String, // required
})

`DeleteEventSourceMapping`

Canonical AWS API doc

Properties

UUID (string) [required]: UUID of the event source mapping

Example

await aws.Lambda.DeleteEventSourceMapping({
  UUID: String, // required
})

`DeleteFunctionConcurrency`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias

Example

await aws.Lambda.DeleteFunctionConcurrency({
  FunctionName: String, // required
})

`GetAccountSettings`

Canonical AWS API doc

Properties

Example

await aws.Lambda.GetAccountSettings()

`GetAlias`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Name (string) [required]: Name of the function alias

Example

await aws.Lambda.GetAlias({
  FunctionName: String, // required
  Name: String, // required
})

`GetCodeSigningConfig`

Canonical AWS API doc

Properties

CodeSigningConfigArn (string) [required]: ARN of the code signing configuration

Example

await aws.Lambda.GetCodeSigningConfig({
  CodeSigningConfigArn: String, // required
})

`GetEventSourceMapping`

Canonical AWS API doc

Properties

UUID (string) [required]: ARN of the event source mapping

Example

await aws.Lambda.GetEventSourceMapping({
  UUID: String, // required
})

`GetFunction`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetFunction({
  FunctionName: String, // required
  Qualifier: String,
})

`GetFunctionCodeSigningConfig`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias

Example

await aws.Lambda.GetFunctionCodeSigningConfig({
  FunctionName: String, // required
})

`GetFunctionConcurrency`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias

Example

await aws.Lambda.GetFunctionConcurrency({
  FunctionName: String, // required
})

`GetFunctionConfiguration`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetFunctionConfiguration({
  FunctionName: String, // required
  Qualifier: String,
})

`GetFunctionEventInvokeConfig`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetFunctionEventInvokeConfig({
  FunctionName: String, // required
  Qualifier: String,
})

`GetFunctionUrlConfig`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetFunctionUrlConfig({
  FunctionName: String, // required
  Qualifier: String,
})

`GetLayerVersion`

Canonical AWS API doc

Properties

LayerName (string) [required]: Name or ARN of the layer
VersionNumber (number) [required]: The version number of the layer

Example

await aws.Lambda.GetLayerVersion({
  LayerName: String, // required
  VersionNumber: Number, // required
})

`GetLayerVersionByArn`

Canonical AWS API doc

Properties

Arn (string) [required]: The ARN of the layer version

Example

await aws.Lambda.GetLayerVersionByArn({
  Arn: String, // required
})

`GetLayerVersionPolicy`

Canonical AWS API doc

Properties

LayerName (string) [required]: Name or ARN of the layer
VersionNumber (number) [required]: The version number of the layer

Example

await aws.Lambda.GetLayerVersionPolicy({
  LayerName: String, // required
  VersionNumber: Number, // required
})

`GetPolicy`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetPolicy({
  FunctionName: String, // required
  Qualifier: String,
})

`GetProvisionedConcurrencyConfig`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string) [required]: The version number or alias name

Example

await aws.Lambda.GetProvisionedConcurrencyConfig({
  FunctionName: String, // required
  Qualifier: String, // required
})

`GetRuntimeManagementConfig`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.GetRuntimeManagementConfig({
  FunctionName: String, // required
  Qualifier: String,
})

`Invoke`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Payload (array, object) [required]: Event payload to invoke function with
ClientContext (string): Up to 3,583 bytes of base64-encoded data to pass to the function in the context object
InvocationType (string): Set invocation type to one of: RequestResponse (default, synchronous), Event (asynchronous), DryRun (validate invoke request only)
LogType (string): Set to Tail to include the execution log in the X-Amz-Log-Result response header of synchronously invoked functions
Qualifier (string): Specify a version or alias to invoke a published version of the function

Example

await aws.Lambda.Invoke({
  FunctionName: String, // required
  Payload: Array || Object, // required
  ClientContext: String,
  InvocationType: String,
  LogType: String,
  Qualifier: String,
})

`PutFunctionConcurrency`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
ReservedConcurrentExecutions (number) [required]: number of simultaneous executions to reserve

Example

await aws.Lambda.PutFunctionConcurrency({
  FunctionName: String, // required
  ReservedConcurrentExecutions: Number, // required
})

`UpdateAlias`

Canonical AWS API doc

Properties

FunctionName (string) [required]

The name of the Lambda function, version, or alias

Name (string) [required]

Name of the alias

Description (string)

Description of the function

FunctionVersion (string)

Version of the aliased function

RevisionId (string)

Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it

RoutingConfig (object)

Configure function version weights

Example

await aws.Lambda.UpdateAlias({
  FunctionName: String, // required
  Name: String, // required
  Description: String,
  FunctionVersion: String,
  RevisionId: String,
  RoutingConfig: Object,
})

`UpdateFunctionCode`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
Architectures (array): System architecture, array can contain either x86_64 (default) or arm64
DryRun (string): Validate the request parameters and access permissions without modifying the function code (true)
ImageUri (string): URI of a container image in the Amazon ECR registry (if not using a .zip file)
Publish (boolean): Publish a new version after after updating the code (true); effectively the same as calling PublishVersion
RevisionId (string): Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it
S3Bucket (string): S3 bucket containing the key of the deployment package; must be in the same region
S3Key (string): S3 key of the deployment package (must be a .zip file)
S3ObjectVersion (string): S3 object version to use, if applicable
ZipFile (string, buffer): File path or raw buffer of the .zip deployment package

Example

await aws.Lambda.UpdateFunctionCode({
  FunctionName: String, // required
  Architectures: Array,
  DryRun: String,
  ImageUri: String,
  Publish: Boolean,
  RevisionId: String,
  S3Bucket: String,
  S3Key: String,
  S3ObjectVersion: String,
  ZipFile: String || ,
})

`UpdateFunctionConfiguration`

Canonical AWS API doc

Properties

FunctionName (string) [required]: The name of the Lambda function, version, or alias
DeadLetterConfig (object): Dead-letter queue configuration; More details (AWS)
EphemeralStorage (object): Size of the function /tmp directory (in MB), from 512 (default) to 10240; More details (AWS)
Handler (string): The name of the handler file and method method within your code that Lambda calls to run your function (e.g. index.handler); More details (AWS)
KMSKeyArn (string): ARN of the Key Management Service (KMS) customer managed key used to encrypt your function environment variables
Layers (array): List of function layer ARNs (including version) to add to the function execution environment
MemorySize (number): Amount of memory available (in MB) at runtime from 128 to 10240; increasing memory also increases CPU allocation
RevisionId (string): Update the function config only if the current revision ID matches the specified RevisionId; used to avoid modifying a function that has changed since you last read it
Role (string): ARN of the function’s execution role
Runtime (string): Runtime identifier; More details (AWS)
Timeout (number): Time (in seconds) a function is allowed to run before being stopped, from 3 (default) to 900
TracingConfig (object): Sample and trace a subset of incoming requests with X-Ray; More details (AWS)

Example

await aws.Lambda.UpdateFunctionConfiguration({
  FunctionName: String, // required
  DeadLetterConfig: Object,
  Description: String,
  Environment: Object,
  EphemeralStorage: Object,
  FileSystemConfigs: Array,
  Handler: String,
  ImageConfig: Object,
  KMSKeyArn: String,
  Layers: Array,
  MemorySize: Number,
  RevisionId: String,
  Role: String,
  Runtime: String,
  SnapStart: Object,
  Timeout: Number,
  TracingConfig: Object,
  VpcConfig: Object,
})

Methods yet to be implemented

Please help out by opening a PR!