GetPolicyCommand

Suggest an Edit

Returns the resource-based IAM policy  for a function, version, or alias.

Example Syntax

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

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

Example Usage

 There was an error loading the code editor. Retry

GetPolicyCommand Input

See GetPolicyCommandInput 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.

Qualifier
string | undefined

Specify a version or alias to get the policy for that resource.

GetPolicyCommand Output

See GetPolicyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Policy
string | undefined

The resource-based policy.

RevisionId
string | undefined

A unique identifier for the current revision of the policy.

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

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.