POST /2015-03-31/functions/{FunctionName}/policy
Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal
. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID
. For Amazon Web Services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com
or sns.amazonaws.com
. For Amazon Web Services, you can also specify the ARN of the associated resource as the SourceArn
. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.
Servers
- https://lambda.{region}.amazonaws.com
- https://lambda.{region}.amazonaws.com.cn
Path parameters
Name | Type | Required | Description |
---|---|---|---|
FunctionName |
String | Yes |
The name of the Lambda function, version, or alias. Name formats
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. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
X-Amz-Content-Sha256 |
String | No | |
X-Amz-Credential |
String | No | |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Amz-Date |
String | No | |
X-Amz-Algorithm |
String | No | |
X-Amz-SignedHeaders |
String | No | |
X-Amz-Security-Token |
String | No | |
X-Amz-Signature |
String | No |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
Qualifier |
String | No |
Specify a version or alias to add permissions to a published version of the function. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
SourceArn |
String | No |
For Amazon Web Services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. Note that Lambda configures the comparison using the |
SourceAccount |
String | No |
For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource. Use this together with |
StatementId |
String | Yes |
A statement identifier that differentiates the statement from others in the same policy. |
Principal |
String | Yes |
The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, use |
RevisionId |
String | No |
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. |
FunctionUrlAuthType |
String | No |
The type of authentication that your function URL uses. Set to Possible values:
|
EventSourceToken |
String | No |
For Alexa Smart Home functions, a token that the invoker must supply. |
PrincipalOrgID |
String | No |
The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization. |
Action |
String | Yes |
The action that the principal can use on the function. For example, |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.