Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
devlinbd2 committed Sep 20, 2021
1 parent 834c24b commit c70b3a8
Show file tree
Hide file tree
Showing 203 changed files with 2,158 additions and 2,539 deletions.
12 changes: 6 additions & 6 deletions doc_source/API_AccountLimit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@ Limits that are related to concurrency and storage\. All file and storage sizes

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

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

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

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

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

**UnreservedConcurrentExecutions** <a name="SSS-Type-AccountLimit-UnreservedConcurrentExecutions"></a>
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with [PutFunctionConcurrency](API_PutFunctionConcurrency.md)\.
** UnreservedConcurrentExecutions ** <a name="SSS-Type-AccountLimit-UnreservedConcurrentExecutions"></a>
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\.
Type: Integer
Valid Range: Minimum value of 0\.
Required: No
Expand Down
4 changes: 2 additions & 2 deletions doc_source/API_AccountUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ The number of functions and amount of storage in use\.

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

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

**TotalCodeSize** <a name="SSS-Type-AccountUsage-TotalCodeSize"></a>
** TotalCodeSize ** <a name="SSS-Type-AccountUsage-TotalCodeSize"></a>
The amount of storage space, in bytes, that's being used by deployment packages and layer archives\.
Type: Long
Required: No
Expand Down
34 changes: 17 additions & 17 deletions doc_source/API_AddLayerVersionPermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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\.

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

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

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

The request uses the following URI parameters\.

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

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

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

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

The request accepts the following data in JSON format\.

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

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

** [Principal](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Principal"></a>
** [ Principal ](#API_AddLayerVersionPermission_RequestSyntax) ** <a name="SSS-AddLayerVersionPermission-request-Principal"></a>
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\.
Type: String
Pattern: `\d{12}|\*|arn:(aws[a-zA-Z-]*):iam::\d{12}:root`
Required: Yes

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

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

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

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

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

**InvalidParameterValueException**
** InvalidParameterValueException **
One of the parameters in the request is invalid\.
HTTP Status Code: 400

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

**PreconditionFailedException**
** PreconditionFailedException **
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\.
HTTP Status Code: 412

**ResourceConflictException**
** ResourceConflictException **
The resource already exists, or another operation is in progress\.
HTTP Status Code: 409

**ResourceNotFoundException**
** ResourceNotFoundException **
The resource specified in the request does not exist\.
HTTP Status Code: 404

**ServiceException**
** ServiceException **
The AWS Lambda service encountered an internal error\.
HTTP Status Code: 500

**TooManyRequestsException**
** TooManyRequestsException **
The request throughput limit was exceeded\.
HTTP Status Code: 429

Expand Down
37 changes: 19 additions & 18 deletions doc_source/API_AddPermission.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AddPermission<a name="API_AddPermission"></a>

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\.
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\.

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\.

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

The request uses the following URI parameters\.

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

**Name formats**
Expand All @@ -39,7 +39,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 140\.
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-_]+))?`
Required: Yes

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

The request accepts the following data in JSON format\.

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

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

** [Principal](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
** [ Principal ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-Principal"></a>
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\.
Type: String
Pattern: `[^\s]+`
Required: Yes

** [RevisionId](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-RevisionId"></a>
** [ RevisionId ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-RevisionId"></a>
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\.
Type: String
Required: No

** [SourceAccount](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceAccount"></a>
** [ SourceAccount ](#API_AddPermission_RequestSyntax) ** <a name="SSS-AddPermission-request-SourceAccount"></a>
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\.
Type: String
Length Constraints: Maximum length of 12\.
Pattern: `\d{12}`
Required: No

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

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

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

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

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

**InvalidParameterValueException**
** InvalidParameterValueException **
One of the parameters in the request is invalid\.
HTTP Status Code: 400

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

**PreconditionFailedException**
** PreconditionFailedException **
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\.
HTTP Status Code: 412

**ResourceConflictException**
** ResourceConflictException **
The resource already exists, or another operation is in progress\.
HTTP Status Code: 409

**ResourceNotFoundException**
** ResourceNotFoundException **
The resource specified in the request does not exist\.
HTTP Status Code: 404

**ServiceException**
** ServiceException **
The AWS Lambda service encountered an internal error\.
HTTP Status Code: 500

**TooManyRequestsException**
** TooManyRequestsException **
The request throughput limit was exceeded\.
HTTP Status Code: 429

Expand Down
14 changes: 7 additions & 7 deletions doc_source/API_AliasConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,40 @@ Provides configuration information about a Lambda function [alias](https://docs.

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

**AliasArn** <a name="SSS-Type-AliasConfiguration-AliasArn"></a>
** AliasArn ** <a name="SSS-Type-AliasConfiguration-AliasArn"></a>
The Amazon Resource Name \(ARN\) of the alias\.
Type: String
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-_]+))?`
Required: No

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

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

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

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

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

## See Also<a name="API_AliasConfiguration_SeeAlso"></a>
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_AliasRoutingConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The [traffic\-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traf

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

**AdditionalVersionWeights** <a name="SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights"></a>
** AdditionalVersionWeights ** <a name="SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights"></a>
The second version, and the percentage of traffic that's routed to it\.
Type: String to double map
Key Length Constraints: Minimum length of 1\. Maximum length of 1024\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_AllowedPublishers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List of signing profiles that can sign a code package\.

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

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

0 comments on commit c70b3a8

Please sign in to comment.