Skip to content

Commit 124c44e

Browse files
committed
tutorial fixes and cleanup
1 parent 8f844c8 commit 124c44e

File tree

145 files changed

+3432
-4638
lines changed

Some content is hidden

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

145 files changed

+3432
-4638
lines changed

doc_source/API_AddPermission.md

+6-10
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

@@ -39,12 +39,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 140\.
3939
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-_]+))?`
4040

4141
** [Qualifier](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Qualifier"></a>
42-
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:
43-
`arn:aws:lambda:aws-region:acct-id:function:function-name:2`
44-
If you specify an alias name, for example `PROD`, then the permission is valid only for requests made using the alias ARN:
45-
`arn:aws:lambda:aws-region:acct-id:function:function-name:PROD`
46-
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN\.
47-
`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\.
4843
Length Constraints: Minimum length of 1\. Maximum length of 128\.
4944
Pattern: `(|[a-zA-Z0-9$_-]+)`
5045

@@ -66,7 +61,7 @@ Pattern: `[a-zA-Z0-9._\-]+`
6661
Required: No
6762

6863
** [Principal](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
69-
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\.
7065
Type: String
7166
Pattern: `.*`
7267
Required: Yes
@@ -83,8 +78,8 @@ Pattern: `\d{12}`
8378
Required: No
8479

8580
** [SourceArn](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceArn"></a>
86-
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\.
87-
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\.
8883
Type: String
8984
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`
9085
Required: No
@@ -144,6 +139,7 @@ The AWS Lambda service encountered an internal error\.
144139
HTTP Status Code: 500
145140

146141
**TooManyRequestsException**
142+
Request throughput limit exceeded
147143
HTTP Status Code: 429
148144

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

doc_source/API_CreateAlias.md

+1
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ The AWS Lambda service encountered an internal error\.
141141
HTTP Status Code: 500
142142

143143
**TooManyRequestsException**
144+
Request throughput limit exceeded
144145
HTTP Status Code: 429
145146

146147
## See Also<a name="API_CreateAlias_SeeAlso"></a>

doc_source/API_CreateEventSourceMapping.md

+1
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ The AWS Lambda service encountered an internal error\.
158158
HTTP Status Code: 500
159159

160160
**TooManyRequestsException**
161+
Request throughput limit exceeded
161162
HTTP Status Code: 429
162163

163164
## See Also<a name="API_CreateEventSourceMapping_SeeAlso"></a>

doc_source/API_CreateFunction.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Valid Range: Minimum value of 1\.
137137
Required: No
138138

139139
** [TracingConfig](#API_CreateFunction_RequestSyntax) ** <a name="SSS-CreateFunction-request-TracingConfig"></a>
140-
The parent object that contains your function's tracing settings\.
140+
Set `Mode` to `Active` to sample and trace a subset of incoming requests with AWS X\-Ray\.
141141
Type: [TracingConfig](API_TracingConfig.md) object
142142
Required: No
143143

@@ -310,6 +310,7 @@ The AWS Lambda service encountered an internal error\.
310310
HTTP Status Code: 500
311311

312312
**TooManyRequestsException**
313+
Request throughput limit exceeded
313314
HTTP Status Code: 429
314315

315316
## See Also<a name="API_CreateFunction_SeeAlso"></a>

doc_source/API_DeleteAlias.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The AWS Lambda service encountered an internal error\.
5555
HTTP Status Code: 500
5656

5757
**TooManyRequestsException**
58+
Request throughput limit exceeded
5859
HTTP Status Code: 429
5960

6061
## See Also<a name="API_DeleteAlias_SeeAlso"></a>

doc_source/API_DeleteEventSourceMapping.md

+1
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ The AWS Lambda service encountered an internal error\.
9999
HTTP Status Code: 500
100100

101101
**TooManyRequestsException**
102+
Request throughput limit exceeded
102103
HTTP Status Code: 429
103104

104105
## See Also<a name="API_DeleteEventSourceMapping_SeeAlso"></a>

doc_source/API_DeleteFunction.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# DeleteFunction<a name="API_DeleteFunction"></a>
22

3-
Deletes the specified Lambda function code and configuration\.
4-
5-
If you are using the versioning feature and you don't specify a function version in your `DeleteFunction` request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions\. To delete a specific function version, you must provide the function version via the `Qualifier` parameter\. For information about function versioning, see [AWS Lambda Function Versioning and Aliases](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html)\.
6-
7-
When you delete a function the associated resource policy is also deleted\. You will need to delete the event source mappings explicitly\.
3+
Deletes a Lambda function\. To delete a specific function version, use the `Qualifier` parameter\. Otherwise, all versions and aliases are deleted\. Event source mappings are not deleted\.
84

95
This operation requires permission for the `lambda:DeleteFunction` action\.
106

@@ -30,9 +26,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 140\.
3026
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-_]+))?`
3127

3228
** [Qualifier](#API_DeleteFunction_RequestSyntax) ** <a name="SSS-DeleteFunction-request-Qualifier"></a>
33-
Using this optional parameter you can specify a function version \(but not the `$LATEST` version\) to direct AWS Lambda to delete a specific function version\. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it\. You can delete any function version but not the `$LATEST`, that is, you cannot specify `$LATEST` as the value of this parameter\. The `$LATEST` version can be deleted only when you want to delete all the function versions and aliases\.
34-
You can only specify a function version, not an alias name, using this parameter\. You cannot delete a function version using its alias\.
35-
If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases\.
29+
Specify a version to delete\. You cannot delete a version that is referenced by an alias\.
3630
Length Constraints: Minimum length of 1\. Maximum length of 128\.
3731
Pattern: `(|[a-zA-Z0-9$_-]+)`
3832

@@ -69,6 +63,7 @@ The AWS Lambda service encountered an internal error\.
6963
HTTP Status Code: 500
7064

7165
**TooManyRequestsException**
66+
Request throughput limit exceeded
7267
HTTP Status Code: 429
7368

7469
## See Also<a name="API_DeleteFunction_SeeAlso"></a>

doc_source/API_DeleteFunctionConcurrency.md

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ The AWS Lambda service encountered an internal error\.
5252
HTTP Status Code: 500
5353

5454
**TooManyRequestsException**
55+
Request throughput limit exceeded
5556
HTTP Status Code: 429
5657

5758
## See Also<a name="API_DeleteFunctionConcurrency_SeeAlso"></a>

doc_source/API_Environment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Environment<a name="API_Environment"></a>
22

3-
The parent object that contains your environment's configuration settings\.
3+
A function's environment variable settings\.
44

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

77
**Variables** <a name="SSS-Type-Environment-Variables"></a>
8-
The key\-value pairs that represent your environment's configuration settings\.
8+
Environment variable key\-value pairs\.
99
Type: String to string map
1010
Key Pattern: `[a-zA-Z]([a-zA-Z0-9_])+`
1111
Required: No

doc_source/API_EnvironmentError.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# EnvironmentError<a name="API_EnvironmentError"></a>
22

3-
The parent object that contains error information associated with your configuration settings\.
3+
Error messages for environment variables that could not be applied\.
44

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

77
**ErrorCode** <a name="SSS-Type-EnvironmentError-ErrorCode"></a>
8-
The error code returned by the environment error object\.
8+
The error code\.
99
Type: String
1010
Required: No
1111

1212
**Message** <a name="SSS-Type-EnvironmentError-Message"></a>
13-
The message returned by the environment error object\.
13+
The error message\.
1414
Type: String
1515
Required: No
1616

doc_source/API_EnvironmentResponse.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# EnvironmentResponse<a name="API_EnvironmentResponse"></a>
22

3-
The parent object returned that contains your environment's configuration settings or any error information associated with your configuration settings\.
3+
The results of a configuration update that applied environment variables\.
44

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

77
**Error** <a name="SSS-Type-EnvironmentResponse-Error"></a>
8+
Error messages for environment variables that could not be applied\.
89
Type: [EnvironmentError](API_EnvironmentError.md) object
910
Required: No
1011

1112
**Variables** <a name="SSS-Type-EnvironmentResponse-Variables"></a>
12-
The key\-value pairs returned that represent your environment's configuration settings or error information\.
13+
Environment variable key\-value pairs\.
1314
Type: String to string map
1415
Key Pattern: `[a-zA-Z]([a-zA-Z0-9_])+`
1516
Required: No

doc_source/API_GetAccountSettings.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# GetAccountSettings<a name="API_GetAccountSettings"></a>
22

3-
Returns a customer's account settings\.
4-
5-
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits\. For more information about limits, see [AWS Lambda Limits](https://docs.aws.amazon.com/lambda/latest/dg/limits.html)\. You can also retrieve resource usage statistics, such as code storage usage and function count\.
3+
Retrieves details about your account's [limits](https://docs.aws.amazon.com/lambda/latest/dg/limits.html) and usage in a region\.
64

75
## Request Syntax<a name="API_GetAccountSettings_RequestSyntax"></a>
86

@@ -46,9 +44,11 @@ If the action is successful, the service sends back an HTTP 200 response\.
4644
The following data is returned in JSON format by the service\.
4745

4846
** [AccountLimit](#API_GetAccountSettings_ResponseSyntax) ** <a name="SSS-GetAccountSettings-response-AccountLimit"></a>
47+
Limits related to concurrency and code storage\.
4948
Type: [AccountLimit](API_AccountLimit.md) object
5049

5150
** [AccountUsage](#API_GetAccountSettings_ResponseSyntax) ** <a name="SSS-GetAccountSettings-response-AccountUsage"></a>
51+
The number of functions and amount of storage in use\.
5252
Type: [AccountUsage](API_AccountUsage.md) object
5353

5454
## Errors<a name="API_GetAccountSettings_Errors"></a>
@@ -58,6 +58,7 @@ The AWS Lambda service encountered an internal error\.
5858
HTTP Status Code: 500
5959

6060
**TooManyRequestsException**
61+
Request throughput limit exceeded
6162
HTTP Status Code: 429
6263

6364
## See Also<a name="API_GetAccountSettings_SeeAlso"></a>

doc_source/API_GetAlias.md

+1
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ The AWS Lambda service encountered an internal error\.
105105
HTTP Status Code: 500
106106

107107
**TooManyRequestsException**
108+
Request throughput limit exceeded
108109
HTTP Status Code: 429
109110

110111
## See Also<a name="API_GetAlias_SeeAlso"></a>

doc_source/API_GetEventSourceMapping.md

+1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ The AWS Lambda service encountered an internal error\.
9595
HTTP Status Code: 500
9696

9797
**TooManyRequestsException**
98+
Request throughput limit exceeded
9899
HTTP Status Code: 429
99100

100101
## See Also<a name="API_GetEventSourceMapping_SeeAlso"></a>

doc_source/API_GetFunction.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Returns the configuration information of the Lambda function and a presigned URL link to the \.zip file you uploaded with [CreateFunction](API_CreateFunction.md) so you can download the \.zip file\. Note that the URL is valid for up to 10 minutes\. The configuration information is the same information you provided as parameters when uploading the function\.
44

5-
Using the optional `Qualifier` parameter, you can specify a specific function version for which you want this information\. If you don't specify this parameter, the API uses unqualified function ARN which return information about the `$LATEST` version of the Lambda function\. For more information, see [AWS Lambda Function Versioning and Aliases](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html)\.
5+
Use the `Qualifier` parameter to retrieve a published version of the function\. Otherwise, returns the unpublished version \(`$LATEST`\)\. For more information, 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:GetFunction` action\.
88

@@ -28,7 +28,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\.
2828
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-_]+))?`
2929

3030
** [Qualifier](#API_GetFunction_RequestSyntax) ** <a name="SSS-GetFunction-request-Qualifier"></a>
31-
Use this optional parameter to specify a function version or an alias name\. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version\. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points\. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the `$LATEST` version of the Lambda function\.
31+
Specify a version or alias to get details about a published version of the function\.
3232
Length Constraints: Minimum length of 1\. Maximum length of 128\.
3333
Pattern: `(|[a-zA-Z0-9$_-]+)`
3434

@@ -100,13 +100,15 @@ If the action is successful, the service sends back an HTTP 200 response\.
100100
The following data is returned in JSON format by the service\.
101101

102102
** [Code](#API_GetFunction_ResponseSyntax) ** <a name="SSS-GetFunction-response-Code"></a>
103+
The function's code\.
103104
Type: [FunctionCodeLocation](API_FunctionCodeLocation.md) object
104105

105106
** [Concurrency](#API_GetFunction_ResponseSyntax) ** <a name="SSS-GetFunction-response-Concurrency"></a>
106107
The concurrent execution limit set for this function\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\.
107108
Type: [Concurrency](API_Concurrency.md) object
108109

109110
** [Configuration](#API_GetFunction_ResponseSyntax) ** <a name="SSS-GetFunction-response-Configuration"></a>
111+
The function's configuration\.
110112
Type: [FunctionConfiguration](API_FunctionConfiguration.md) object
111113

112114
** [Tags](#API_GetFunction_ResponseSyntax) ** <a name="SSS-GetFunction-response-Tags"></a>
@@ -128,6 +130,7 @@ The AWS Lambda service encountered an internal error\.
128130
HTTP Status Code: 500
129131

130132
**TooManyRequestsException**
133+
Request throughput limit exceeded
131134
HTTP Status Code: 429
132135

133136
## See Also<a name="API_GetFunction_SeeAlso"></a>

doc_source/API_GetFunctionConfiguration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\.
2828
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-_]+))?`
2929

3030
** [Qualifier](#API_GetFunctionConfiguration_RequestSyntax) ** <a name="SSS-GetFunctionConfiguration-request-Qualifier"></a>
31-
Using this optional parameter you can specify a function version or an alias name\. If you specify function version, the API uses qualified function ARN and returns information about the specific function version\. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points\.
32-
If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the `$LATEST` function version\.
31+
Specify a version or alias to get details about a published version of the function\.
3332
Length Constraints: Minimum length of 1\. Maximum length of 128\.
3433
Pattern: `(|[a-zA-Z0-9$_-]+)`
3534

@@ -193,6 +192,7 @@ The AWS Lambda service encountered an internal error\.
193192
HTTP Status Code: 500
194193

195194
**TooManyRequestsException**
195+
Request throughput limit exceeded
196196
HTTP Status Code: 429
197197

198198
## See Also<a name="API_GetFunctionConfiguration_SeeAlso"></a>

doc_source/API_GetPolicy.md

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ The AWS Lambda service encountered an internal error\.
7575
HTTP Status Code: 500
7676

7777
**TooManyRequestsException**
78+
Request throughput limit exceeded
7879
HTTP Status Code: 429
7980

8081
## See Also<a name="API_GetPolicy_SeeAlso"></a>

doc_source/API_Invoke.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ You can set this optional parameter to `Tail` in the request only if you specify
5555
Valid Values:` None | Tail`
5656

5757
** [Qualifier](#API_Invoke_RequestSyntax) ** <a name="SSS-Invoke-request-Qualifier"></a>
58-
You can use this optional parameter to specify a Lambda function version or alias name\. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function\. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points\.
59-
If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the `$LATEST` version\.
58+
Specify a version or alias to invoke a published version of the function\.
6059
Length Constraints: Minimum length of 1\. Maximum length of 128\.
6160
Pattern: `(|[a-zA-Z0-9$_-]+)`
6261

@@ -107,6 +106,7 @@ In the event of a function error this field contains a message describing the er
107106
## Errors<a name="API_Invoke_Errors"></a>
108107

109108
**EC2AccessDeniedException**
109+
Need additional permissions to configure VPC settings\.
110110
HTTP Status Code: 502
111111

112112
**EC2ThrottledException**
@@ -142,7 +142,7 @@ The Subnet ID provided in the Lambda function VPC configuration is invalid\.
142142
HTTP Status Code: 502
143143

144144
**InvalidZipFileException**
145-
AWS Lambda could not unzip the function zip file\.
145+
AWS Lambda could not unzip the deployment package\.
146146
HTTP Status Code: 502
147147

148148
**KMSAccessDeniedException**
@@ -178,6 +178,7 @@ AWS Lambda was not able to set up VPC access for the Lambda function because one
178178
HTTP Status Code: 502
179179

180180
**TooManyRequestsException**
181+
Request throughput limit exceeded
181182
HTTP Status Code: 429
182183

183184
**UnsupportedMediaTypeException**

0 commit comments

Comments
 (0)