Skip to content

Commit 297df50

Browse files
authored
Merge branch 'master' into fix/typo
2 parents d6df4be + 302dfdf commit 297df50

File tree

311 files changed

+9176
-7290
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

311 files changed

+9176
-7290
lines changed

doc_source/API_AccountLimit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AccountLimit<a name="API_AccountLimit"></a>
22

3-
Provides limits of code size and concurrency associated with the current account and region\.
3+
Provides limits of code size and concurrency associated with the current account and region\. For more information or to request a limit increase for concurrent executions, see [Lambda Limits](https://docs.aws.amazon.com/lambda/latest/dg/limits.html)\.
44

55
## Contents<a name="API_AccountLimit_Contents"></a>
66

@@ -15,7 +15,7 @@ Type: Long
1515
Required: No
1616

1717
**ConcurrentExecutions** <a name="SSS-Type-AccountLimit-ConcurrentExecutions"></a>
18-
Number of simultaneous executions of your function per region\. For more information or to request a limit increase for concurrent executions, see [Lambda Function Concurrent Executions](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\. The default limit is 1000\.
18+
Number of simultaneous executions of your function per region\. The default limit is 1000\.
1919
Type: Integer
2020
Required: No
2121

@@ -25,7 +25,7 @@ Type: Long
2525
Required: No
2626

2727
**UnreservedConcurrentExecutions** <a name="SSS-Type-AccountLimit-UnreservedConcurrentExecutions"></a>
28-
The number of concurrent executions available to functions that do not have concurrency limits set\. For more information, see [Managing Concurrency](concurrent-executions.md)\.
28+
The number of concurrent executions available to functions that do not have concurrency limits set\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\.
2929
Type: Integer
3030
Valid Range: Minimum value of 0\.
3131
Required: No
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# AddLayerVersionPermission<a name="API_AddLayerVersionPermission"></a>
2+
3+
Adds permissions to the resource\-based policy of a version of a function layer\. Use this action to grant layer usage permission to other accounts\. You can grant permission to a single account, all AWS accounts, or all accounts in an organization\.
4+
5+
To revoke permission, call [RemoveLayerVersionPermission](API_RemoveLayerVersionPermission.md) with the statement ID that you specified when you added it\.
6+
7+
## Request Syntax<a name="API_AddLayerVersionPermission_RequestSyntax"></a>
8+
9+
```
10+
POST /2018-10-31/layers/LayerName/versions/VersionNumber/policy?RevisionId=RevisionId HTTP/1.1
11+
Content-type: application/json
12+
13+
{
14+
"[Action](#SSS-AddLayerVersionPermission-request-Action)": "string",
15+
"[OrganizationId](#SSS-AddLayerVersionPermission-request-OrganizationId)": "string",
16+
"[Principal](#SSS-AddLayerVersionPermission-request-Principal)": "string",
17+
"[StatementId](#SSS-AddLayerVersionPermission-request-StatementId)": "string"
18+
}
19+
```
20+
21+
## URI Request Parameters<a name="API_AddLayerVersionPermission_RequestParameters"></a>
22+
23+
The request requires the following URI parameters\.
24+
25+
** [LayerName](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-LayerName"></a>
26+
The name of the layer\.
27+
Length Constraints: Minimum length of 1\. Maximum length of 140\.
28+
Pattern: `(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+`
29+
30+
** [RevisionId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-RevisionId"></a>
31+
Only update the policy if the revision ID matches the ID specified\. Use this option to avoid modifying a policy that has changed since you last read it\.
32+
33+
** [VersionNumber](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-VersionNumber"></a>
34+
The version number\.
35+
36+
## Request Body<a name="API_AddLayerVersionPermission_RequestBody"></a>
37+
38+
The request accepts the following data in JSON format\.
39+
40+
** [Action](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Action"></a>
41+
The API action that grants access to the layer\. For example, `lambda:GetLayerVersion`\.
42+
Type: String
43+
Pattern: `lambda:GetLayerVersion`
44+
Required: Yes
45+
46+
** [OrganizationId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-OrganizationId"></a>
47+
With the principal set to `*`, grant permission to all accounts in the specified organization\.
48+
Type: String
49+
Pattern: `o-[a-z0-9]{10,32}`
50+
Required: No
51+
52+
** [Principal](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Principal"></a>
53+
An account ID, or `*` to grant permission to all AWS accounts\.
54+
Type: String
55+
Pattern: `\d{12}|\*|arn:(aws[a-zA-Z-]*):iam::\d{12}:root`
56+
Required: Yes
57+
58+
** [StatementId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-StatementId"></a>
59+
An identifier that distinguishes the policy from others on the same layer version\.
60+
Type: String
61+
Length Constraints: Minimum length of 1\. Maximum length of 100\.
62+
Pattern: `([a-zA-Z0-9-_]+)`
63+
Required: Yes
64+
65+
## Response Syntax<a name="API_AddLayerVersionPermission_ResponseSyntax"></a>
66+
67+
```
68+
HTTP/1.1 201
69+
Content-type: application/json
70+
71+
{
72+
"[RevisionId](#SSS-AddLayerVersionPermission-response-RevisionId)": "string",
73+
"[Statement](#SSS-AddLayerVersionPermission-response-Statement)": "string"
74+
}
75+
```
76+
77+
## Response Elements<a name="API_AddLayerVersionPermission_ResponseElements"></a>
78+
79+
If the action is successful, the service sends back an HTTP 201 response\.
80+
81+
The following data is returned in JSON format by the service\.
82+
83+
** [RevisionId](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-RevisionId"></a>
84+
A unique identifier for the current revision of the policy\.
85+
Type: String
86+
87+
** [Statement](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-Statement"></a>
88+
The permission statement\.
89+
Type: String
90+
91+
## Errors<a name="API_AddLayerVersionPermission_Errors"></a>
92+
93+
**InvalidParameterValueException**
94+
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 the `UpdateFunctionConfiguration` API, that AWS Lambda is unable to assume you will get this exception\.
95+
HTTP Status Code: 400
96+
97+
**PolicyLengthExceededException**
98+
Lambda function access policy is limited to 20 KB\.
99+
HTTP Status Code: 400
100+
101+
**PreconditionFailedException**
102+
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias\. Call the `GetFunction` or the `GetAlias` API to retrieve the latest RevisionId for your resource\.
103+
HTTP Status Code: 412
104+
105+
**ResourceConflictException**
106+
The resource already exists\.
107+
HTTP Status Code: 409
108+
109+
**ResourceNotFoundException**
110+
The resource \(for example, a Lambda function or access policy statement\) specified in the request does not exist\.
111+
HTTP Status Code: 404
112+
113+
**ServiceException**
114+
The AWS Lambda service encountered an internal error\.
115+
HTTP Status Code: 500
116+
117+
**TooManyRequestsException**
118+
Request throughput limit exceeded
119+
HTTP Status Code: 429
120+
121+
## See Also<a name="API_AddLayerVersionPermission_SeeAlso"></a>
122+
123+
For more information about using this API in one of the language\-specific AWS SDKs, see the following:
124+
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/AddLayerVersionPermission)
125+
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/AddLayerVersionPermission)
126+
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AddLayerVersionPermission)
127+
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AddLayerVersionPermission)
128+
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/lambda-2015-03-31/AddLayerVersionPermission)
129+
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/AddLayerVersionPermission)
130+
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/AddLayerVersionPermission)
131+
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/AddLayerVersionPermission)
132+
+ [AWS SDK for Ruby V2](https://docs.aws.amazon.com/goto/SdkForRubyV2/lambda-2015-03-31/AddLayerVersionPermission)

doc_source/API_AddPermission.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Adds a permission to the resource policy associated with the specified AWS Lambda function\. You use resource policies to grant permissions to event sources that use the *push* model\. In a *push* model, event sources \(such as Amazon S3 and custom applications\) invoke your Lambda function\. Each permission you add to the resource policy allows an event source permission to invoke the Lambda function\.
44

5-
If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the `AddPermission` request via the `Qualifier` parameter\. For more information about versioning, see [AWS Lambda Function Versioning and Aliases](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html)\.
5+
Permissions apply to the Amazon Resource Name \(ARN\) used to invoke the function, which can be unqualified \(the unpublished version of the function\), or include a version or alias\. If a client uses a version or alias to invoke a function, use the `Qualifier` parameter to apply permissions to that ARN\. For more information about versioning, see [AWS Lambda Function Versioning and Aliases](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html)\.
66

77
This operation requires permission for the `lambda:AddPermission` action\.
88

@@ -28,18 +28,18 @@ Content-type: application/json
2828
The request requires the following URI parameters\.
2929

3030
** [FunctionName](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-FunctionName"></a>
31-
Name of the Lambda function whose resource policy you are updating by adding a new permission\.
32-
You can specify a 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`\)\. AWS Lambda also allows you to specify partial ARN \(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\.
31+
The name of the lambda function\.
32+
33+
**Name formats**
34+
+ **Function name** \- `MyFunction`\.
35+
+ **Function ARN** \- `arn:aws:lambda:us-west-2:123456789012:function:MyFunction`\.
36+
+ **Partial ARN** \- `123456789012:function:MyFunction`\.
37+
The length constraint applies only to the full ARN\. If you specify only the function name, it is limited to 64 characters in length\.
3338
Length Constraints: Minimum length of 1\. Maximum length of 140\.
34-
Pattern: `(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?`
39+
Pattern: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?`
3540

3641
** [Qualifier](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Qualifier"></a>
37-
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name\. The permission will then apply to the specific qualified ARN\. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
38-
`arn:aws:lambda:aws-region:acct-id:function:function-name:2`
39-
If you specify an alias name, for example `PROD`, then the permission is valid only for requests made using the alias ARN:
40-
`arn:aws:lambda:aws-region:acct-id:function:function-name:PROD`
41-
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN\.
42-
`arn:aws:lambda:aws-region:acct-id:function:function-name`
42+
Specify a version or alias to add permissions to a published version of the function\.
4343
Length Constraints: Minimum length of 1\. Maximum length of 128\.
4444
Pattern: `(|[a-zA-Z0-9$_-]+)`
4545

@@ -61,13 +61,13 @@ Pattern: `[a-zA-Z0-9._\-]+`
6161
Required: No
6262

6363
** [Principal](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
64-
The principal who is getting this permission\. It can be Amazon S3 service Principal \(`s3.amazonaws.com`\) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross\-account permission, or any valid AWS service principal such as `sns.amazonaws.com`\. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function\.
64+
The principal who is getting this permission\. The principal can be an AWS service \(e\.g\. `s3.amazonaws.com` or `sns.amazonaws.com`\) for service triggers, or an account ID for cross\-account access\. If you specify a service as a principal, use the `SourceArn` parameter to limit who can invoke the function through that service\.
6565
Type: String
6666
Pattern: `.*`
6767
Required: Yes
6868

6969
** [RevisionId](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-RevisionId"></a>
70-
An optional value you can use to ensure you are updating the latest update of the function version or alias\. If the `RevisionID` you pass doesn't match the latest `RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either [GetFunction](https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunction.html) or [GetAlias](https://docs.aws.amazon.com/lambda/latest/dg/API_GetAlias.html) operations\.
70+
An optional value you can use to ensure you are updating the latest update of the function version or alias\. If the `RevisionID` you pass doesn't match the latest `RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either [GetFunction](API_GetFunction.md) or [GetAlias](API_GetAlias.md)
7171
Type: String
7272
Required: No
7373

@@ -78,10 +78,10 @@ Pattern: `\d{12}`
7878
Required: No
7979

8080
** [SourceArn](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceArn"></a>
81-
This is optional; however, when granting permission to invoke your function, you should specify this field with the Amazon Resource Name \(ARN\) as its value\. This ensures that only events generated from the specified source can invoke the function\.
82-
If you add a permission without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function\.
81+
The Amazon Resource Name of the invoker\.
82+
If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function\.
8383
Type: String
84-
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)`
84+
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`
8585
Required: No
8686

8787
** [StatementId](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-StatementId"></a>
@@ -139,7 +139,7 @@ The AWS Lambda service encountered an internal error\.
139139
HTTP Status Code: 500
140140

141141
**TooManyRequestsException**
142-
142+
Request throughput limit exceeded
143143
HTTP Status Code: 429
144144

145145
## See Also<a name="API_AddPermission_SeeAlso"></a>

doc_source/API_AliasConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Provides configuration information about a Lambda function version alias\.
77
**AliasArn** <a name="SSS-Type-AliasConfiguration-AliasArn"></a>
88
Lambda function ARN that is qualified using the alias name as the suffix\. For example, if you create an alias called `BETA` that points to a helloworld function version, the ARN is `arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA`\.
99
Type: String
10-
Pattern: `arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
10+
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
1111
Required: No
1212

1313
**Description** <a name="SSS-Type-AliasConfiguration-Description"></a>
@@ -36,7 +36,7 @@ Type: String
3636
Required: No
3737

3838
**RoutingConfig** <a name="SSS-Type-AliasConfiguration-RoutingConfig"></a>
39-
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version\. For more information, see [Traffic Shifting Using Aliases](lambda-traffic-shifting-using-aliases.md)\.
39+
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version\.
4040
Type: [AliasRoutingConfiguration](API_AliasRoutingConfiguration.md) object
4141
Required: No
4242

doc_source/API_AliasRoutingConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# AliasRoutingConfiguration<a name="API_AliasRoutingConfiguration"></a>
22

3-
The parent object that implements what percentage of traffic will invoke each function version\. For more information, see [Traffic Shifting Using Aliases](lambda-traffic-shifting-using-aliases.md)\.
3+
The alias's [traffic shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration\.
44

55
## Contents<a name="API_AliasRoutingConfiguration_Contents"></a>
66

77
**AdditionalVersionWeights** <a name="SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights"></a>
8-
Set this value to dictate what percentage of traffic will invoke the updated function version\. If set to an empty string, 100 percent of traffic will invoke `function-version`\. For more information, see [Traffic Shifting Using Aliases](lambda-traffic-shifting-using-aliases.md)\.
8+
The name of the second alias, and the percentage of traffic that is routed to it\.
99
Type: String to double map
1010
Key Length Constraints: Minimum length of 1\. Maximum length of 1024\.
1111
Key Pattern: `[0-9]+`

doc_source/API_Concurrency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Contents<a name="API_Concurrency_Contents"></a>
44

55
**ReservedConcurrentExecutions** <a name="SSS-Type-Concurrency-ReservedConcurrentExecutions"></a>
6-
The number of concurrent executions reserved for this function\. For more information, see [Managing Concurrency](concurrent-executions.md)\.
6+
The number of concurrent executions reserved for this function\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\.
77
Type: Integer
88
Valid Range: Minimum value of 0\.
99
Required: No

0 commit comments

Comments
 (0)