RemovePermissionCommand

Suggest an Edit

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LambdaClient, RemovePermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, RemovePermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // RemovePermissionRequest
  FunctionName: "STRING_VALUE", // required
  StatementId: "STRING_VALUE", // required
  Qualifier: "STRING_VALUE",
  RevisionId: "STRING_VALUE",
};
const command = new RemovePermissionCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

RemovePermissionCommand Input

See RemovePermissionCommandInput for more details

Parameter
Type
Description
FunctionName
Required
string | undefined

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the 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.

StatementId
Required
string | undefined

Statement ID of the permission to remove.

Qualifier
string | undefined

Specify a version or alias to remove permissions from a published version of the function.

RevisionId
string | undefined

Update the policy only 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.

RemovePermissionCommand Output

See RemovePermissionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

PreconditionFailedException
client

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

  • For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

  • For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

ResourceNotFoundException
client

The resource specified in the request does not exist.

ServiceException
server

The Lambda service encountered an internal error.

TooManyRequestsException
client

The request throughput limit was exceeded. For more information, see Lambda quotas .

LambdaServiceException
Base exception class for all service exceptions from Lambda service.