Skip to content

Commit c70b3a8

Browse files
committed
Documentation updates
1 parent 834c24b commit c70b3a8

File tree

203 files changed

+2158
-2539
lines changed

Some content is hidden

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

203 files changed

+2158
-2539
lines changed

doc_source/API_AccountLimit.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ Limits that are related to concurrency and storage\. All file and storage sizes
44

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

7-
**CodeSizeUnzipped** <a name="SSS-Type-AccountLimit-CodeSizeUnzipped"></a>
7+
** CodeSizeUnzipped ** <a name="SSS-Type-AccountLimit-CodeSizeUnzipped"></a>
88
The maximum size of a function's deployment package and layers when they're extracted\.
99
Type: Long
1010
Required: No
1111

12-
**CodeSizeZipped** <a name="SSS-Type-AccountLimit-CodeSizeZipped"></a>
12+
** CodeSizeZipped ** <a name="SSS-Type-AccountLimit-CodeSizeZipped"></a>
1313
The maximum size of a deployment package when it's uploaded directly to Lambda\. Use Amazon S3 for larger files\.
1414
Type: Long
1515
Required: No
1616

17-
**ConcurrentExecutions** <a name="SSS-Type-AccountLimit-ConcurrentExecutions"></a>
17+
** ConcurrentExecutions ** <a name="SSS-Type-AccountLimit-ConcurrentExecutions"></a>
1818
The maximum number of simultaneous function executions\.
1919
Type: Integer
2020
Required: No
2121

22-
**TotalCodeSize** <a name="SSS-Type-AccountLimit-TotalCodeSize"></a>
22+
** TotalCodeSize ** <a name="SSS-Type-AccountLimit-TotalCodeSize"></a>
2323
The amount of storage space that you can use for all deployment packages and layer archives\.
2424
Type: Long
2525
Required: No
2626

27-
**UnreservedConcurrentExecutions** <a name="SSS-Type-AccountLimit-UnreservedConcurrentExecutions"></a>
28-
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with [PutFunctionConcurrency](API_PutFunctionConcurrency.md)\.
27+
** UnreservedConcurrentExecutions ** <a name="SSS-Type-AccountLimit-UnreservedConcurrentExecutions"></a>
28+
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\.
2929
Type: Integer
3030
Valid Range: Minimum value of 0\.
3131
Required: No

doc_source/API_AccountUsage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ The number of functions and amount of storage in use\.
44

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

7-
**FunctionCount** <a name="SSS-Type-AccountUsage-FunctionCount"></a>
7+
** FunctionCount ** <a name="SSS-Type-AccountUsage-FunctionCount"></a>
88
The number of Lambda functions\.
99
Type: Long
1010
Required: No
1111

12-
**TotalCodeSize** <a name="SSS-Type-AccountUsage-TotalCodeSize"></a>
12+
** TotalCodeSize ** <a name="SSS-Type-AccountUsage-TotalCodeSize"></a>
1313
The amount of storage space, in bytes, that's being used by deployment packages and layer archives\.
1414
Type: Long
1515
Required: No

doc_source/API_AddLayerVersionPermission.md

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

33
Adds permissions to the resource\-based policy of a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. Use this action to grant layer usage permission to other accounts\. You can grant permission to a single account, all accounts in an organization, or all AWS accounts\.
44

5-
To revoke permission, call [RemoveLayerVersionPermission](API_RemoveLayerVersionPermission.md) with the statement ID that you specified when you added it\.
5+
To revoke permission, call [ RemoveLayerVersionPermission ](API_RemoveLayerVersionPermission.md) with the statement ID that you specified when you added it\.
66

77
## Request Syntax<a name="API_AddLayerVersionPermission_RequestSyntax"></a>
88

@@ -22,44 +22,44 @@ Content-type: application/json
2222

2323
The request uses the following URI parameters\.
2424

25-
** [LayerName](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-LayerName"></a>
25+
** [ LayerName ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-LayerName"></a>
2626
The name or Amazon Resource Name \(ARN\) of the layer\.
2727
Length Constraints: Minimum length of 1\. Maximum length of 140\.
2828
Pattern: `(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+`
2929
Required: Yes
3030

31-
** [RevisionId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-RevisionId"></a>
31+
** [ RevisionId ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-RevisionId"></a>
3232
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\.
3333

34-
** [VersionNumber](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-VersionNumber"></a>
34+
** [ VersionNumber ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-VersionNumber"></a>
3535
The version number\.
3636
Required: Yes
3737

3838
## Request Body<a name="API_AddLayerVersionPermission_RequestBody"></a>
3939

4040
The request accepts the following data in JSON format\.
4141

42-
** [Action](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Action"></a>
42+
** [ Action ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Action"></a>
4343
The API action that grants access to the layer\. For example, `lambda:GetLayerVersion`\.
4444
Type: String
4545
Length Constraints: Maximum length of 22\.
4646
Pattern: `lambda:GetLayerVersion`
4747
Required: Yes
4848

49-
** [OrganizationId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-OrganizationId"></a>
49+
** [ OrganizationId ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-OrganizationId"></a>
5050
With the principal set to `*`, grant permission to all accounts in the specified organization\.
5151
Type: String
5252
Length Constraints: Maximum length of 34\.
5353
Pattern: `o-[a-z0-9]{10,32}`
5454
Required: No
5555

56-
** [Principal](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Principal"></a>
56+
** [ Principal ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Principal"></a>
5757
An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts \(if `organizationId` is not specified\)\. For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer\.
5858
Type: String
5959
Pattern: `\d{12}|\*|arn:(aws[a-zA-Z-]*):iam::\d{12}:root`
6060
Required: Yes
6161

62-
** [StatementId](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-StatementId"></a>
62+
** [ StatementId ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-StatementId"></a>
6363
An identifier that distinguishes the policy from others on the same layer version\.
6464
Type: String
6565
Length Constraints: Minimum length of 1\. Maximum length of 100\.
@@ -84,41 +84,41 @@ If the action is successful, the service sends back an HTTP 201 response\.
8484

8585
The following data is returned in JSON format by the service\.
8686

87-
** [RevisionId](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-RevisionId"></a>
87+
** [ RevisionId ](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-RevisionId"></a>
8888
A unique identifier for the current revision of the policy\.
8989
Type: String
9090

91-
** [Statement](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-Statement"></a>
91+
** [ Statement ](#API_AddLayerVersionPermission_ResponseSyntax) ** <a name="SSS-AddLayerVersionPermission-response-Statement"></a>
9292
The permission statement\.
9393
Type: String
9494

9595
## Errors<a name="API_AddLayerVersionPermission_Errors"></a>
9696

97-
**InvalidParameterValueException**
97+
** InvalidParameterValueException **
9898
One of the parameters in the request is invalid\.
9999
HTTP Status Code: 400
100100

101-
**PolicyLengthExceededException**
101+
** PolicyLengthExceededException **
102102
The permissions policy for the resource is too large\. [Learn more](https://docs.aws.amazon.com/lambda/latest/dg/limits.html)
103103
HTTP Status Code: 400
104104

105-
**PreconditionFailedException**
105+
** PreconditionFailedException **
106106
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\.
107107
HTTP Status Code: 412
108108

109-
**ResourceConflictException**
109+
** ResourceConflictException **
110110
The resource already exists, or another operation is in progress\.
111111
HTTP Status Code: 409
112112

113-
**ResourceNotFoundException**
113+
** ResourceNotFoundException **
114114
The resource specified in the request does not exist\.
115115
HTTP Status Code: 404
116116

117-
**ServiceException**
117+
** ServiceException **
118118
The AWS Lambda service encountered an internal error\.
119119
HTTP Status Code: 500
120120

121-
**TooManyRequestsException**
121+
** TooManyRequestsException **
122122
The request throughput limit was exceeded\.
123123
HTTP Status Code: 429
124124

doc_source/API_AddPermission.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AddPermission<a name="API_AddPermission"></a>
22

3-
Grants an AWS service or another account 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\.
3+
Grants an AWS service or another account 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\.
44

55
To grant permission to another account, specify the account ID as the `Principal`\. For AWS services, the principal is a domain\-style identifier defined by the service, like `s3.amazonaws.com` or `sns.amazonaws.com`\. For AWS 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\.
66

@@ -27,7 +27,7 @@ Content-type: application/json
2727

2828
The request uses the following URI parameters\.
2929

30-
** [FunctionName](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-FunctionName"></a>
30+
** [ FunctionName ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-FunctionName"></a>
3131
The name of the Lambda function, version, or alias\.
3232

3333
**Name formats**
@@ -39,7 +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
Required: Yes
4141

42-
** [Qualifier](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Qualifier"></a>
42+
** [ Qualifier ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Qualifier"></a>
4343
Specify a version or alias to add permissions to a published version of the function\.
4444
Length Constraints: Minimum length of 1\. Maximum length of 128\.
4545
Pattern: `(|[a-zA-Z0-9$_-]+)`
@@ -48,44 +48,45 @@ Pattern: `(|[a-zA-Z0-9$_-]+)`
4848

4949
The request accepts the following data in JSON format\.
5050

51-
** [Action](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Action"></a>
51+
** [ Action ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Action"></a>
5252
The action that the principal can use on the function\. For example, `lambda:InvokeFunction` or `lambda:GetFunction`\.
5353
Type: String
5454
Pattern: `(lambda:[*]|lambda:[a-zA-Z]+|[*])`
5555
Required: Yes
5656

57-
** [EventSourceToken](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-EventSourceToken"></a>
57+
** [ EventSourceToken ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-EventSourceToken"></a>
5858
For Alexa Smart Home functions, a token that must be supplied by the invoker\.
5959
Type: String
6060
Length Constraints: Minimum length of 0\. Maximum length of 256\.
6161
Pattern: `[a-zA-Z0-9._\-]+`
6262
Required: No
6363

64-
** [Principal](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
64+
** [ Principal ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
6565
The AWS service or account that invokes the function\. If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service\.
6666
Type: String
6767
Pattern: `[^\s]+`
6868
Required: Yes
6969

70-
** [RevisionId](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-RevisionId"></a>
70+
** [ RevisionId ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-RevisionId"></a>
7171
Only update the policy 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\.
7272
Type: String
7373
Required: No
7474

75-
** [SourceAccount](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceAccount"></a>
75+
** [ SourceAccount ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceAccount"></a>
7676
For Amazon S3, the ID of the account that owns the resource\. Use this together with `SourceArn` to ensure that the resource is owned by the specified account\. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account\.
7777
Type: String
7878
Length Constraints: Maximum length of 12\.
7979
Pattern: `\d{12}`
8080
Required: No
8181

82-
** [SourceArn](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceArn"></a>
82+
** [ SourceArn ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceArn"></a>
8383
For AWS services, the ARN of the AWS resource that invokes the function\. For example, an Amazon S3 bucket or Amazon SNS topic\.
84+
Note that Lambda configures the comparison using the `StringLike` operator\.
8485
Type: String
8586
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`
8687
Required: No
8788

88-
** [StatementId](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-StatementId"></a>
89+
** [ StatementId ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-StatementId"></a>
8990
A statement identifier that differentiates the statement from others in the same policy\.
9091
Type: String
9192
Length Constraints: Minimum length of 1\. Maximum length of 100\.
@@ -109,37 +110,37 @@ If the action is successful, the service sends back an HTTP 201 response\.
109110

110111
The following data is returned in JSON format by the service\.
111112

112-
** [Statement](#API_AddPermission_ResponseSyntax) ** <a name="SSS-AddPermission-response-Statement"></a>
113+
** [ Statement ](#API_AddPermission_ResponseSyntax) ** <a name="SSS-AddPermission-response-Statement"></a>
113114
The permission statement that's added to the function policy\.
114115
Type: String
115116

116117
## Errors<a name="API_AddPermission_Errors"></a>
117118

118-
**InvalidParameterValueException**
119+
** InvalidParameterValueException **
119120
One of the parameters in the request is invalid\.
120121
HTTP Status Code: 400
121122

122-
**PolicyLengthExceededException**
123+
** PolicyLengthExceededException **
123124
The permissions policy for the resource is too large\. [Learn more](https://docs.aws.amazon.com/lambda/latest/dg/limits.html)
124125
HTTP Status Code: 400
125126

126-
**PreconditionFailedException**
127+
** PreconditionFailedException **
127128
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\.
128129
HTTP Status Code: 412
129130

130-
**ResourceConflictException**
131+
** ResourceConflictException **
131132
The resource already exists, or another operation is in progress\.
132133
HTTP Status Code: 409
133134

134-
**ResourceNotFoundException**
135+
** ResourceNotFoundException **
135136
The resource specified in the request does not exist\.
136137
HTTP Status Code: 404
137138

138-
**ServiceException**
139+
** ServiceException **
139140
The AWS Lambda service encountered an internal error\.
140141
HTTP Status Code: 500
141142

142-
**TooManyRequestsException**
143+
** TooManyRequestsException **
143144
The request throughput limit was exceeded\.
144145
HTTP Status Code: 429
145146

doc_source/API_AliasConfiguration.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,40 @@ Provides configuration information about a Lambda function [alias](https://docs.
44

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

7-
**AliasArn** <a name="SSS-Type-AliasConfiguration-AliasArn"></a>
7+
** AliasArn ** <a name="SSS-Type-AliasConfiguration-AliasArn"></a>
88
The Amazon Resource Name \(ARN\) of the alias\.
99
Type: String
1010
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

13-
**Description** <a name="SSS-Type-AliasConfiguration-Description"></a>
13+
** Description ** <a name="SSS-Type-AliasConfiguration-Description"></a>
1414
A description of the alias\.
1515
Type: String
1616
Length Constraints: Minimum length of 0\. Maximum length of 256\.
1717
Required: No
1818

19-
**FunctionVersion** <a name="SSS-Type-AliasConfiguration-FunctionVersion"></a>
19+
** FunctionVersion ** <a name="SSS-Type-AliasConfiguration-FunctionVersion"></a>
2020
The function version that the alias invokes\.
2121
Type: String
2222
Length Constraints: Minimum length of 1\. Maximum length of 1024\.
2323
Pattern: `(\$LATEST|[0-9]+)`
2424
Required: No
2525

26-
**Name** <a name="SSS-Type-AliasConfiguration-Name"></a>
26+
** Name ** <a name="SSS-Type-AliasConfiguration-Name"></a>
2727
The name of the alias\.
2828
Type: String
2929
Length Constraints: Minimum length of 1\. Maximum length of 128\.
3030
Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)`
3131
Required: No
3232

33-
**RevisionId** <a name="SSS-Type-AliasConfiguration-RevisionId"></a>
33+
** RevisionId ** <a name="SSS-Type-AliasConfiguration-RevisionId"></a>
3434
A unique identifier that changes when you update the alias\.
3535
Type: String
3636
Required: No
3737

38-
**RoutingConfig** <a name="SSS-Type-AliasConfiguration-RoutingConfig"></a>
38+
** RoutingConfig ** <a name="SSS-Type-AliasConfiguration-RoutingConfig"></a>
3939
The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias\.
40-
Type: [AliasRoutingConfiguration](API_AliasRoutingConfiguration.md) object
40+
Type: [ AliasRoutingConfiguration ](API_AliasRoutingConfiguration.md) object
4141
Required: No
4242

4343
## See Also<a name="API_AliasConfiguration_SeeAlso"></a>

doc_source/API_AliasRoutingConfiguration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The [traffic\-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traf
44

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

7-
**AdditionalVersionWeights** <a name="SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights"></a>
7+
** AdditionalVersionWeights ** <a name="SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights"></a>
88
The second version, and the percentage of traffic that's routed to it\.
99
Type: String to double map
1010
Key Length Constraints: Minimum length of 1\. Maximum length of 1024\.

doc_source/API_AllowedPublishers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ List of signing profiles that can sign a code package\.
44

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

7-
**SigningProfileVersionArns** <a name="SSS-Type-AllowedPublishers-SigningProfileVersionArns"></a>
7+
** SigningProfileVersionArns ** <a name="SSS-Type-AllowedPublishers-SigningProfileVersionArns"></a>
88
The Amazon Resource Name \(ARN\) for each of the signing profiles\. A signing profile defines a trusted user who can sign a code package\.
99
Type: Array of strings
1010
Array Members: Minimum number of 1 item\. Maximum number of 20 items\.

0 commit comments

Comments
 (0)