GetPolicy
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource policy
associated with the specific Lambda function version or alias by specifying
the version or alias name using the Qualifier
parameter.
For more information about versioning, see AWS Lambda Function Versioning and Aliases.
You need permission for the lambda:GetPolicy action.
Request Syntax
GET /2015-03-31/functions/
FunctionName
/policy?Qualifier=Qualifier
HTTP/1.1
URI Request Parameters
The request requires the following URI parameters.
- FunctionName
-
Function name whose resource policy you want to retrieve.
You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.Length Constraints: Minimum length of 1. Maximum length of 170.
Pattern:
(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
- Qualifier
-
You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(|[a-zA-Z0-9$_-]+)
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200 Content-type: application/json { "Policy": "string", "RevisionId": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Policy
-
The resource policy associated with the specified function. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.
Type: String
- RevisionId
-
Represents the latest updated revision of the function or alias.
Type: String
Errors
- InvalidParameterValueException
-
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the
CreateFunction
or theUpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this exception.HTTP Status Code: 400
- ResourceNotFoundException
-
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
HTTP Status Code: 404
- ServiceException
-
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500
- TooManyRequestsException
-
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: