Use DeleteFunction with an AWS SDK or CLI (original) (raw)
The following code examples show how to use DeleteFunction
.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
.NET
SDK for .NET
/// <summary>
/// Delete an AWS Lambda function.
/// </summary>
/// <param name="functionName">The name of the Lambda function to
/// delete.</param>
/// <returns>A Boolean value that indicates the success of the action.</returns>
public async Task<bool> DeleteFunctionAsync(string functionName)
{
var request = new DeleteFunctionRequest
{
FunctionName = functionName,
};
var response = await _lambdaService.DeleteFunctionAsync(request);
// A return value of NoContent means that the request was processed.
// In this case, the function was deleted, and the return value
// is intentionally blank.
return response.HttpStatusCode == System.Net.HttpStatusCode.NoContent;
}
- For API details, seeDeleteFunction in AWS SDK for .NET API Reference.
C++
SDK for C++
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region in which the bucket was created (overrides config file).
// clientConfig.region = "us-east-1";
Aws::Lambda::LambdaClient client(clientConfig);
Aws::Lambda::Model::DeleteFunctionRequest request;
request.SetFunctionName(LAMBDA_NAME);
Aws::Lambda::Model::DeleteFunctionOutcome outcome = client.DeleteFunction(
request);
if (outcome.IsSuccess()) {
std::cout << "The lambda function was successfully deleted." << std::endl;
}
else {
std::cerr << "Error with Lambda::DeleteFunction. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
- For API details, seeDeleteFunction in AWS SDK for C++ API Reference.
CLI
AWS CLI
Example 1: To delete a Lambda function by function name
The following delete-function
example deletes the Lambda function named my-function
by specifying the function's name.
aws lambda delete-function \
--function-name my-function
This command produces no output.
Example 2: To delete a Lambda function by function ARN
The following delete-function
example deletes the Lambda function named my-function
by specifying the function's ARN.
aws lambda delete-function \
--function-name arn:aws:lambda:us-west-2:123456789012:function:my-function
This command produces no output.
Example 3: To delete a Lambda function by partial function ARN
The following delete-function
example deletes the Lambda function named my-function
by specifying the function's partial ARN.
aws lambda delete-function \
--function-name 123456789012:function:my-function
This command produces no output.
For more information, see AWS Lambda Function Configuration in the AWS Lambda Developer Guide.
- For API details, seeDeleteFunction in AWS CLI Command Reference.
Go
SDK for Go V2
import (
"bytes"
"context"
"encoding/json"
"errors"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/lambda"
"github.com/aws/aws-sdk-go-v2/service/lambda/types"
)
// FunctionWrapper encapsulates function actions used in the examples.
// It contains an AWS Lambda service client that is used to perform user actions.
type FunctionWrapper struct {
LambdaClient *lambda.Client
}
// DeleteFunction deletes the Lambda function specified by functionName.
func (wrapper FunctionWrapper) DeleteFunction(ctx context.Context, functionName string) {
_, err := wrapper.LambdaClient.DeleteFunction(ctx, &lambda.DeleteFunctionInput{
FunctionName: aws.String(functionName),
})
if err != nil {
log.Panicf("Couldn't delete function %v. Here's why: %v\n", functionName, err)
}
}
- For API details, seeDeleteFunction in AWS SDK for Go API Reference.
Java
SDK for Java 2.x
/**
* Deletes an AWS Lambda function.
*
* @param awsLambda an instance of the {@link LambdaClient} class, which is used to interact with the AWS Lambda service
* @param functionName the name of the Lambda function to be deleted
*
* @throws LambdaException if an error occurs while deleting the Lambda function
*/
public static void deleteLambdaFunction(LambdaClient awsLambda, String functionName) {
try {
DeleteFunctionRequest request = DeleteFunctionRequest.builder()
.functionName(functionName)
.build();
awsLambda.deleteFunction(request);
System.out.println("The " + functionName + " function was deleted");
} catch (LambdaException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
- For API details, seeDeleteFunction in AWS SDK for Java 2.x API Reference.
JavaScript
SDK for JavaScript (v3)
/**
* @param {string} funcName
*/
const deleteFunction = (funcName) => {
const client = new LambdaClient({});
const command = new DeleteFunctionCommand({ FunctionName: funcName });
return client.send(command);
};
- For API details, seeDeleteFunction in AWS SDK for JavaScript API Reference.
Kotlin
SDK for Kotlin
suspend fun delLambdaFunction(myFunctionName: String) {
val request =
DeleteFunctionRequest {
functionName = myFunctionName
}
LambdaClient { region = "us-east-1" }.use { awsLambda ->
awsLambda.deleteFunction(request)
println("$myFunctionName was deleted")
}
}
- For API details, seeDeleteFunction in AWS SDK for Kotlin API reference.
PHP
SDK for PHP
public function deleteFunction($functionName)
{
return $this->lambdaClient->deleteFunction([
'FunctionName' => $functionName,
]);
}
- For API details, seeDeleteFunction in AWS SDK for PHP API Reference.
PowerShell
Tools for PowerShell V4
Example 1: This example deletes a specific version of a Lambda function
Remove-LMFunction -FunctionName "MylambdaFunction123" -Qualifier '3'
- For API details, seeDeleteFunction in AWS Tools for PowerShell Cmdlet Reference (V4).
Python
SDK for Python (Boto3)
class LambdaWrapper:
def __init__(self, lambda_client, iam_resource):
self.lambda_client = lambda_client
self.iam_resource = iam_resource
def delete_function(self, function_name):
"""
Deletes a Lambda function.
:param function_name: The name of the function to delete.
"""
try:
self.lambda_client.delete_function(FunctionName=function_name)
except ClientError:
logger.exception("Couldn't delete function %s.", function_name)
raise
- For API details, seeDeleteFunction in AWS SDK for Python (Boto3) API Reference.
Ruby
SDK for Ruby
class LambdaWrapper
attr_accessor :lambda_client, :cloudwatch_client, :iam_client
def initialize
@lambda_client = Aws::Lambda::Client.new
@cloudwatch_client = Aws::CloudWatchLogs::Client.new(region: 'us-east-1')
@iam_client = Aws::IAM::Client.new(region: 'us-east-1')
@logger = Logger.new($stdout)
@logger.level = Logger::WARN
end
# Deletes a Lambda function.
# @param function_name: The name of the function to delete.
def delete_function(function_name)
print "Deleting function: #{function_name}..."
@lambda_client.delete_function(
function_name: function_name
)
print 'Done!'.green
rescue Aws::Lambda::Errors::ServiceException => e
@logger.error("There was an error deleting #{function_name}:\n #{e.message}")
end
- For API details, seeDeleteFunction in AWS SDK for Ruby API Reference.
Rust
SDK for Rust
/** Delete a function and its role, and if possible or necessary, its associated code object and bucket. */
pub async fn delete_function(
&self,
location: Option<String>,
) -> (
Result<DeleteFunctionOutput, anyhow::Error>,
Result<DeleteRoleOutput, anyhow::Error>,
Option<Result<DeleteObjectOutput, anyhow::Error>>,
) {
info!("Deleting lambda function {}", self.lambda_name);
let delete_function = self
.lambda_client
.delete_function()
.function_name(self.lambda_name.clone())
.send()
.await
.map_err(anyhow::Error::from);
info!("Deleting iam role {}", self.role_name);
let delete_role = self
.iam_client
.delete_role()
.role_name(self.role_name.clone())
.send()
.await
.map_err(anyhow::Error::from);
let delete_object: Option<Result<DeleteObjectOutput, anyhow::Error>> =
if let Some(location) = location {
info!("Deleting object {location}");
Some(
self.s3_client
.delete_object()
.bucket(self.bucket.clone())
.key(location)
.send()
.await
.map_err(anyhow::Error::from),
)
} else {
info!(?location, "Skipping delete object");
None
};
(delete_function, delete_role, delete_object)
}
- For API details, seeDeleteFunction in AWS SDK for Rust API reference.
SAP ABAP
SDK for SAP ABAP
TRY.
lo_lmd->deletefunction( iv_functionname = iv_function_name ).
MESSAGE 'Lambda function deleted.' TYPE 'I'.
CATCH /aws1/cx_lmdinvparamvalueex.
MESSAGE 'The request contains a non-valid parameter.' TYPE 'E'.
CATCH /aws1/cx_lmdresourceconflictex.
MESSAGE 'Resource already exists or another operation is in progress.' TYPE 'E'.
CATCH /aws1/cx_lmdresourcenotfoundex.
MESSAGE 'The requested resource does not exist.' TYPE 'E'.
CATCH /aws1/cx_lmdserviceexception.
MESSAGE 'An internal problem was encountered by the AWS Lambda service.' TYPE 'E'.
CATCH /aws1/cx_lmdtoomanyrequestsex.
MESSAGE 'The maximum request throughput was reached.' TYPE 'E'.
ENDTRY.
- For API details, seeDeleteFunction in AWS SDK for SAP ABAP API reference.
DeleteAlias
DeleteFunctionConcurrency
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.