diff --git a/doc_source/API_AccountLimit.md b/doc_source/API_AccountLimit.md old mode 100644 new mode 100755 index 8f1ca0c8..24a89f4d --- a/doc_source/API_AccountLimit.md +++ b/doc_source/API_AccountLimit.md @@ -25,7 +25,7 @@ Type: Long Required: No ** UnreservedConcurrentExecutions ** -The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\. +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 @@ -33,7 +33,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AccountLimit) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AccountLimit) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AccountLimit) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AccountLimit) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AccountLimit) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AccountLimit) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AccountLimit) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AccountLimit) \ No newline at end of file diff --git a/doc_source/API_AccountUsage.md b/doc_source/API_AccountUsage.md old mode 100644 new mode 100755 index d316b7b8..5717c170 --- a/doc_source/API_AccountUsage.md +++ b/doc_source/API_AccountUsage.md @@ -17,7 +17,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AccountUsage) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AccountUsage) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AccountUsage) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AccountUsage) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AccountUsage) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AccountUsage) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AccountUsage) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AccountUsage) \ No newline at end of file diff --git a/doc_source/API_AddLayerVersionPermission.md b/doc_source/API_AddLayerVersionPermission.md old mode 100644 new mode 100755 index f06b3e02..1ee2de37 --- a/doc_source/API_AddLayerVersionPermission.md +++ b/doc_source/API_AddLayerVersionPermission.md @@ -1,8 +1,8 @@ # AddLayerVersionPermission -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\. +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 @@ -22,16 +22,16 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ LayerName ](#API_AddLayerVersionPermission_RequestSyntax) ** + ** [LayerName](#API_AddLayerVersionPermission_RequestSyntax) ** 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) ** + ** [RevisionId](#API_AddLayerVersionPermission_RequestSyntax) ** 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) ** + ** [VersionNumber](#API_AddLayerVersionPermission_RequestSyntax) ** The version number\. Required: Yes @@ -39,27 +39,27 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ Action ](#API_AddLayerVersionPermission_RequestSyntax) ** + ** [Action](#API_AddLayerVersionPermission_RequestSyntax) ** 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) ** + ** [OrganizationId](#API_AddLayerVersionPermission_RequestSyntax) ** 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) ** + ** [Principal](#API_AddLayerVersionPermission_RequestSyntax) ** 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) ** + ** [StatementId](#API_AddLayerVersionPermission_RequestSyntax) ** 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\. @@ -84,11 +84,11 @@ 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) ** + ** [RevisionId](#API_AddLayerVersionPermission_ResponseSyntax) ** A unique identifier for the current revision of the policy\. Type: String - ** [ Statement ](#API_AddLayerVersionPermission_ResponseSyntax) ** + ** [Statement](#API_AddLayerVersionPermission_ResponseSyntax) ** The permission statement\. Type: String @@ -125,12 +125,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/AddLayerVersionPermission) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AddLayerVersionPermission) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/AddLayerVersionPermission) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AddLayerVersionPermission) \ No newline at end of file diff --git a/doc_source/API_AddPermission.md b/doc_source/API_AddPermission.md old mode 100644 new mode 100755 index 4889c9d4..17759770 --- a/doc_source/API_AddPermission.md +++ b/doc_source/API_AddPermission.md @@ -27,7 +27,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_AddPermission_RequestSyntax) ** + ** [FunctionName](#API_AddPermission_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -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) ** + ** [Qualifier](#API_AddPermission_RequestSyntax) ** 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$_-]+)` @@ -48,45 +48,45 @@ Pattern: `(|[a-zA-Z0-9$_-]+)` The request accepts the following data in JSON format\. - ** [ Action ](#API_AddPermission_RequestSyntax) ** + ** [Action](#API_AddPermission_RequestSyntax) ** 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) ** + ** [EventSourceToken](#API_AddPermission_RequestSyntax) ** 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) ** + ** [Principal](#API_AddPermission_RequestSyntax) ** 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) ** + ** [RevisionId](#API_AddPermission_RequestSyntax) ** 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) ** + ** [SourceAccount](#API_AddPermission_RequestSyntax) ** 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) ** + ** [SourceArn](#API_AddPermission_RequestSyntax) ** 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) ** + ** [StatementId](#API_AddPermission_RequestSyntax) ** 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\. @@ -110,7 +110,7 @@ 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) ** + ** [Statement](#API_AddPermission_ResponseSyntax) ** The permission statement that's added to the function policy\. Type: String @@ -147,12 +147,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/AddPermission) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AddPermission) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/AddPermission) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/AddPermission) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AddPermission) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AddPermission) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AddPermission) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/AddPermission) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/AddPermission) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/AddPermission) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AddPermission) \ No newline at end of file diff --git a/doc_source/API_AliasConfiguration.md b/doc_source/API_AliasConfiguration.md old mode 100644 new mode 100755 index 13d6487b..b6aa0d1b --- a/doc_source/API_AliasConfiguration.md +++ b/doc_source/API_AliasConfiguration.md @@ -37,13 +37,13 @@ Required: No ** RoutingConfig ** 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 For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AliasConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AliasConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AliasConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AliasConfiguration) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AliasConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AliasConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AliasConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AliasConfiguration) \ No newline at end of file diff --git a/doc_source/API_AliasRoutingConfiguration.md b/doc_source/API_AliasRoutingConfiguration.md old mode 100644 new mode 100755 index 8eab8c2a..c2c4021b --- a/doc_source/API_AliasRoutingConfiguration.md +++ b/doc_source/API_AliasRoutingConfiguration.md @@ -15,7 +15,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AliasRoutingConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AliasRoutingConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AliasRoutingConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AliasRoutingConfiguration) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AliasRoutingConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AliasRoutingConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AliasRoutingConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AliasRoutingConfiguration) \ No newline at end of file diff --git a/doc_source/API_AllowedPublishers.md b/doc_source/API_AllowedPublishers.md old mode 100644 new mode 100755 index 1060d3b2..498de6b5 --- a/doc_source/API_AllowedPublishers.md +++ b/doc_source/API_AllowedPublishers.md @@ -14,7 +14,7 @@ Required: Yes ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AllowedPublishers) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AllowedPublishers) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AllowedPublishers) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AllowedPublishers) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/AllowedPublishers) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/AllowedPublishers) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/AllowedPublishers) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/AllowedPublishers) \ No newline at end of file diff --git a/doc_source/API_CodeSigningConfig.md b/doc_source/API_CodeSigningConfig.md old mode 100644 new mode 100755 index 10c2381f..99a1c44d --- a/doc_source/API_CodeSigningConfig.md +++ b/doc_source/API_CodeSigningConfig.md @@ -6,7 +6,7 @@ Details about a [Code signing configuration](https://docs.aws.amazon.com/lambda/ ** AllowedPublishers ** List of allowed publishers\. -Type: [ AllowedPublishers ](API_AllowedPublishers.md) object +Type: [AllowedPublishers](API_AllowedPublishers.md) object Required: Yes ** CodeSigningConfigArn ** @@ -24,7 +24,7 @@ Required: Yes ** CodeSigningPolicies ** The code signing policy controls the validation failure action for signature mismatch or expiry\. -Type: [ CodeSigningPolicies ](API_CodeSigningPolicies.md) object +Type: [CodeSigningPolicies](API_CodeSigningPolicies.md) object Required: Yes ** Description ** @@ -41,7 +41,7 @@ Required: Yes ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CodeSigningConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_CodeSigningPolicies.md b/doc_source/API_CodeSigningPolicies.md old mode 100644 new mode 100755 index fdeb3b45..6ce8eb1a --- a/doc_source/API_CodeSigningPolicies.md +++ b/doc_source/API_CodeSigningPolicies.md @@ -14,7 +14,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CodeSigningPolicies) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CodeSigningPolicies) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CodeSigningPolicies) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CodeSigningPolicies) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CodeSigningPolicies) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CodeSigningPolicies) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CodeSigningPolicies) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CodeSigningPolicies) \ No newline at end of file diff --git a/doc_source/API_Concurrency.md b/doc_source/API_Concurrency.md old mode 100644 new mode 100755 index b9c53c9d..f555752a --- a/doc_source/API_Concurrency.md +++ b/doc_source/API_Concurrency.md @@ -11,7 +11,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Concurrency) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Concurrency) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Concurrency) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Concurrency) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Concurrency) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Concurrency) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Concurrency) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Concurrency) \ No newline at end of file diff --git a/doc_source/API_CreateAlias.md b/doc_source/API_CreateAlias.md old mode 100644 new mode 100755 index 710f21c9..328a580c --- a/doc_source/API_CreateAlias.md +++ b/doc_source/API_CreateAlias.md @@ -26,7 +26,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_CreateAlias_RequestSyntax) ** + ** [FunctionName](#API_CreateAlias_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -42,29 +42,29 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ Description ](#API_CreateAlias_RequestSyntax) ** + ** [Description](#API_CreateAlias_RequestSyntax) ** A description of the alias\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ FunctionVersion ](#API_CreateAlias_RequestSyntax) ** + ** [FunctionVersion](#API_CreateAlias_RequestSyntax) ** The function version that the alias invokes\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` Required: Yes - ** [ Name ](#API_CreateAlias_RequestSyntax) ** + ** [Name](#API_CreateAlias_RequestSyntax) ** 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: Yes - ** [ RoutingConfig ](#API_CreateAlias_RequestSyntax) ** + ** [RoutingConfig](#API_CreateAlias_RequestSyntax) ** The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) of the alias\. -Type: [ AliasRoutingConfiguration ](API_AliasRoutingConfiguration.md) object +Type: [AliasRoutingConfiguration](API_AliasRoutingConfiguration.md) object Required: No ## Response Syntax @@ -93,35 +93,35 @@ If the action is successful, the service sends back an HTTP 201 response\. The following data is returned in JSON format by the service\. - ** [ AliasArn ](#API_CreateAlias_ResponseSyntax) ** + ** [AliasArn](#API_CreateAlias_ResponseSyntax) ** 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-_]+))?` - ** [ Description ](#API_CreateAlias_ResponseSyntax) ** + ** [Description](#API_CreateAlias_ResponseSyntax) ** A description of the alias\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ FunctionVersion ](#API_CreateAlias_ResponseSyntax) ** + ** [FunctionVersion](#API_CreateAlias_ResponseSyntax) ** The function version that the alias invokes\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ Name ](#API_CreateAlias_ResponseSyntax) ** + ** [Name](#API_CreateAlias_ResponseSyntax) ** The name of the alias\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` - ** [ RevisionId ](#API_CreateAlias_ResponseSyntax) ** + ** [RevisionId](#API_CreateAlias_ResponseSyntax) ** A unique identifier that changes when you update the alias\. Type: String - ** [ RoutingConfig ](#API_CreateAlias_ResponseSyntax) ** + ** [RoutingConfig](#API_CreateAlias_ResponseSyntax) ** 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 ## Errors @@ -148,12 +148,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateAlias) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateAlias) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateAlias) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateAlias) \ No newline at end of file diff --git a/doc_source/API_CreateCodeSigningConfig.md b/doc_source/API_CreateCodeSigningConfig.md old mode 100644 new mode 100755 index eaa6639a..399ed29b --- a/doc_source/API_CreateCodeSigningConfig.md +++ b/doc_source/API_CreateCodeSigningConfig.md @@ -27,17 +27,17 @@ The request does not use any URI parameters\. The request accepts the following data in JSON format\. - ** [ AllowedPublishers ](#API_CreateCodeSigningConfig_RequestSyntax) ** + ** [AllowedPublishers](#API_CreateCodeSigningConfig_RequestSyntax) ** Signing profiles for this code signing configuration\. -Type: [ AllowedPublishers ](API_AllowedPublishers.md) object +Type: [AllowedPublishers](API_AllowedPublishers.md) object Required: Yes - ** [ CodeSigningPolicies ](#API_CreateCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningPolicies](#API_CreateCodeSigningConfig_RequestSyntax) ** The code signing policies define the actions to take if the validation checks fail\. -Type: [ CodeSigningPolicies ](API_CodeSigningPolicies.md) object +Type: [CodeSigningPolicies](API_CodeSigningPolicies.md) object Required: No - ** [ Description ](#API_CreateCodeSigningConfig_RequestSyntax) ** + ** [Description](#API_CreateCodeSigningConfig_RequestSyntax) ** Descriptive name for this code signing configuration\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. @@ -71,9 +71,9 @@ If the action is successful, the service sends back an HTTP 201 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfig ](#API_CreateCodeSigningConfig_ResponseSyntax) ** + ** [CodeSigningConfig](#API_CreateCodeSigningConfig_ResponseSyntax) ** The code signing configuration\. -Type: [ CodeSigningConfig ](API_CodeSigningConfig.md) object +Type: [CodeSigningConfig](API_CodeSigningConfig.md) object ## Errors @@ -88,12 +88,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_CreateEventSourceMapping.md b/doc_source/API_CreateEventSourceMapping.md old mode 100644 new mode 100755 index 1e63ae7f..e24d8261 --- a/doc_source/API_CreateEventSourceMapping.md +++ b/doc_source/API_CreateEventSourceMapping.md @@ -44,6 +44,13 @@ Content-type: application/json }, "Enabled": boolean, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionName": "string", "FunctionResponseTypes": [ "string" ], "MaximumBatchingWindowInSeconds": number, @@ -77,7 +84,7 @@ The request does not use any URI parameters\. The request accepts the following data in JSON format\. - ** [ BatchSize ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [BatchSize](#API_CreateEventSourceMapping_RequestSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. + **Amazon Kinesis** \- Default 100\. Max 10,000\. + **Amazon DynamoDB Streams** \- Default 100\. Max 1,000\. @@ -89,23 +96,23 @@ Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. Required: No - ** [ BisectBatchOnFunctionError ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [BisectBatchOnFunctionError](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. Type: Boolean Required: No - ** [ DestinationConfig ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [DestinationConfig](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No - ** [ Enabled ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [Enabled](#API_CreateEventSourceMapping_RequestSyntax) ** When true, the event source mapping is active\. When false, Lambda pauses polling and invocation\. Default: True Type: Boolean Required: No - ** [ EventSourceArn ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [EventSourceArn](#API_CreateEventSourceMapping_RequestSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. + **Amazon Kinesis** \- The ARN of the data stream or a stream consumer\. + **Amazon DynamoDB Streams** \- The ARN of the stream\. @@ -115,7 +122,12 @@ 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 - ** [ FunctionName ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [FilterCriteria](#API_CreateEventSourceMapping_RequestSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object +Required: No + + ** [FunctionName](#API_CreateEventSourceMapping_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -129,14 +141,14 @@ 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 - ** [ FunctionResponseTypes ](#API_CreateEventSourceMapping_RequestSyntax) ** -\(Streams only\) A list of current response type enums applied to the event source mapping\. + ** [FunctionResponseTypes](#API_CreateEventSourceMapping_RequestSyntax) ** +\(Streams and Amazon SQS\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` Required: No - ** [ MaximumBatchingWindowInSeconds ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. @@ -144,25 +156,25 @@ Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. Required: No - ** [ MaximumRecordAgeInSeconds ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is infinite \(\-1\)\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. Required: No - ** [ MaximumRetryAttempts ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [MaximumRetryAttempts](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is infinite \(\-1\)\. When set to infinite \(\-1\), failed records will be retried until the record expires\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. Required: No - ** [ ParallelizationFactor ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [ParallelizationFactor](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) The number of batches to process from each shard concurrently\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. Required: No - ** [ Queues ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [Queues](#API_CreateEventSourceMapping_RequestSyntax) ** \(MQ\) The name of the Amazon MQ broker destination queue to consume\. Type: Array of strings Array Members: Fixed number of 1 item\. @@ -170,29 +182,29 @@ Length Constraints: Minimum length of 1\. Maximum length of 1000\. Pattern: `[\s\S]*` Required: No - ** [ SelfManagedEventSource ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [SelfManagedEventSource](#API_CreateEventSourceMapping_RequestSyntax) ** The Self\-Managed Apache Kafka cluster to send records\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object Required: No - ** [ SourceAccessConfigurations ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [SourceAccessConfigurations](#API_CreateEventSourceMapping_RequestSyntax) ** An array of authentication protocols or VPC components required to secure your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. Required: No - ** [ StartingPosition ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [StartingPosition](#API_CreateEventSourceMapping_RequestSyntax) ** The position in a stream from which to start reading\. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources\. `AT_TIMESTAMP` is only supported for Amazon Kinesis streams\. Type: String Valid Values:` TRIM_HORIZON | LATEST | AT_TIMESTAMP` Required: No - ** [ StartingPositionTimestamp ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [StartingPositionTimestamp](#API_CreateEventSourceMapping_RequestSyntax) ** With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\. Type: Timestamp Required: No - ** [ Topics ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [Topics](#API_CreateEventSourceMapping_RequestSyntax) ** The name of the Kafka topic\. Type: Array of strings Array Members: Fixed number of 1 item\. @@ -200,7 +212,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 249\. Pattern: `^[^.]([a-zA-Z0-9\-_.]+)` Required: No - ** [ TumblingWindowInSeconds ](#API_CreateEventSourceMapping_RequestSyntax) ** + ** [TumblingWindowInSeconds](#API_CreateEventSourceMapping_RequestSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is between 1 second up to 900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. @@ -224,6 +236,13 @@ Content-type: application/json } }, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionArn": "string", "FunctionResponseTypes": [ "string" ], "LastModified": number, @@ -260,113 +279,117 @@ If the action is successful, the service sends back an HTTP 202 response\. The following data is returned in JSON format by the service\. - ** [ BatchSize ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [BatchSize](#API_CreateEventSourceMapping_ResponseSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. Default value: Varies by service\. For Amazon SQS, the default is 10\. For all other services, the default is 100\. Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. - ** [ BisectBatchOnFunctionError ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [BisectBatchOnFunctionError](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. The default value is false\. Type: Boolean - ** [ DestinationConfig ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [DestinationConfig](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ EventSourceArn ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [EventSourceArn](#API_CreateEventSourceMapping_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ FunctionArn ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [FilterCriteria](#API_CreateEventSourceMapping_ResponseSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object + + ** [FunctionArn](#API_CreateEventSourceMapping_ResponseSyntax) ** The ARN of the Lambda function\. 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-_]+))?` - ** [ FunctionResponseTypes ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [FunctionResponseTypes](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` - ** [ LastModified ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [LastModified](#API_CreateEventSourceMapping_ResponseSyntax) ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds\. Type: Timestamp - ** [ LastProcessingResult ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [LastProcessingResult](#API_CreateEventSourceMapping_ResponseSyntax) ** The result of the last Lambda invocation of your function\. Type: String - ** [ MaximumBatchingWindowInSeconds ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. - ** [ MaximumRecordAgeInSeconds ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is \-1, which sets the maximum age to infinite\. When the value is set to infinite, Lambda never discards old records\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. - ** [ MaximumRetryAttempts ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is \-1, which sets the maximum number of retries to infinite\. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. - ** [ ParallelizationFactor ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [ParallelizationFactor](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) The number of batches to process concurrently from each shard\. The default value is 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. - ** [ Queues ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [Queues](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Amazon MQ\) The name of the Amazon MQ broker destination queue to consume\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 1000\. Pattern: `[\s\S]*` - ** [ SelfManagedEventSource ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [SelfManagedEventSource](#API_CreateEventSourceMapping_ResponseSyntax) ** The self\-managed Apache Kafka cluster for your event source\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object - ** [ SourceAccessConfigurations ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [SourceAccessConfigurations](#API_CreateEventSourceMapping_ResponseSyntax) ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. - ** [ StartingPosition ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [StartingPosition](#API_CreateEventSourceMapping_ResponseSyntax) ** The position in a stream from which to start reading\. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources\. `AT_TIMESTAMP` is supported only for Amazon Kinesis streams\. Type: String Valid Values:` TRIM_HORIZON | LATEST | AT_TIMESTAMP` - ** [ StartingPositionTimestamp ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [StartingPositionTimestamp](#API_CreateEventSourceMapping_ResponseSyntax) ** With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\. Type: Timestamp - ** [ State ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [State](#API_CreateEventSourceMapping_ResponseSyntax) ** The state of the event source mapping\. It can be one of the following: `Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`\. Type: String - ** [ StateTransitionReason ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [StateTransitionReason](#API_CreateEventSourceMapping_ResponseSyntax) ** Indicates whether a user or Lambda made the last change to the event source mapping\. Type: String - ** [ Topics ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [Topics](#API_CreateEventSourceMapping_ResponseSyntax) ** The name of the Kafka topic\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 249\. Pattern: `^[^.]([a-zA-Z0-9\-_.]+)` - ** [ TumblingWindowInSeconds ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [TumblingWindowInSeconds](#API_CreateEventSourceMapping_ResponseSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is 1–900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. - ** [ UUID ](#API_CreateEventSourceMapping_ResponseSyntax) ** + ** [UUID](#API_CreateEventSourceMapping_ResponseSyntax) ** The identifier of the event source mapping\. Type: String @@ -395,12 +418,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateEventSourceMapping) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateEventSourceMapping) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateEventSourceMapping) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateEventSourceMapping) \ No newline at end of file diff --git a/doc_source/API_CreateFunction.md b/doc_source/API_CreateFunction.md old mode 100644 new mode 100755 index b2cbf94b..ac3dcc1f --- a/doc_source/API_CreateFunction.md +++ b/doc_source/API_CreateFunction.md @@ -6,17 +6,17 @@ You set the package type to `Image` if the deployment package is a [container im You set the package type to `Zip` if the deployment package is a [\.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip)\. For a \.zip file archive, the code property specifies the location of the \.zip file\. You must also specify the handler and runtime properties\. The code in the deployment package must be compatible with the target instruction set architecture of the function \(`x86-64` or `arm64`\)\. If you do not specify the architecture, the default value is `x86-64`\. -When you create a function, Lambda provisions an instance of the function and its supporting resources\. If your function connects to a VPC, this process can take a minute or so\. During this time, you can't invoke or modify the function\. The `State`, `StateReason`, and `StateReasonCode` fields in the response from [ GetFunctionConfiguration ](API_GetFunctionConfiguration.md) indicate when the function is ready to invoke\. For more information, see [Function States](https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html)\. +When you create a function, Lambda provisions an instance of the function and its supporting resources\. If your function connects to a VPC, this process can take a minute or so\. During this time, you can't invoke or modify the function\. The `State`, `StateReason`, and `StateReasonCode` fields in the response from [GetFunctionConfiguration](API_GetFunctionConfiguration.md) indicate when the function is ready to invoke\. For more information, see [Function States](https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html)\. A function has an unpublished version, and can have published versions and aliases\. The unpublished version changes when you update your function's code and configuration\. A published version is a snapshot of your function code and configuration that can't be changed\. An alias is a named resource that maps to a version, and can be changed to map to a different version\. Use the `Publish` parameter to create version `1` of your function from its initial configuration\. -The other parameters let you configure version\-specific and function\-level settings\. You can modify version\-specific settings later with [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md)\. Function\-level settings apply to both the unpublished and published versions of the function, and include tags \([ TagResource ](API_TagResource.md)\) and per\-function concurrency limits \([ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\)\. +The other parameters let you configure version\-specific and function\-level settings\. You can modify version\-specific settings later with [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md)\. Function\-level settings apply to both the unpublished and published versions of the function, and include tags \([TagResource](API_TagResource.md)\) and per\-function concurrency limits \([PutFunctionConcurrency](API_PutFunctionConcurrency.md)\)\. -You can use code signing if your deployment package is a \.zip file archive\. To enable code signing for this function, specify the ARN of a code\-signing configuration\. When a user attempts to deploy a code package with [ UpdateFunctionCode ](API_UpdateFunctionCode.md), Lambda checks that the code package has a valid signature from a trusted publisher\. The code\-signing configuration includes set set of signing profiles, which define the trusted publishers for this function\. +You can use code signing if your deployment package is a \.zip file archive\. To enable code signing for this function, specify the ARN of a code\-signing configuration\. When a user attempts to deploy a code package with [UpdateFunctionCode](API_UpdateFunctionCode.md), Lambda checks that the code package has a valid signature from a trusted publisher\. The code\-signing configuration includes set set of signing profiles, which define the trusted publishers for this function\. -If another account or an AWS service invokes your function, use [ AddPermission ](API_AddPermission.md) to grant permission by creating a resource\-based IAM policy\. You can grant permissions at the function level, on a version, or on an alias\. +If another account or an AWS service invokes your function, use [AddPermission](API_AddPermission.md) to grant permission by creating a resource\-based IAM policy\. You can grant permissions at the function level, on a version, or on an alias\. -To invoke your function directly, use [ Invoke ](API_Invoke.md)\. To invoke your function in response to events in other AWS services, create an event source mapping \([ CreateEventSourceMapping ](API_CreateEventSourceMapping.md)\), or configure a function trigger in the other service\. For more information, see [Invoking Functions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html)\. +To invoke your function directly, use [Invoke](API_Invoke.md)\. To invoke your function in response to events in other AWS services, create an event source mapping \([CreateEventSourceMapping](API_CreateEventSourceMapping.md)\), or configure a function trigger in the other service\. For more information, see [Invoking Functions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html)\. ## Request Syntax @@ -85,48 +85,48 @@ The request does not use any URI parameters\. The request accepts the following data in JSON format\. - ** [ Architectures ](#API_CreateFunction_RequestSyntax) ** + ** [Architectures](#API_CreateFunction_RequestSyntax) ** The instruction set architecture that the function supports\. Enter a string array with one of the valid values \(arm64 or x86\_64\)\. The default value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` Required: No - ** [ Code ](#API_CreateFunction_RequestSyntax) ** + ** [Code](#API_CreateFunction_RequestSyntax) ** The code for the function\. -Type: [ FunctionCode ](API_FunctionCode.md) object +Type: [FunctionCode](API_FunctionCode.md) object Required: Yes - ** [ CodeSigningConfigArn ](#API_CreateFunction_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_CreateFunction_RequestSyntax) ** To enable code signing for this function, specify the ARN of a code\-signing configuration\. A code\-signing configuration includes a set of signing profiles, which define the trusted publishers for this function\. Type: String Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` Required: No - ** [ DeadLetterConfig ](#API_CreateFunction_RequestSyntax) ** + ** [DeadLetterConfig](#API_CreateFunction_RequestSyntax) ** A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing\. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq)\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object Required: No - ** [ Description ](#API_CreateFunction_RequestSyntax) ** + ** [Description](#API_CreateFunction_RequestSyntax) ** A description of the function\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ Environment ](#API_CreateFunction_RequestSyntax) ** + ** [Environment](#API_CreateFunction_RequestSyntax) ** Environment variables that are accessible from function code during execution\. -Type: [ Environment ](API_Environment.md) object +Type: [Environment](API_Environment.md) object Required: No - ** [ FileSystemConfigs ](#API_CreateFunction_RequestSyntax) ** + ** [FileSystemConfigs](#API_CreateFunction_RequestSyntax) ** Connection settings for an Amazon EFS file system\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. Required: No - ** [ FunctionName ](#API_CreateFunction_RequestSyntax) ** + ** [FunctionName](#API_CreateFunction_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -139,79 +139,79 @@ 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 - ** [ Handler ](#API_CreateFunction_RequestSyntax) ** -The name of the method within your code that Lambda calls to execute your function\. The format includes the file name\. It can also include namespaces and other qualifiers, depending on the runtime\. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html)\. + ** [Handler](#API_CreateFunction_RequestSyntax) ** +The name of the method within your code that Lambda calls to execute your function\. Handler is required if the deployment package is a \.zip file archive\. The format includes the file name\. It can also include namespaces and other qualifiers, depending on the runtime\. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html)\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` Required: No - ** [ ImageConfig ](#API_CreateFunction_RequestSyntax) ** + ** [ImageConfig](#API_CreateFunction_RequestSyntax) ** Container image [configuration values](https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) that override the values in the container image Dockerfile\. -Type: [ ImageConfig ](API_ImageConfig.md) object +Type: [ImageConfig](API_ImageConfig.md) object Required: No - ** [ KMSKeyArn ](#API_CreateFunction_RequestSyntax) ** + ** [KMSKeyArn](#API_CreateFunction_RequestSyntax) ** The ARN of the AWS Key Management Service \(AWS KMS\) key that's used to encrypt your function's environment variables\. If it's not provided, AWS Lambda uses a default service key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` Required: No - ** [ Layers ](#API_CreateFunction_RequestSyntax) ** + ** [Layers](#API_CreateFunction_RequestSyntax) ** A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment\. Specify each layer by its ARN, including the version\. Type: Array of strings 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-_]+:[0-9]+` Required: No - ** [ MemorySize ](#API_CreateFunction_RequestSyntax) ** + ** [MemorySize](#API_CreateFunction_RequestSyntax) ** The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime\. Increasing the function memory also increases its CPU allocation\. The default value is 128 MB\. The value can be any multiple of 1 MB\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. Required: No - ** [ PackageType ](#API_CreateFunction_RequestSyntax) ** + ** [PackageType](#API_CreateFunction_RequestSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for ZIP archive\. Type: String Valid Values:` Zip | Image` Required: No - ** [ Publish ](#API_CreateFunction_RequestSyntax) ** + ** [Publish](#API_CreateFunction_RequestSyntax) ** Set to true to publish the first version of the function during creation\. Type: Boolean Required: No - ** [ Role ](#API_CreateFunction_RequestSyntax) ** + ** [Role](#API_CreateFunction_RequestSyntax) ** The Amazon Resource Name \(ARN\) of the function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes - ** [ Runtime ](#API_CreateFunction_RequestSyntax) ** -The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. + ** [Runtime](#API_CreateFunction_RequestSyntax) ** +The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. Runtime is required if the deployment package is a \.zip file archive\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` Required: No - ** [ Tags ](#API_CreateFunction_RequestSyntax) ** + ** [Tags](#API_CreateFunction_RequestSyntax) ** A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function\. Type: String to string map Required: No - ** [ Timeout ](#API_CreateFunction_RequestSyntax) ** + ** [Timeout](#API_CreateFunction_RequestSyntax) ** The amount of time \(in seconds\) that Lambda allows a function to run before stopping it\. The default is 3 seconds\. The maximum allowed value is 900 seconds\. For additional information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)\. Type: Integer Valid Range: Minimum value of 1\. Required: No - ** [ TracingConfig ](#API_CreateFunction_RequestSyntax) ** + ** [TracingConfig](#API_CreateFunction_RequestSyntax) ** Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X\-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)\. -Type: [ TracingConfig ](API_TracingConfig.md) object +Type: [TracingConfig](API_TracingConfig.md) object Required: No - ** [ VpcConfig ](#API_CreateFunction_RequestSyntax) ** + ** [VpcConfig](#API_CreateFunction_RequestSyntax) ** For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC\. When you connect a function to a VPC, it can only access resources and the internet through that VPC\. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)\. -Type: [ VpcConfig ](API_VpcConfig.md) object +Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax @@ -300,157 +300,157 @@ If the action is successful, the service sends back an HTTP 201 response\. The following data is returned in JSON format by the service\. - ** [ Architectures ](#API_CreateFunction_ResponseSyntax) ** + ** [Architectures](#API_CreateFunction_ResponseSyntax) ** The instruction set architecture that the function supports\. Architecture is a string array with one of the valid values\. The default architecture value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` - ** [ CodeSha256 ](#API_CreateFunction_ResponseSyntax) ** + ** [CodeSha256](#API_CreateFunction_ResponseSyntax) ** The SHA256 hash of the function's deployment package\. Type: String - ** [ CodeSize ](#API_CreateFunction_ResponseSyntax) ** + ** [CodeSize](#API_CreateFunction_ResponseSyntax) ** The size of the function's deployment package, in bytes\. Type: Long - ** [ DeadLetterConfig ](#API_CreateFunction_ResponseSyntax) ** + ** [DeadLetterConfig](#API_CreateFunction_ResponseSyntax) ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object - ** [ Description ](#API_CreateFunction_ResponseSyntax) ** + ** [Description](#API_CreateFunction_ResponseSyntax) ** The function's description\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ Environment ](#API_CreateFunction_ResponseSyntax) ** + ** [Environment](#API_CreateFunction_ResponseSyntax) ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object - ** [ FileSystemConfigs ](#API_CreateFunction_ResponseSyntax) ** + ** [FileSystemConfigs](#API_CreateFunction_ResponseSyntax) ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. - ** [ FunctionArn ](#API_CreateFunction_ResponseSyntax) ** + ** [FunctionArn](#API_CreateFunction_ResponseSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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-_]+))?` - ** [ FunctionName ](#API_CreateFunction_ResponseSyntax) ** + ** [FunctionName](#API_CreateFunction_ResponseSyntax) ** The name of the function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 170\. 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-_]+))?` - ** [ Handler ](#API_CreateFunction_ResponseSyntax) ** + ** [Handler](#API_CreateFunction_ResponseSyntax) ** The function that Lambda calls to begin executing your function\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` - ** [ ImageConfigResponse ](#API_CreateFunction_ResponseSyntax) ** + ** [ImageConfigResponse](#API_CreateFunction_ResponseSyntax) ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object - ** [ KMSKeyArn ](#API_CreateFunction_ResponseSyntax) ** + ** [KMSKeyArn](#API_CreateFunction_ResponseSyntax) ** The AWS KMS key that's used to encrypt the function's environment variables\. This key is only returned if you've configured a customer managed key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` - ** [ LastModified ](#API_CreateFunction_ResponseSyntax) ** + ** [LastModified](#API_CreateFunction_ResponseSyntax) ** The date and time that the function was last updated, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ LastUpdateStatus ](#API_CreateFunction_ResponseSyntax) ** + ** [LastUpdateStatus](#API_CreateFunction_ResponseSyntax) ** The status of the last update that was performed on the function\. This is first set to `Successful` after function creation completes\. Type: String Valid Values:` Successful | Failed | InProgress` - ** [ LastUpdateStatusReason ](#API_CreateFunction_ResponseSyntax) ** + ** [LastUpdateStatusReason](#API_CreateFunction_ResponseSyntax) ** The reason for the last update that was performed on the function\. Type: String - ** [ LastUpdateStatusReasonCode ](#API_CreateFunction_ResponseSyntax) ** + ** [LastUpdateStatusReasonCode](#API_CreateFunction_ResponseSyntax) ** The reason code for the last update that was performed on the function\. Type: String Valid Values:` EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Layers ](#API_CreateFunction_ResponseSyntax) ** + ** [Layers](#API_CreateFunction_ResponseSyntax) ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects - ** [ MasterArn ](#API_CreateFunction_ResponseSyntax) ** + ** [MasterArn](#API_CreateFunction_ResponseSyntax) ** For Lambda@Edge functions, the ARN of the main function\. 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-_]+))?` - ** [ MemorySize ](#API_CreateFunction_ResponseSyntax) ** + ** [MemorySize](#API_CreateFunction_ResponseSyntax) ** The amount of memory available to the function at runtime\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. - ** [ PackageType ](#API_CreateFunction_ResponseSyntax) ** + ** [PackageType](#API_CreateFunction_ResponseSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for \.zip file archive\. Type: String Valid Values:` Zip | Image` - ** [ RevisionId ](#API_CreateFunction_ResponseSyntax) ** + ** [RevisionId](#API_CreateFunction_ResponseSyntax) ** The latest updated revision of the function or alias\. Type: String - ** [ Role ](#API_CreateFunction_ResponseSyntax) ** + ** [Role](#API_CreateFunction_ResponseSyntax) ** The function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` - ** [ Runtime ](#API_CreateFunction_ResponseSyntax) ** + ** [Runtime](#API_CreateFunction_ResponseSyntax) ** The runtime environment for the Lambda function\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ SigningJobArn ](#API_CreateFunction_ResponseSyntax) ** + ** [SigningJobArn](#API_CreateFunction_ResponseSyntax) ** The ARN of the signing job\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ SigningProfileVersionArn ](#API_CreateFunction_ResponseSyntax) ** + ** [SigningProfileVersionArn](#API_CreateFunction_ResponseSyntax) ** The ARN of the signing profile version\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ State ](#API_CreateFunction_ResponseSyntax) ** + ** [State](#API_CreateFunction_ResponseSyntax) ** The current state of the function\. When the state is `Inactive`, you can reactivate the function by invoking it\. Type: String Valid Values:` Pending | Active | Inactive | Failed` - ** [ StateReason ](#API_CreateFunction_ResponseSyntax) ** + ** [StateReason](#API_CreateFunction_ResponseSyntax) ** The reason for the function's current state\. Type: String - ** [ StateReasonCode ](#API_CreateFunction_ResponseSyntax) ** + ** [StateReasonCode](#API_CreateFunction_ResponseSyntax) ** The reason code for the function's current state\. When the code is `Creating`, you can't invoke or modify the function\. Type: String Valid Values:` Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Timeout ](#API_CreateFunction_ResponseSyntax) ** + ** [Timeout](#API_CreateFunction_ResponseSyntax) ** The amount of time in seconds that Lambda allows a function to run before stopping it\. Type: Integer Valid Range: Minimum value of 1\. - ** [ TracingConfig ](#API_CreateFunction_ResponseSyntax) ** + ** [TracingConfig](#API_CreateFunction_ResponseSyntax) ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object - ** [ Version ](#API_CreateFunction_ResponseSyntax) ** + ** [Version](#API_CreateFunction_ResponseSyntax) ** The version of the Lambda function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ VpcConfig ](#API_CreateFunction_ResponseSyntax) ** + ** [VpcConfig](#API_CreateFunction_ResponseSyntax) ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object ## Errors @@ -493,12 +493,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateFunction) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateFunction) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/CreateFunction) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/CreateFunction) \ No newline at end of file diff --git a/doc_source/API_DeadLetterConfig.md b/doc_source/API_DeadLetterConfig.md old mode 100644 new mode 100755 index 472781c8..66c1b753 --- a/doc_source/API_DeadLetterConfig.md +++ b/doc_source/API_DeadLetterConfig.md @@ -13,7 +13,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeadLetterConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeadLetterConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeadLetterConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeadLetterConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeadLetterConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeadLetterConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeadLetterConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeadLetterConfig) \ No newline at end of file diff --git a/doc_source/API_DeleteAlias.md b/doc_source/API_DeleteAlias.md old mode 100644 new mode 100755 index a2009314..e2c9e069 --- a/doc_source/API_DeleteAlias.md +++ b/doc_source/API_DeleteAlias.md @@ -12,7 +12,7 @@ DELETE /2015-03-31/functions/FunctionName/aliases/Name HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteAlias_RequestSyntax) ** + ** [FunctionName](#API_DeleteAlias_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,7 +24,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 - ** [ Name ](#API_DeleteAlias_RequestSyntax) ** + ** [Name](#API_DeleteAlias_RequestSyntax) ** The name of the alias\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` @@ -65,12 +65,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteAlias) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteAlias) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteAlias) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteAlias) \ No newline at end of file diff --git a/doc_source/API_DeleteCodeSigningConfig.md b/doc_source/API_DeleteCodeSigningConfig.md old mode 100644 new mode 100755 index 4736a717..871eeff3 --- a/doc_source/API_DeleteCodeSigningConfig.md +++ b/doc_source/API_DeleteCodeSigningConfig.md @@ -12,7 +12,7 @@ DELETE /2020-04-22/code-signing-configs/CodeSigningConfigArn HTTP/1.1 The request uses the following URI parameters\. - ** [ CodeSigningConfigArn ](#API_DeleteCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_DeleteCodeSigningConfig_RequestSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` @@ -53,12 +53,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_DeleteEventSourceMapping.md b/doc_source/API_DeleteEventSourceMapping.md old mode 100644 new mode 100755 index 614c5471..ff0a29db --- a/doc_source/API_DeleteEventSourceMapping.md +++ b/doc_source/API_DeleteEventSourceMapping.md @@ -1,6 +1,6 @@ # DeleteEventSourceMapping -Deletes an [event source mapping](https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html)\. You can get the identifier of a mapping from the output of [ ListEventSourceMappings ](API_ListEventSourceMappings.md)\. +Deletes an [event source mapping](https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html)\. You can get the identifier of a mapping from the output of [ListEventSourceMappings](API_ListEventSourceMappings.md)\. When you delete an event source mapping, it enters a `Deleting` state and might not be completely deleted for several seconds\. @@ -14,7 +14,7 @@ DELETE /2015-03-31/event-source-mappings/UUID HTTP/1.1 The request uses the following URI parameters\. - ** [ UUID ](#API_DeleteEventSourceMapping_RequestSyntax) ** + ** [UUID](#API_DeleteEventSourceMapping_RequestSyntax) ** The identifier of the event source mapping\. Required: Yes @@ -40,6 +40,13 @@ Content-type: application/json } }, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionArn": "string", "FunctionResponseTypes": [ "string" ], "LastModified": number, @@ -76,113 +83,117 @@ If the action is successful, the service sends back an HTTP 202 response\. The following data is returned in JSON format by the service\. - ** [ BatchSize ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [BatchSize](#API_DeleteEventSourceMapping_ResponseSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. Default value: Varies by service\. For Amazon SQS, the default is 10\. For all other services, the default is 100\. Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. - ** [ BisectBatchOnFunctionError ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [BisectBatchOnFunctionError](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. The default value is false\. Type: Boolean - ** [ DestinationConfig ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [DestinationConfig](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ EventSourceArn ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [EventSourceArn](#API_DeleteEventSourceMapping_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ FunctionArn ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [FilterCriteria](#API_DeleteEventSourceMapping_ResponseSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object + + ** [FunctionArn](#API_DeleteEventSourceMapping_ResponseSyntax) ** The ARN of the Lambda function\. 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-_]+))?` - ** [ FunctionResponseTypes ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [FunctionResponseTypes](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` - ** [ LastModified ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [LastModified](#API_DeleteEventSourceMapping_ResponseSyntax) ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds\. Type: Timestamp - ** [ LastProcessingResult ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [LastProcessingResult](#API_DeleteEventSourceMapping_ResponseSyntax) ** The result of the last Lambda invocation of your function\. Type: String - ** [ MaximumBatchingWindowInSeconds ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. - ** [ MaximumRecordAgeInSeconds ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is \-1, which sets the maximum age to infinite\. When the value is set to infinite, Lambda never discards old records\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. - ** [ MaximumRetryAttempts ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is \-1, which sets the maximum number of retries to infinite\. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. - ** [ ParallelizationFactor ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [ParallelizationFactor](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) The number of batches to process concurrently from each shard\. The default value is 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. - ** [ Queues ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [Queues](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Amazon MQ\) The name of the Amazon MQ broker destination queue to consume\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 1000\. Pattern: `[\s\S]*` - ** [ SelfManagedEventSource ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [SelfManagedEventSource](#API_DeleteEventSourceMapping_ResponseSyntax) ** The self\-managed Apache Kafka cluster for your event source\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object - ** [ SourceAccessConfigurations ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [SourceAccessConfigurations](#API_DeleteEventSourceMapping_ResponseSyntax) ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. - ** [ StartingPosition ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [StartingPosition](#API_DeleteEventSourceMapping_ResponseSyntax) ** The position in a stream from which to start reading\. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources\. `AT_TIMESTAMP` is supported only for Amazon Kinesis streams\. Type: String Valid Values:` TRIM_HORIZON | LATEST | AT_TIMESTAMP` - ** [ StartingPositionTimestamp ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [StartingPositionTimestamp](#API_DeleteEventSourceMapping_ResponseSyntax) ** With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\. Type: Timestamp - ** [ State ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [State](#API_DeleteEventSourceMapping_ResponseSyntax) ** The state of the event source mapping\. It can be one of the following: `Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`\. Type: String - ** [ StateTransitionReason ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [StateTransitionReason](#API_DeleteEventSourceMapping_ResponseSyntax) ** Indicates whether a user or Lambda made the last change to the event source mapping\. Type: String - ** [ Topics ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [Topics](#API_DeleteEventSourceMapping_ResponseSyntax) ** The name of the Kafka topic\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 249\. Pattern: `^[^.]([a-zA-Z0-9\-_.]+)` - ** [ TumblingWindowInSeconds ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [TumblingWindowInSeconds](#API_DeleteEventSourceMapping_ResponseSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is 1–900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. - ** [ UUID ](#API_DeleteEventSourceMapping_ResponseSyntax) ** + ** [UUID](#API_DeleteEventSourceMapping_ResponseSyntax) ** The identifier of the event source mapping\. Type: String @@ -211,12 +222,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteEventSourceMapping) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteEventSourceMapping) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteEventSourceMapping) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteEventSourceMapping) \ No newline at end of file diff --git a/doc_source/API_DeleteFunction.md b/doc_source/API_DeleteFunction.md old mode 100644 new mode 100755 index 2b753d6f..a6c75339 --- a/doc_source/API_DeleteFunction.md +++ b/doc_source/API_DeleteFunction.md @@ -2,7 +2,7 @@ Deletes a Lambda function\. To delete a specific function version, use the `Qualifier` parameter\. Otherwise, all versions and aliases are deleted\. -To delete Lambda event source mappings that invoke a function, use [ DeleteEventSourceMapping ](API_DeleteEventSourceMapping.md)\. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it\. +To delete Lambda event source mappings that invoke a function, use [DeleteEventSourceMapping](API_DeleteEventSourceMapping.md)\. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it\. ## Request Syntax @@ -14,7 +14,7 @@ DELETE /2015-03-31/functions/FunctionName?Qualifier=Qualifier HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteFunction_RequestSyntax) ** + ** [FunctionName](#API_DeleteFunction_RequestSyntax) ** The name of the Lambda function or version\. **Name formats** @@ -26,7 +26,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_DeleteFunction_RequestSyntax) ** + ** [Qualifier](#API_DeleteFunction_RequestSyntax) ** Specify a version to delete\. You can't delete a version that's referenced by an alias\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -70,12 +70,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunction) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunction) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunction) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunction) \ No newline at end of file diff --git a/doc_source/API_DeleteFunctionCodeSigningConfig.md b/doc_source/API_DeleteFunctionCodeSigningConfig.md old mode 100644 new mode 100755 index 140631dd..e75f7f19 --- a/doc_source/API_DeleteFunctionCodeSigningConfig.md +++ b/doc_source/API_DeleteFunctionCodeSigningConfig.md @@ -12,7 +12,7 @@ DELETE /2020-06-30/functions/FunctionName/code-signing-config HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteFunctionCodeSigningConfig_RequestSyntax) ** + ** [FunctionName](#API_DeleteFunctionCodeSigningConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -67,12 +67,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_DeleteFunctionConcurrency.md b/doc_source/API_DeleteFunctionConcurrency.md old mode 100644 new mode 100755 index a5d54266..2021e7f2 --- a/doc_source/API_DeleteFunctionConcurrency.md +++ b/doc_source/API_DeleteFunctionConcurrency.md @@ -12,7 +12,7 @@ DELETE /2017-10-31/functions/FunctionName/concurrency HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteFunctionConcurrency_RequestSyntax) ** + ** [FunctionName](#API_DeleteFunctionConcurrency_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -63,12 +63,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionConcurrency) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionConcurrency) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionConcurrency) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionConcurrency) \ No newline at end of file diff --git a/doc_source/API_DeleteFunctionEventInvokeConfig.md b/doc_source/API_DeleteFunctionEventInvokeConfig.md old mode 100644 new mode 100755 index 8ae03cdb..97c1014e --- a/doc_source/API_DeleteFunctionEventInvokeConfig.md +++ b/doc_source/API_DeleteFunctionEventInvokeConfig.md @@ -2,7 +2,7 @@ Deletes the configuration for asynchronous invocation for a function, version, or alias\. -To configure options for asynchronous invocation, use [ PutFunctionEventInvokeConfig ](API_PutFunctionEventInvokeConfig.md)\. +To configure options for asynchronous invocation, use [PutFunctionEventInvokeConfig](API_PutFunctionEventInvokeConfig.md)\. ## Request Syntax @@ -14,7 +14,7 @@ DELETE /2019-09-25/functions/FunctionName/event-invoke-config?Qualifier=Qualifie The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteFunctionEventInvokeConfig_RequestSyntax) ** + ** [FunctionName](#API_DeleteFunctionEventInvokeConfig_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -26,7 +26,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_DeleteFunctionEventInvokeConfig_RequestSyntax) ** + ** [Qualifier](#API_DeleteFunctionEventInvokeConfig_RequestSyntax) ** A version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -70,12 +70,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteFunctionEventInvokeConfig) \ No newline at end of file diff --git a/doc_source/API_DeleteLayerVersion.md b/doc_source/API_DeleteLayerVersion.md old mode 100644 new mode 100755 index 7b64f0e2..4c05bfd8 --- a/doc_source/API_DeleteLayerVersion.md +++ b/doc_source/API_DeleteLayerVersion.md @@ -1,6 +1,6 @@ # DeleteLayerVersion -Deletes a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. Deleted versions can no longer be viewed or added to functions\. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it\. +Deletes a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. Deleted versions can no longer be viewed or added to functions\. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it\. ## Request Syntax @@ -12,13 +12,13 @@ DELETE /2018-10-31/layers/LayerName/versions/VersionNumber HTTP/1.1 The request uses the following URI parameters\. - ** [ LayerName ](#API_DeleteLayerVersion_RequestSyntax) ** + ** [LayerName](#API_DeleteLayerVersion_RequestSyntax) ** 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 - ** [ VersionNumber ](#API_DeleteLayerVersion_RequestSyntax) ** + ** [VersionNumber](#API_DeleteLayerVersion_RequestSyntax) ** The version number\. Required: Yes @@ -49,12 +49,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteLayerVersion) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteLayerVersion) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteLayerVersion) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteLayerVersion) \ No newline at end of file diff --git a/doc_source/API_DeleteProvisionedConcurrencyConfig.md b/doc_source/API_DeleteProvisionedConcurrencyConfig.md old mode 100644 new mode 100755 index 3bbd703f..8791b35c --- a/doc_source/API_DeleteProvisionedConcurrencyConfig.md +++ b/doc_source/API_DeleteProvisionedConcurrencyConfig.md @@ -12,7 +12,7 @@ DELETE /2019-09-30/functions/FunctionName/provisioned-concurrency?Qualifier=Qual The request uses the following URI parameters\. - ** [ FunctionName ](#API_DeleteProvisionedConcurrencyConfig_RequestSyntax) ** + ** [FunctionName](#API_DeleteProvisionedConcurrencyConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,7 +24,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_DeleteProvisionedConcurrencyConfig_RequestSyntax) ** + ** [Qualifier](#API_DeleteProvisionedConcurrencyConfig_RequestSyntax) ** The version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -69,12 +69,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig) \ No newline at end of file diff --git a/doc_source/API_DestinationConfig.md b/doc_source/API_DestinationConfig.md old mode 100644 new mode 100755 index a0fb8fc5..9d70476f --- a/doc_source/API_DestinationConfig.md +++ b/doc_source/API_DestinationConfig.md @@ -6,18 +6,18 @@ A configuration object that specifies the destination of an event after Lambda p ** OnFailure ** The destination configuration for failed invocations\. -Type: [ OnFailure ](API_OnFailure.md) object +Type: [OnFailure](API_OnFailure.md) object Required: No ** OnSuccess ** The destination configuration for successful invocations\. -Type: [ OnSuccess ](API_OnSuccess.md) object +Type: [OnSuccess](API_OnSuccess.md) object Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DestinationConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DestinationConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DestinationConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DestinationConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/DestinationConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/DestinationConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/DestinationConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/DestinationConfig) \ No newline at end of file diff --git a/doc_source/API_Environment.md b/doc_source/API_Environment.md old mode 100644 new mode 100755 index 0c18270f..f6431eea --- a/doc_source/API_Environment.md +++ b/doc_source/API_Environment.md @@ -13,7 +13,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Environment) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Environment) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Environment) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Environment) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Environment) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Environment) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Environment) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Environment) \ No newline at end of file diff --git a/doc_source/API_EnvironmentError.md b/doc_source/API_EnvironmentError.md old mode 100644 new mode 100755 index 1532e16f..2ddf454e --- a/doc_source/API_EnvironmentError.md +++ b/doc_source/API_EnvironmentError.md @@ -17,7 +17,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EnvironmentError) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EnvironmentError) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EnvironmentError) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EnvironmentError) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EnvironmentError) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EnvironmentError) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EnvironmentError) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EnvironmentError) \ No newline at end of file diff --git a/doc_source/API_EnvironmentResponse.md b/doc_source/API_EnvironmentResponse.md old mode 100644 new mode 100755 index f1dadee3..d3e1bb12 --- a/doc_source/API_EnvironmentResponse.md +++ b/doc_source/API_EnvironmentResponse.md @@ -6,7 +6,7 @@ The results of an operation to update or read environment variables\. If the ope ** Error ** Error messages for environment variables that couldn't be applied\. -Type: [ EnvironmentError ](API_EnvironmentError.md) object +Type: [EnvironmentError](API_EnvironmentError.md) object Required: No ** Variables ** @@ -18,7 +18,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EnvironmentResponse) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EnvironmentResponse) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EnvironmentResponse) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EnvironmentResponse) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EnvironmentResponse) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EnvironmentResponse) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EnvironmentResponse) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EnvironmentResponse) \ No newline at end of file diff --git a/doc_source/API_EventSourceMappingConfiguration.md b/doc_source/API_EventSourceMappingConfiguration.md old mode 100644 new mode 100755 index 6303741e..4cccf1a0 --- a/doc_source/API_EventSourceMappingConfiguration.md +++ b/doc_source/API_EventSourceMappingConfiguration.md @@ -1,6 +1,6 @@ # EventSourceMappingConfiguration -A mapping between an AWS resource and a Lambda function\. For details, see [ CreateEventSourceMapping ](API_CreateEventSourceMapping.md)\. +A mapping between an AWS resource and a Lambda function\. For details, see [CreateEventSourceMapping](API_CreateEventSourceMapping.md)\. ## Contents @@ -19,13 +19,18 @@ Required: No ** DestinationConfig ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No ** EventSourceArn ** The Amazon Resource Name \(ARN\) of the event source\. 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 + + ** FilterCriteria ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object Required: No ** FunctionArn ** @@ -87,12 +92,12 @@ Required: No ** SelfManagedEventSource ** The self\-managed Apache Kafka cluster for your event source\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object Required: No ** SourceAccessConfigurations ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. Required: No @@ -139,7 +144,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EventSourceMappingConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EventSourceMappingConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EventSourceMappingConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EventSourceMappingConfiguration) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/EventSourceMappingConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/EventSourceMappingConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/EventSourceMappingConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/EventSourceMappingConfiguration) \ No newline at end of file diff --git a/doc_source/API_FileSystemConfig.md b/doc_source/API_FileSystemConfig.md old mode 100644 new mode 100755 index 9c5257df..36843cd4 --- a/doc_source/API_FileSystemConfig.md +++ b/doc_source/API_FileSystemConfig.md @@ -21,7 +21,7 @@ Required: Yes ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FileSystemConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FileSystemConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FileSystemConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FileSystemConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FileSystemConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FileSystemConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FileSystemConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FileSystemConfig) \ No newline at end of file diff --git a/doc_source/API_Filter.md b/doc_source/API_Filter.md new file mode 100755 index 00000000..ab0a6041 --- /dev/null +++ b/doc_source/API_Filter.md @@ -0,0 +1,20 @@ +# Filter + + A structure within a `FilterCriteria` object that defines an event filtering pattern\. + +## Contents + + ** Pattern ** + A filter pattern\. For more information on the syntax of a filter pattern, see [ Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax)\. +Type: String +Length Constraints: Minimum length of 0\. Maximum length of 4096\. +Pattern: `.*` +Required: No + +## See Also + +For more information about using this API in one of the language\-specific AWS SDKs, see the following: ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Filter) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Filter) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Filter) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Filter) \ No newline at end of file diff --git a/doc_source/API_FilterCriteria.md b/doc_source/API_FilterCriteria.md new file mode 100755 index 00000000..06d99095 --- /dev/null +++ b/doc_source/API_FilterCriteria.md @@ -0,0 +1,18 @@ +# FilterCriteria + + An object that contains the filters for an event source\. + +## Contents + + ** Filters ** + A list of filters\. +Type: Array of [Filter](API_Filter.md) objects +Required: No + +## See Also + +For more information about using this API in one of the language\-specific AWS SDKs, see the following: ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FilterCriteria) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FilterCriteria) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FilterCriteria) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FilterCriteria) \ No newline at end of file diff --git a/doc_source/API_FunctionCode.md b/doc_source/API_FunctionCode.md old mode 100644 new mode 100755 index 0a3dfa0f..1289dcdb --- a/doc_source/API_FunctionCode.md +++ b/doc_source/API_FunctionCode.md @@ -36,7 +36,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionCode) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionCode) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionCode) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionCode) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionCode) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionCode) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionCode) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionCode) \ No newline at end of file diff --git a/doc_source/API_FunctionCodeLocation.md b/doc_source/API_FunctionCodeLocation.md old mode 100644 new mode 100755 index d21a8936..0a9aff6c --- a/doc_source/API_FunctionCodeLocation.md +++ b/doc_source/API_FunctionCodeLocation.md @@ -27,7 +27,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionCodeLocation) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionCodeLocation) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionCodeLocation) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionCodeLocation) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionCodeLocation) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionCodeLocation) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionCodeLocation) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionCodeLocation) \ No newline at end of file diff --git a/doc_source/API_FunctionConfiguration.md b/doc_source/API_FunctionConfiguration.md old mode 100644 new mode 100755 index 2896643e..4590062b --- a/doc_source/API_FunctionConfiguration.md +++ b/doc_source/API_FunctionConfiguration.md @@ -23,7 +23,7 @@ Required: No ** DeadLetterConfig ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object Required: No ** Description ** @@ -34,12 +34,12 @@ Required: No ** Environment ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object Required: No ** FileSystemConfigs ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. Required: No @@ -65,7 +65,7 @@ Required: No ** ImageConfigResponse ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object Required: No ** KMSKeyArn ** @@ -98,7 +98,7 @@ Required: No ** Layers ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects Required: No ** MasterArn ** @@ -173,7 +173,7 @@ Required: No ** TracingConfig ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object Required: No ** Version ** @@ -185,13 +185,13 @@ Required: No ** VpcConfig ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionConfiguration) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionConfiguration) \ No newline at end of file diff --git a/doc_source/API_FunctionEventInvokeConfig.md b/doc_source/API_FunctionEventInvokeConfig.md old mode 100644 new mode 100755 index 1ea75549..d5e27544 --- a/doc_source/API_FunctionEventInvokeConfig.md +++ b/doc_source/API_FunctionEventInvokeConfig.md @@ -10,7 +10,7 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No ** FunctionArn ** @@ -39,7 +39,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionEventInvokeConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionEventInvokeConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionEventInvokeConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionEventInvokeConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/FunctionEventInvokeConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/FunctionEventInvokeConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/FunctionEventInvokeConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/FunctionEventInvokeConfig) \ No newline at end of file diff --git a/doc_source/API_GetAccountSettings.md b/doc_source/API_GetAccountSettings.md old mode 100644 new mode 100755 index f18742f2..dd4292cf --- a/doc_source/API_GetAccountSettings.md +++ b/doc_source/API_GetAccountSettings.md @@ -43,13 +43,13 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ AccountLimit ](#API_GetAccountSettings_ResponseSyntax) ** + ** [AccountLimit](#API_GetAccountSettings_ResponseSyntax) ** Limits that are related to concurrency and code storage\. -Type: [ AccountLimit ](API_AccountLimit.md) object +Type: [AccountLimit](API_AccountLimit.md) object - ** [ AccountUsage ](#API_GetAccountSettings_ResponseSyntax) ** + ** [AccountUsage](#API_GetAccountSettings_ResponseSyntax) ** The number of functions and amount of storage in use\. -Type: [ AccountUsage ](API_AccountUsage.md) object +Type: [AccountUsage](API_AccountUsage.md) object ## Errors @@ -64,12 +64,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetAccountSettings) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetAccountSettings) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetAccountSettings) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetAccountSettings) \ No newline at end of file diff --git a/doc_source/API_GetAlias.md b/doc_source/API_GetAlias.md old mode 100644 new mode 100755 index 9c1f7756..fdb3ced6 --- a/doc_source/API_GetAlias.md +++ b/doc_source/API_GetAlias.md @@ -12,7 +12,7 @@ GET /2015-03-31/functions/FunctionName/aliases/Name HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetAlias_RequestSyntax) ** + ** [FunctionName](#API_GetAlias_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,7 +24,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 - ** [ Name ](#API_GetAlias_RequestSyntax) ** + ** [Name](#API_GetAlias_RequestSyntax) ** The name of the alias\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` @@ -60,35 +60,35 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ AliasArn ](#API_GetAlias_ResponseSyntax) ** + ** [AliasArn](#API_GetAlias_ResponseSyntax) ** 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-_]+))?` - ** [ Description ](#API_GetAlias_ResponseSyntax) ** + ** [Description](#API_GetAlias_ResponseSyntax) ** A description of the alias\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ FunctionVersion ](#API_GetAlias_ResponseSyntax) ** + ** [FunctionVersion](#API_GetAlias_ResponseSyntax) ** The function version that the alias invokes\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ Name ](#API_GetAlias_ResponseSyntax) ** + ** [Name](#API_GetAlias_ResponseSyntax) ** The name of the alias\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` - ** [ RevisionId ](#API_GetAlias_ResponseSyntax) ** + ** [RevisionId](#API_GetAlias_ResponseSyntax) ** A unique identifier that changes when you update the alias\. Type: String - ** [ RoutingConfig ](#API_GetAlias_ResponseSyntax) ** + ** [RoutingConfig](#API_GetAlias_ResponseSyntax) ** 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 ## Errors @@ -111,12 +111,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetAlias) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetAlias) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetAlias) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetAlias) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetAlias) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetAlias) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetAlias) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetAlias) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetAlias) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetAlias) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetAlias) \ No newline at end of file diff --git a/doc_source/API_GetCodeSigningConfig.md b/doc_source/API_GetCodeSigningConfig.md old mode 100644 new mode 100755 index 7c2d839d..544fa093 --- a/doc_source/API_GetCodeSigningConfig.md +++ b/doc_source/API_GetCodeSigningConfig.md @@ -12,7 +12,7 @@ GET /2020-04-22/code-signing-configs/CodeSigningConfigArn HTTP/1.1 The request uses the following URI parameters\. - ** [ CodeSigningConfigArn ](#API_GetCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_GetCodeSigningConfig_RequestSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` @@ -50,9 +50,9 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfig ](#API_GetCodeSigningConfig_ResponseSyntax) ** + ** [CodeSigningConfig](#API_GetCodeSigningConfig_ResponseSyntax) ** The code signing configuration -Type: [ CodeSigningConfig ](API_CodeSigningConfig.md) object +Type: [CodeSigningConfig](API_CodeSigningConfig.md) object ## Errors @@ -71,12 +71,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_GetEventSourceMapping.md b/doc_source/API_GetEventSourceMapping.md old mode 100644 new mode 100755 index cb995038..3a417bb2 --- a/doc_source/API_GetEventSourceMapping.md +++ b/doc_source/API_GetEventSourceMapping.md @@ -1,6 +1,6 @@ # GetEventSourceMapping -Returns details about an event source mapping\. You can get the identifier of a mapping from the output of [ ListEventSourceMappings ](API_ListEventSourceMappings.md)\. +Returns details about an event source mapping\. You can get the identifier of a mapping from the output of [ListEventSourceMappings](API_ListEventSourceMappings.md)\. ## Request Syntax @@ -12,7 +12,7 @@ GET /2015-03-31/event-source-mappings/UUID HTTP/1.1 The request uses the following URI parameters\. - ** [ UUID ](#API_GetEventSourceMapping_RequestSyntax) ** + ** [UUID](#API_GetEventSourceMapping_RequestSyntax) ** The identifier of the event source mapping\. Required: Yes @@ -38,6 +38,13 @@ Content-type: application/json } }, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionArn": "string", "FunctionResponseTypes": [ "string" ], "LastModified": number, @@ -74,113 +81,117 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ BatchSize ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [BatchSize](#API_GetEventSourceMapping_ResponseSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. Default value: Varies by service\. For Amazon SQS, the default is 10\. For all other services, the default is 100\. Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. - ** [ BisectBatchOnFunctionError ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [BisectBatchOnFunctionError](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. The default value is false\. Type: Boolean - ** [ DestinationConfig ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [DestinationConfig](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ EventSourceArn ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [EventSourceArn](#API_GetEventSourceMapping_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ FunctionArn ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [FilterCriteria](#API_GetEventSourceMapping_ResponseSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object + + ** [FunctionArn](#API_GetEventSourceMapping_ResponseSyntax) ** The ARN of the Lambda function\. 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-_]+))?` - ** [ FunctionResponseTypes ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [FunctionResponseTypes](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` - ** [ LastModified ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [LastModified](#API_GetEventSourceMapping_ResponseSyntax) ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds\. Type: Timestamp - ** [ LastProcessingResult ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [LastProcessingResult](#API_GetEventSourceMapping_ResponseSyntax) ** The result of the last Lambda invocation of your function\. Type: String - ** [ MaximumBatchingWindowInSeconds ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. - ** [ MaximumRecordAgeInSeconds ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is \-1, which sets the maximum age to infinite\. When the value is set to infinite, Lambda never discards old records\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. - ** [ MaximumRetryAttempts ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is \-1, which sets the maximum number of retries to infinite\. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. - ** [ ParallelizationFactor ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [ParallelizationFactor](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) The number of batches to process concurrently from each shard\. The default value is 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. - ** [ Queues ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [Queues](#API_GetEventSourceMapping_ResponseSyntax) ** \(Amazon MQ\) The name of the Amazon MQ broker destination queue to consume\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 1000\. Pattern: `[\s\S]*` - ** [ SelfManagedEventSource ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [SelfManagedEventSource](#API_GetEventSourceMapping_ResponseSyntax) ** The self\-managed Apache Kafka cluster for your event source\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object - ** [ SourceAccessConfigurations ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [SourceAccessConfigurations](#API_GetEventSourceMapping_ResponseSyntax) ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. - ** [ StartingPosition ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [StartingPosition](#API_GetEventSourceMapping_ResponseSyntax) ** The position in a stream from which to start reading\. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources\. `AT_TIMESTAMP` is supported only for Amazon Kinesis streams\. Type: String Valid Values:` TRIM_HORIZON | LATEST | AT_TIMESTAMP` - ** [ StartingPositionTimestamp ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [StartingPositionTimestamp](#API_GetEventSourceMapping_ResponseSyntax) ** With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\. Type: Timestamp - ** [ State ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [State](#API_GetEventSourceMapping_ResponseSyntax) ** The state of the event source mapping\. It can be one of the following: `Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`\. Type: String - ** [ StateTransitionReason ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [StateTransitionReason](#API_GetEventSourceMapping_ResponseSyntax) ** Indicates whether a user or Lambda made the last change to the event source mapping\. Type: String - ** [ Topics ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [Topics](#API_GetEventSourceMapping_ResponseSyntax) ** The name of the Kafka topic\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 249\. Pattern: `^[^.]([a-zA-Z0-9\-_.]+)` - ** [ TumblingWindowInSeconds ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [TumblingWindowInSeconds](#API_GetEventSourceMapping_ResponseSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is 1–900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. - ** [ UUID ](#API_GetEventSourceMapping_ResponseSyntax) ** + ** [UUID](#API_GetEventSourceMapping_ResponseSyntax) ** The identifier of the event source mapping\. Type: String @@ -205,12 +216,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetEventSourceMapping) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetEventSourceMapping) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetEventSourceMapping) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetEventSourceMapping) \ No newline at end of file diff --git a/doc_source/API_GetFunction.md b/doc_source/API_GetFunction.md old mode 100644 new mode 100755 index 5e0c4c28..9c4083a3 --- a/doc_source/API_GetFunction.md +++ b/doc_source/API_GetFunction.md @@ -12,7 +12,7 @@ GET /2015-03-31/functions/FunctionName?Qualifier=Qualifier HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetFunction_RequestSyntax) ** + ** [FunctionName](#API_GetFunction_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -24,7 +24,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\. 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_GetFunction_RequestSyntax) ** + ** [Qualifier](#API_GetFunction_RequestSyntax) ** Specify a version or alias to get details about a published version of the function\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -133,19 +133,19 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Code ](#API_GetFunction_ResponseSyntax) ** + ** [Code](#API_GetFunction_ResponseSyntax) ** The deployment package of the function or version\. -Type: [ FunctionCodeLocation ](API_FunctionCodeLocation.md) object +Type: [FunctionCodeLocation](API_FunctionCodeLocation.md) object - ** [ Concurrency ](#API_GetFunction_ResponseSyntax) ** + ** [Concurrency](#API_GetFunction_ResponseSyntax) ** The function's [reserved concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\. -Type: [ Concurrency ](API_Concurrency.md) object +Type: [Concurrency](API_Concurrency.md) object - ** [ Configuration ](#API_GetFunction_ResponseSyntax) ** + ** [Configuration](#API_GetFunction_ResponseSyntax) ** The configuration of the function or version\. -Type: [ FunctionConfiguration ](API_FunctionConfiguration.md) object +Type: [FunctionConfiguration](API_FunctionConfiguration.md) object - ** [ Tags ](#API_GetFunction_ResponseSyntax) ** + ** [Tags](#API_GetFunction_ResponseSyntax) ** The function's [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)\. Type: String to string map @@ -170,12 +170,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunction) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunction) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunction) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunction) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunction) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunction) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunction) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunction) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunction) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunction) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunction) \ No newline at end of file diff --git a/doc_source/API_GetFunctionCodeSigningConfig.md b/doc_source/API_GetFunctionCodeSigningConfig.md old mode 100644 new mode 100755 index ebfabc08..be6ec7ca --- a/doc_source/API_GetFunctionCodeSigningConfig.md +++ b/doc_source/API_GetFunctionCodeSigningConfig.md @@ -12,7 +12,7 @@ GET /2020-06-30/functions/FunctionName/code-signing-config HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetFunctionCodeSigningConfig_RequestSyntax) ** + ** [FunctionName](#API_GetFunctionCodeSigningConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -46,13 +46,13 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfigArn ](#API_GetFunctionCodeSigningConfig_ResponseSyntax) ** + ** [CodeSigningConfigArn](#API_GetFunctionCodeSigningConfig_ResponseSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Type: String Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` - ** [ FunctionName ](#API_GetFunctionCodeSigningConfig_ResponseSyntax) ** + ** [FunctionName](#API_GetFunctionCodeSigningConfig_ResponseSyntax) ** The name of the Lambda function\. **Name formats** @@ -85,12 +85,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_GetFunctionConcurrency.md b/doc_source/API_GetFunctionConcurrency.md old mode 100644 new mode 100755 index 017f6474..c6757228 --- a/doc_source/API_GetFunctionConcurrency.md +++ b/doc_source/API_GetFunctionConcurrency.md @@ -1,6 +1,6 @@ # GetFunctionConcurrency -Returns details about the reserved concurrency configuration for a function\. To set a concurrency limit for a function, use [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\. +Returns details about the reserved concurrency configuration for a function\. To set a concurrency limit for a function, use [PutFunctionConcurrency](API_PutFunctionConcurrency.md)\. ## Request Syntax @@ -12,7 +12,7 @@ GET /2019-09-30/functions/FunctionName/concurrency HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetFunctionConcurrency_RequestSyntax) ** + ** [FunctionName](#API_GetFunctionConcurrency_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -45,7 +45,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ ReservedConcurrentExecutions ](#API_GetFunctionConcurrency_ResponseSyntax) ** + ** [ReservedConcurrentExecutions](#API_GetFunctionConcurrency_ResponseSyntax) ** The number of simultaneous executions that are reserved for the function\. Type: Integer Valid Range: Minimum value of 0\. @@ -71,12 +71,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionConcurrency) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionConcurrency) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionConcurrency) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionConcurrency) \ No newline at end of file diff --git a/doc_source/API_GetFunctionConfiguration.md b/doc_source/API_GetFunctionConfiguration.md old mode 100644 new mode 100755 index e6d676ba..05ae9974 --- a/doc_source/API_GetFunctionConfiguration.md +++ b/doc_source/API_GetFunctionConfiguration.md @@ -1,8 +1,8 @@ # GetFunctionConfiguration -Returns the version\-specific settings of a Lambda function or version\. The output includes only options that can vary between versions of a function\. To modify these settings, use [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md)\. +Returns the version\-specific settings of a Lambda function or version\. The output includes only options that can vary between versions of a function\. To modify these settings, use [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md)\. -To get all of a function's details, including function\-level settings, use [ GetFunction ](API_GetFunction.md)\. +To get all of a function's details, including function\-level settings, use [GetFunction](API_GetFunction.md)\. ## Request Syntax @@ -14,7 +14,7 @@ GET /2015-03-31/functions/FunctionName/configuration?Qualifier=Qualifier HTTP/1. The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetFunctionConfiguration_RequestSyntax) ** + ** [FunctionName](#API_GetFunctionConfiguration_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -26,7 +26,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\. 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_GetFunctionConfiguration_RequestSyntax) ** + ** [Qualifier](#API_GetFunctionConfiguration_RequestSyntax) ** Specify a version or alias to get details about a published version of the function\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -121,157 +121,157 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Architectures ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Architectures](#API_GetFunctionConfiguration_ResponseSyntax) ** The instruction set architecture that the function supports\. Architecture is a string array with one of the valid values\. The default architecture value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` - ** [ CodeSha256 ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [CodeSha256](#API_GetFunctionConfiguration_ResponseSyntax) ** The SHA256 hash of the function's deployment package\. Type: String - ** [ CodeSize ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [CodeSize](#API_GetFunctionConfiguration_ResponseSyntax) ** The size of the function's deployment package, in bytes\. Type: Long - ** [ DeadLetterConfig ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [DeadLetterConfig](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object - ** [ Description ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Description](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's description\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ Environment ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Environment](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object - ** [ FileSystemConfigs ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [FileSystemConfigs](#API_GetFunctionConfiguration_ResponseSyntax) ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. - ** [ FunctionArn ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [FunctionArn](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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-_]+))?` - ** [ FunctionName ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [FunctionName](#API_GetFunctionConfiguration_ResponseSyntax) ** The name of the function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 170\. 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-_]+))?` - ** [ Handler ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Handler](#API_GetFunctionConfiguration_ResponseSyntax) ** The function that Lambda calls to begin executing your function\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` - ** [ ImageConfigResponse ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [ImageConfigResponse](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object - ** [ KMSKeyArn ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [KMSKeyArn](#API_GetFunctionConfiguration_ResponseSyntax) ** The AWS KMS key that's used to encrypt the function's environment variables\. This key is only returned if you've configured a customer managed key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` - ** [ LastModified ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [LastModified](#API_GetFunctionConfiguration_ResponseSyntax) ** The date and time that the function was last updated, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ LastUpdateStatus ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatus](#API_GetFunctionConfiguration_ResponseSyntax) ** The status of the last update that was performed on the function\. This is first set to `Successful` after function creation completes\. Type: String Valid Values:` Successful | Failed | InProgress` - ** [ LastUpdateStatusReason ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatusReason](#API_GetFunctionConfiguration_ResponseSyntax) ** The reason for the last update that was performed on the function\. Type: String - ** [ LastUpdateStatusReasonCode ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatusReasonCode](#API_GetFunctionConfiguration_ResponseSyntax) ** The reason code for the last update that was performed on the function\. Type: String Valid Values:` EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Layers ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Layers](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects - ** [ MasterArn ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [MasterArn](#API_GetFunctionConfiguration_ResponseSyntax) ** For Lambda@Edge functions, the ARN of the main function\. 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-_]+))?` - ** [ MemorySize ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [MemorySize](#API_GetFunctionConfiguration_ResponseSyntax) ** The amount of memory available to the function at runtime\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. - ** [ PackageType ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [PackageType](#API_GetFunctionConfiguration_ResponseSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for \.zip file archive\. Type: String Valid Values:` Zip | Image` - ** [ RevisionId ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [RevisionId](#API_GetFunctionConfiguration_ResponseSyntax) ** The latest updated revision of the function or alias\. Type: String - ** [ Role ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Role](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` - ** [ Runtime ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Runtime](#API_GetFunctionConfiguration_ResponseSyntax) ** The runtime environment for the Lambda function\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ SigningJobArn ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [SigningJobArn](#API_GetFunctionConfiguration_ResponseSyntax) ** The ARN of the signing job\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ SigningProfileVersionArn ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [SigningProfileVersionArn](#API_GetFunctionConfiguration_ResponseSyntax) ** The ARN of the signing profile version\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ State ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [State](#API_GetFunctionConfiguration_ResponseSyntax) ** The current state of the function\. When the state is `Inactive`, you can reactivate the function by invoking it\. Type: String Valid Values:` Pending | Active | Inactive | Failed` - ** [ StateReason ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [StateReason](#API_GetFunctionConfiguration_ResponseSyntax) ** The reason for the function's current state\. Type: String - ** [ StateReasonCode ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [StateReasonCode](#API_GetFunctionConfiguration_ResponseSyntax) ** The reason code for the function's current state\. When the code is `Creating`, you can't invoke or modify the function\. Type: String Valid Values:` Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Timeout ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Timeout](#API_GetFunctionConfiguration_ResponseSyntax) ** The amount of time in seconds that Lambda allows a function to run before stopping it\. Type: Integer Valid Range: Minimum value of 1\. - ** [ TracingConfig ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [TracingConfig](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object - ** [ Version ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [Version](#API_GetFunctionConfiguration_ResponseSyntax) ** The version of the Lambda function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ VpcConfig ](#API_GetFunctionConfiguration_ResponseSyntax) ** + ** [VpcConfig](#API_GetFunctionConfiguration_ResponseSyntax) ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object ## Errors @@ -294,12 +294,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionConfiguration) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionConfiguration) \ No newline at end of file diff --git a/doc_source/API_GetFunctionEventInvokeConfig.md b/doc_source/API_GetFunctionEventInvokeConfig.md old mode 100644 new mode 100755 index 4f593364..8c634b3e --- a/doc_source/API_GetFunctionEventInvokeConfig.md +++ b/doc_source/API_GetFunctionEventInvokeConfig.md @@ -2,7 +2,7 @@ Retrieves the configuration for asynchronous invocation for a function, version, or alias\. -To configure options for asynchronous invocation, use [ PutFunctionEventInvokeConfig ](API_PutFunctionEventInvokeConfig.md)\. +To configure options for asynchronous invocation, use [PutFunctionEventInvokeConfig](API_PutFunctionEventInvokeConfig.md)\. ## Request Syntax @@ -14,7 +14,7 @@ GET /2019-09-25/functions/FunctionName/event-invoke-config?Qualifier=Qualifier H The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetFunctionEventInvokeConfig_RequestSyntax) ** + ** [FunctionName](#API_GetFunctionEventInvokeConfig_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -26,7 +26,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_GetFunctionEventInvokeConfig_RequestSyntax) ** + ** [Qualifier](#API_GetFunctionEventInvokeConfig_RequestSyntax) ** A version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -63,7 +63,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ DestinationConfig ](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** + ** [DestinationConfig](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** A destination for events after they have been sent to a function for processing\. **Destinations** @@ -71,23 +71,23 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ FunctionArn ](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** + ** [FunctionArn](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the function\. 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-_]+))?` - ** [ LastModified ](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** + ** [LastModified](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** The date and time that the configuration was last updated, in Unix time seconds\. Type: Timestamp - ** [ MaximumEventAgeInSeconds ](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumEventAgeInSeconds](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** The maximum age of a request that Lambda sends to a function for processing\. Type: Integer Valid Range: Minimum value of 60\. Maximum value of 21600\. - ** [ MaximumRetryAttempts ](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_GetFunctionEventInvokeConfig_ResponseSyntax) ** The maximum number of times to retry when the function returns an error\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 2\. @@ -113,12 +113,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionEventInvokeConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetFunctionEventInvokeConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetFunctionEventInvokeConfig) \ No newline at end of file diff --git a/doc_source/API_GetLayerVersion.md b/doc_source/API_GetLayerVersion.md old mode 100644 new mode 100755 index 16ddd063..072c87e2 --- a/doc_source/API_GetLayerVersion.md +++ b/doc_source/API_GetLayerVersion.md @@ -1,6 +1,6 @@ # GetLayerVersion -Returns information about a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a link to download the layer archive that's valid for 10 minutes\. +Returns information about a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a link to download the layer archive that's valid for 10 minutes\. ## Request Syntax @@ -12,13 +12,13 @@ GET /2018-10-31/layers/LayerName/versions/VersionNumber HTTP/1.1 The request uses the following URI parameters\. - ** [ LayerName ](#API_GetLayerVersion_RequestSyntax) ** + ** [LayerName](#API_GetLayerVersion_RequestSyntax) ** 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 - ** [ VersionNumber ](#API_GetLayerVersion_RequestSyntax) ** + ** [VersionNumber](#API_GetLayerVersion_RequestSyntax) ** The version number\. Required: Yes @@ -57,49 +57,49 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CompatibleArchitectures ](#API_GetLayerVersion_ResponseSyntax) ** + ** [CompatibleArchitectures](#API_GetLayerVersion_ResponseSyntax) ** A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Type: Array of strings Array Members: Maximum number of 2 items\. Valid Values:` x86_64 | arm64` - ** [ CompatibleRuntimes ](#API_GetLayerVersion_ResponseSyntax) ** + ** [CompatibleRuntimes](#API_GetLayerVersion_ResponseSyntax) ** The layer's compatible runtimes\. Type: Array of strings Array Members: Maximum number of 15 items\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ Content ](#API_GetLayerVersion_ResponseSyntax) ** + ** [Content](#API_GetLayerVersion_ResponseSyntax) ** Details about the layer version\. -Type: [ LayerVersionContentOutput ](API_LayerVersionContentOutput.md) object +Type: [LayerVersionContentOutput](API_LayerVersionContentOutput.md) object - ** [ CreatedDate ](#API_GetLayerVersion_ResponseSyntax) ** + ** [CreatedDate](#API_GetLayerVersion_ResponseSyntax) ** The date that the layer version was created, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ Description ](#API_GetLayerVersion_ResponseSyntax) ** + ** [Description](#API_GetLayerVersion_ResponseSyntax) ** The description of the version\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ LayerArn ](#API_GetLayerVersion_ResponseSyntax) ** + ** [LayerArn](#API_GetLayerVersion_ResponseSyntax) ** The ARN of the layer\. Type: String 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-_]+` - ** [ LayerVersionArn ](#API_GetLayerVersion_ResponseSyntax) ** + ** [LayerVersionArn](#API_GetLayerVersion_ResponseSyntax) ** The ARN of the layer version\. Type: String 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-_]+:[0-9]+` - ** [ LicenseInfo ](#API_GetLayerVersion_ResponseSyntax) ** + ** [LicenseInfo](#API_GetLayerVersion_ResponseSyntax) ** The layer's software license\. Type: String Length Constraints: Maximum length of 512\. - ** [ Version ](#API_GetLayerVersion_ResponseSyntax) ** + ** [Version](#API_GetLayerVersion_ResponseSyntax) ** The version number\. Type: Long @@ -124,12 +124,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersion) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersion) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersion) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersion) \ No newline at end of file diff --git a/doc_source/API_GetLayerVersionByArn.md b/doc_source/API_GetLayerVersionByArn.md old mode 100644 new mode 100755 index 8bb8a9d9..459cc51f --- a/doc_source/API_GetLayerVersionByArn.md +++ b/doc_source/API_GetLayerVersionByArn.md @@ -1,6 +1,6 @@ # GetLayerVersionByArn -Returns information about a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a link to download the layer archive that's valid for 10 minutes\. +Returns information about a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a link to download the layer archive that's valid for 10 minutes\. ## Request Syntax @@ -12,7 +12,7 @@ GET /2018-10-31/layers?find=LayerVersion&Arn=Arn HTTP/1.1 The request uses the following URI parameters\. - ** [ Arn ](#API_GetLayerVersionByArn_RequestSyntax) ** + ** [Arn](#API_GetLayerVersionByArn_RequestSyntax) ** The ARN of the layer version\. 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-_]+:[0-9]+` @@ -53,49 +53,49 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CompatibleArchitectures ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [CompatibleArchitectures](#API_GetLayerVersionByArn_ResponseSyntax) ** A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Type: Array of strings Array Members: Maximum number of 2 items\. Valid Values:` x86_64 | arm64` - ** [ CompatibleRuntimes ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [CompatibleRuntimes](#API_GetLayerVersionByArn_ResponseSyntax) ** The layer's compatible runtimes\. Type: Array of strings Array Members: Maximum number of 15 items\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ Content ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [Content](#API_GetLayerVersionByArn_ResponseSyntax) ** Details about the layer version\. -Type: [ LayerVersionContentOutput ](API_LayerVersionContentOutput.md) object +Type: [LayerVersionContentOutput](API_LayerVersionContentOutput.md) object - ** [ CreatedDate ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [CreatedDate](#API_GetLayerVersionByArn_ResponseSyntax) ** The date that the layer version was created, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ Description ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [Description](#API_GetLayerVersionByArn_ResponseSyntax) ** The description of the version\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ LayerArn ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [LayerArn](#API_GetLayerVersionByArn_ResponseSyntax) ** The ARN of the layer\. Type: String 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-_]+` - ** [ LayerVersionArn ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [LayerVersionArn](#API_GetLayerVersionByArn_ResponseSyntax) ** The ARN of the layer version\. Type: String 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-_]+:[0-9]+` - ** [ LicenseInfo ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [LicenseInfo](#API_GetLayerVersionByArn_ResponseSyntax) ** The layer's software license\. Type: String Length Constraints: Maximum length of 512\. - ** [ Version ](#API_GetLayerVersionByArn_ResponseSyntax) ** + ** [Version](#API_GetLayerVersionByArn_ResponseSyntax) ** The version number\. Type: Long @@ -120,12 +120,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersionByArn) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersionByArn) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersionByArn) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersionByArn) \ No newline at end of file diff --git a/doc_source/API_GetLayerVersionPolicy.md b/doc_source/API_GetLayerVersionPolicy.md old mode 100644 new mode 100755 index 4fe6a68b..ad5f3319 --- a/doc_source/API_GetLayerVersionPolicy.md +++ b/doc_source/API_GetLayerVersionPolicy.md @@ -1,6 +1,6 @@ # GetLayerVersionPolicy -Returns the permission policy for a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. For more information, see [ AddLayerVersionPermission ](API_AddLayerVersionPermission.md)\. +Returns the permission policy for a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. For more information, see [AddLayerVersionPermission](API_AddLayerVersionPermission.md)\. ## Request Syntax @@ -12,13 +12,13 @@ GET /2018-10-31/layers/LayerName/versions/VersionNumber/policy HTTP/1.1 The request uses the following URI parameters\. - ** [ LayerName ](#API_GetLayerVersionPolicy_RequestSyntax) ** + ** [LayerName](#API_GetLayerVersionPolicy_RequestSyntax) ** 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 - ** [ VersionNumber ](#API_GetLayerVersionPolicy_RequestSyntax) ** + ** [VersionNumber](#API_GetLayerVersionPolicy_RequestSyntax) ** The version number\. Required: Yes @@ -44,11 +44,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Policy ](#API_GetLayerVersionPolicy_ResponseSyntax) ** + ** [Policy](#API_GetLayerVersionPolicy_ResponseSyntax) ** The policy document\. Type: String - ** [ RevisionId ](#API_GetLayerVersionPolicy_ResponseSyntax) ** + ** [RevisionId](#API_GetLayerVersionPolicy_ResponseSyntax) ** A unique identifier for the current revision of the policy\. Type: String @@ -73,12 +73,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersionPolicy) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersionPolicy) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetLayerVersionPolicy) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetLayerVersionPolicy) \ No newline at end of file diff --git a/doc_source/API_GetPolicy.md b/doc_source/API_GetPolicy.md old mode 100644 new mode 100755 index c8bac1f3..68add8e0 --- a/doc_source/API_GetPolicy.md +++ b/doc_source/API_GetPolicy.md @@ -12,7 +12,7 @@ GET /2015-03-31/functions/FunctionName/policy?Qualifier=Qualifier HTTP/1.1 The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetPolicy_RequestSyntax) ** + ** [FunctionName](#API_GetPolicy_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -24,7 +24,7 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\. 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_GetPolicy_RequestSyntax) ** + ** [Qualifier](#API_GetPolicy_RequestSyntax) ** Specify a version or alias to get the policy for that resource\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -51,11 +51,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Policy ](#API_GetPolicy_ResponseSyntax) ** + ** [Policy](#API_GetPolicy_ResponseSyntax) ** The resource\-based policy\. Type: String - ** [ RevisionId ](#API_GetPolicy_ResponseSyntax) ** + ** [RevisionId](#API_GetPolicy_ResponseSyntax) ** A unique identifier for the current revision of the policy\. Type: String @@ -80,12 +80,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetPolicy) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetPolicy) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetPolicy) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetPolicy) \ No newline at end of file diff --git a/doc_source/API_GetProvisionedConcurrencyConfig.md b/doc_source/API_GetProvisionedConcurrencyConfig.md old mode 100644 new mode 100755 index 16674dc4..b8da47c5 --- a/doc_source/API_GetProvisionedConcurrencyConfig.md +++ b/doc_source/API_GetProvisionedConcurrencyConfig.md @@ -12,7 +12,7 @@ GET /2019-09-30/functions/FunctionName/provisioned-concurrency?Qualifier=Qualifi The request uses the following URI parameters\. - ** [ FunctionName ](#API_GetProvisionedConcurrencyConfig_RequestSyntax) ** + ** [FunctionName](#API_GetProvisionedConcurrencyConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,7 +24,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_GetProvisionedConcurrencyConfig_RequestSyntax) ** + ** [Qualifier](#API_GetProvisionedConcurrencyConfig_RequestSyntax) ** The version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -56,31 +56,31 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ AllocatedProvisionedConcurrentExecutions ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [AllocatedProvisionedConcurrentExecutions](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency allocated\. Type: Integer Valid Range: Minimum value of 0\. - ** [ AvailableProvisionedConcurrentExecutions ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [AvailableProvisionedConcurrentExecutions](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency available\. Type: Integer Valid Range: Minimum value of 0\. - ** [ LastModified ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [LastModified](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** The date and time that a user last updated the configuration, in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)\. Type: String - ** [ RequestedProvisionedConcurrentExecutions ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [RequestedProvisionedConcurrentExecutions](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency requested\. Type: Integer Valid Range: Minimum value of 1\. - ** [ Status ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [Status](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** The status of the allocation process\. Type: String Valid Values:` IN_PROGRESS | READY | FAILED` - ** [ StatusReason ](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [StatusReason](#API_GetProvisionedConcurrencyConfig_ResponseSyntax) ** For failed allocations, the reason that provisioned concurrency could not be allocated\. Type: String @@ -109,12 +109,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/GetProvisionedConcurrencyConfig) \ No newline at end of file diff --git a/doc_source/API_ImageConfig.md b/doc_source/API_ImageConfig.md old mode 100644 new mode 100755 index 151d0ad7..a50ee895 --- a/doc_source/API_ImageConfig.md +++ b/doc_source/API_ImageConfig.md @@ -25,7 +25,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfig) \ No newline at end of file diff --git a/doc_source/API_ImageConfigError.md b/doc_source/API_ImageConfigError.md old mode 100644 new mode 100755 index f64556b5..9a1372b5 --- a/doc_source/API_ImageConfigError.md +++ b/doc_source/API_ImageConfigError.md @@ -17,7 +17,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfigError) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfigError) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfigError) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfigError) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfigError) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfigError) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfigError) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfigError) \ No newline at end of file diff --git a/doc_source/API_ImageConfigResponse.md b/doc_source/API_ImageConfigResponse.md old mode 100644 new mode 100755 index 3337f9ed..fdba6bfb --- a/doc_source/API_ImageConfigResponse.md +++ b/doc_source/API_ImageConfigResponse.md @@ -6,18 +6,18 @@ Response to GetFunctionConfiguration request\. ** Error ** Error response to GetFunctionConfiguration\. -Type: [ ImageConfigError ](API_ImageConfigError.md) object +Type: [ImageConfigError](API_ImageConfigError.md) object Required: No ** ImageConfig ** Configuration values that override the container image Dockerfile\. -Type: [ ImageConfig ](API_ImageConfig.md) object +Type: [ImageConfig](API_ImageConfig.md) object Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfigResponse) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfigResponse) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfigResponse) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfigResponse) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ImageConfigResponse) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ImageConfigResponse) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ImageConfigResponse) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ImageConfigResponse) \ No newline at end of file diff --git a/doc_source/API_Invoke.md b/doc_source/API_Invoke.md old mode 100644 new mode 100755 index 36f2c5ec..fbbf3396 --- a/doc_source/API_Invoke.md +++ b/doc_source/API_Invoke.md @@ -29,10 +29,10 @@ Payload The request uses the following URI parameters\. - ** [ ClientContext ](#API_Invoke_RequestSyntax) ** + ** [ClientContext](#API_Invoke_RequestSyntax) ** Up to 3583 bytes of base64\-encoded data about the invoking client to pass to the function in the context object\. - ** [ FunctionName ](#API_Invoke_RequestSyntax) ** + ** [FunctionName](#API_Invoke_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -44,18 +44,18 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\. 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 - ** [ InvocationType ](#API_Invoke_RequestSyntax) ** + ** [InvocationType](#API_Invoke_RequestSyntax) ** Choose from the following options\. + `RequestResponse` \(default\) \- Invoke the function synchronously\. Keep the connection open until the function returns a response or times out\. The API response includes the function response and additional data\. + `Event` \- Invoke the function asynchronously\. Send events that fail multiple times to the function's dead\-letter queue \(if it's configured\)\. The API response only includes a status code\. + `DryRun` \- Validate parameter values and verify that the user or role has permission to invoke the function\. Valid Values:` Event | RequestResponse | DryRun` - ** [ LogType ](#API_Invoke_RequestSyntax) ** + ** [LogType](#API_Invoke_RequestSyntax) ** Set to `Tail` to include the execution log in the response\. Applies to synchronously invoked functions only\. Valid Values:` None | Tail` - ** [ Qualifier ](#API_Invoke_RequestSyntax) ** + ** [Qualifier](#API_Invoke_RequestSyntax) ** Specify a version or alias to invoke a published version of the function\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -64,7 +64,7 @@ Pattern: `(|[a-zA-Z0-9$_-]+)` The request accepts the following binary data\. - ** [ Payload ](#API_Invoke_RequestSyntax) ** + ** [Payload](#API_Invoke_RequestSyntax) ** The JSON that you want to provide to your Lambda function as input\. You can enter the JSON directly\. For example, `--payload '{ "key": "value" }'`\. You can also specify a file path\. For example, `--payload file://payload.json`\. @@ -83,25 +83,25 @@ Payload If the action is successful, the service sends back the following HTTP response\. - ** [ StatusCode ](#API_Invoke_ResponseSyntax) ** + ** [StatusCode](#API_Invoke_ResponseSyntax) ** The HTTP status code is in the 200 range for a successful request\. For the `RequestResponse` invocation type, this status code is 200\. For the `Event` invocation type, this status code is 202\. For the `DryRun` invocation type, the status code is 204\. The response returns the following HTTP headers\. - ** [ ExecutedVersion ](#API_Invoke_ResponseSyntax) ** + ** [ExecutedVersion](#API_Invoke_ResponseSyntax) ** The version of the function that executed\. When you invoke a function with an alias, this indicates which version the alias resolved to\. Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ FunctionError ](#API_Invoke_ResponseSyntax) ** + ** [FunctionError](#API_Invoke_ResponseSyntax) ** If present, indicates that an error occurred during function execution\. Details about the error are included in the response payload\. - ** [ LogResult ](#API_Invoke_ResponseSyntax) ** + ** [LogResult](#API_Invoke_ResponseSyntax) ** The last 4 KB of the execution log, which is base64 encoded\. The response returns the following as the HTTP body\. - ** [ Payload ](#API_Invoke_ResponseSyntax) ** + ** [Payload](#API_Invoke_ResponseSyntax) ** The response from the function, or an error object\. ## Errors @@ -213,12 +213,12 @@ HTTP Status Code: 415 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/Invoke) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/Invoke) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Invoke) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Invoke) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Invoke) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/Invoke) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/Invoke) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/Invoke) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Invoke) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/Invoke) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/Invoke) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Invoke) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Invoke) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Invoke) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/Invoke) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/Invoke) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/Invoke) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Invoke) \ No newline at end of file diff --git a/doc_source/API_InvokeAsync.md b/doc_source/API_InvokeAsync.md old mode 100644 new mode 100755 index 0ed67594..8a6281c5 --- a/doc_source/API_InvokeAsync.md +++ b/doc_source/API_InvokeAsync.md @@ -3,7 +3,7 @@ *This action has been deprecated\.* **Important** -For asynchronous function invocation, use [ Invoke ](API_Invoke.md)\. +For asynchronous function invocation, use [Invoke](API_Invoke.md)\. Invokes a function asynchronously\. @@ -19,7 +19,7 @@ InvokeArgs The request uses the following URI parameters\. - ** [ FunctionName ](#API_InvokeAsync_RequestSyntax) ** + ** [FunctionName](#API_InvokeAsync_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -35,7 +35,7 @@ Required: Yes The request accepts the following binary data\. - ** [ InvokeArgs ](#API_InvokeAsync_RequestSyntax) ** + ** [InvokeArgs](#API_InvokeAsync_RequestSyntax) ** The JSON that you want to provide to your Lambda function as input\. Required: Yes @@ -49,7 +49,7 @@ HTTP/1.1 Status If the action is successful, the service sends back the following HTTP response\. - ** [ Status ](#API_InvokeAsync_ResponseSyntax) ** + ** [Status](#API_InvokeAsync_ResponseSyntax) ** The status code\. ## Errors @@ -77,12 +77,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/InvokeAsync) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/InvokeAsync) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/InvokeAsync) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/InvokeAsync) \ No newline at end of file diff --git a/doc_source/API_Layer.md b/doc_source/API_Layer.md old mode 100644 new mode 100755 index 8c2f129a..89f0c7a8 --- a/doc_source/API_Layer.md +++ b/doc_source/API_Layer.md @@ -1,6 +1,6 @@ # Layer -An [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. +An [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. ## Contents @@ -31,7 +31,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Layer) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Layer) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Layer) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Layer) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/Layer) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/Layer) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/Layer) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/Layer) \ No newline at end of file diff --git a/doc_source/API_LayerVersionContentInput.md b/doc_source/API_LayerVersionContentInput.md old mode 100644 new mode 100755 index 461e603b..3a7d97d3 --- a/doc_source/API_LayerVersionContentInput.md +++ b/doc_source/API_LayerVersionContentInput.md @@ -1,6 +1,6 @@ # LayerVersionContentInput -A ZIP archive that contains the contents of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. You can specify either an Amazon S3 location, or upload a layer archive directly\. +A ZIP archive that contains the contents of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. You can specify either an Amazon S3 location, or upload a layer archive directly\. ## Contents @@ -31,7 +31,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionContentInput) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionContentInput) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionContentInput) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionContentInput) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionContentInput) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionContentInput) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionContentInput) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionContentInput) \ No newline at end of file diff --git a/doc_source/API_LayerVersionContentOutput.md b/doc_source/API_LayerVersionContentOutput.md old mode 100644 new mode 100755 index a56a36b3..68c14788 --- a/doc_source/API_LayerVersionContentOutput.md +++ b/doc_source/API_LayerVersionContentOutput.md @@ -1,6 +1,6 @@ # LayerVersionContentOutput -Details about a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. +Details about a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. ## Contents @@ -32,7 +32,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionContentOutput) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionContentOutput) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionContentOutput) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionContentOutput) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionContentOutput) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionContentOutput) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionContentOutput) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionContentOutput) \ No newline at end of file diff --git a/doc_source/API_LayerVersionsListItem.md b/doc_source/API_LayerVersionsListItem.md old mode 100644 new mode 100755 index 06495845..a1128be9 --- a/doc_source/API_LayerVersionsListItem.md +++ b/doc_source/API_LayerVersionsListItem.md @@ -1,6 +1,6 @@ # LayerVersionsListItem -Details about a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. +Details about a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. ## Contents @@ -50,7 +50,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionsListItem) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionsListItem) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionsListItem) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionsListItem) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayerVersionsListItem) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayerVersionsListItem) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayerVersionsListItem) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayerVersionsListItem) \ No newline at end of file diff --git a/doc_source/API_LayersListItem.md b/doc_source/API_LayersListItem.md old mode 100644 new mode 100755 index 4064a303..76e34d54 --- a/doc_source/API_LayersListItem.md +++ b/doc_source/API_LayersListItem.md @@ -1,12 +1,12 @@ # LayersListItem -Details about an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. +Details about an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. ## Contents ** LatestMatchingVersion ** The newest version of the layer\. -Type: [ LayerVersionsListItem ](API_LayerVersionsListItem.md) object +Type: [LayerVersionsListItem](API_LayerVersionsListItem.md) object Required: No ** LayerArn ** @@ -26,7 +26,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayersListItem) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayersListItem) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayersListItem) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayersListItem) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/LayersListItem) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/LayersListItem) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/LayersListItem) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/LayersListItem) \ No newline at end of file diff --git a/doc_source/API_ListAliases.md b/doc_source/API_ListAliases.md old mode 100644 new mode 100755 index 96a8f132..e785f1fb --- a/doc_source/API_ListAliases.md +++ b/doc_source/API_ListAliases.md @@ -12,7 +12,7 @@ GET /2015-03-31/functions/FunctionName/aliases?FunctionVersion=FunctionVersion&M The request uses the following URI parameters\. - ** [ FunctionName ](#API_ListAliases_RequestSyntax) ** + ** [FunctionName](#API_ListAliases_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,15 +24,15 @@ 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 - ** [ FunctionVersion ](#API_ListAliases_RequestSyntax) ** + ** [FunctionVersion](#API_ListAliases_RequestSyntax) ** Specify a function version to only list aliases that invoke that version\. Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ Marker ](#API_ListAliases_RequestSyntax) ** + ** [Marker](#API_ListAliases_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListAliases_RequestSyntax) ** + ** [MaxItems](#API_ListAliases_RequestSyntax) ** Limit the number of aliases returned\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -71,11 +71,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Aliases ](#API_ListAliases_ResponseSyntax) ** + ** [Aliases](#API_ListAliases_ResponseSyntax) ** A list of aliases\. -Type: Array of [ AliasConfiguration ](API_AliasConfiguration.md) objects +Type: Array of [AliasConfiguration](API_AliasConfiguration.md) objects - ** [ NextMarker ](#API_ListAliases_ResponseSyntax) ** + ** [NextMarker](#API_ListAliases_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String @@ -100,12 +100,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListAliases) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListAliases) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListAliases) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListAliases) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListAliases) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListAliases) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListAliases) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListAliases) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListAliases) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListAliases) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListAliases) \ No newline at end of file diff --git a/doc_source/API_ListCodeSigningConfigs.md b/doc_source/API_ListCodeSigningConfigs.md old mode 100644 new mode 100755 index e5fcdff9..7e951ff5 --- a/doc_source/API_ListCodeSigningConfigs.md +++ b/doc_source/API_ListCodeSigningConfigs.md @@ -12,10 +12,10 @@ GET /2020-04-22/code-signing-configs/?Marker=Marker&MaxItems=MaxItems HTTP/1.1 The request uses the following URI parameters\. - ** [ Marker ](#API_ListCodeSigningConfigs_RequestSyntax) ** + ** [Marker](#API_ListCodeSigningConfigs_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListCodeSigningConfigs_RequestSyntax) ** + ** [MaxItems](#API_ListCodeSigningConfigs_RequestSyntax) ** Maximum number of items to return\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -54,11 +54,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfigs ](#API_ListCodeSigningConfigs_ResponseSyntax) ** + ** [CodeSigningConfigs](#API_ListCodeSigningConfigs_ResponseSyntax) ** The code signing configurations -Type: Array of [ CodeSigningConfig ](API_CodeSigningConfig.md) objects +Type: Array of [CodeSigningConfig](API_CodeSigningConfig.md) objects - ** [ NextMarker ](#API_ListCodeSigningConfigs_ResponseSyntax) ** + ** [NextMarker](#API_ListCodeSigningConfigs_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String @@ -75,12 +75,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListCodeSigningConfigs) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListCodeSigningConfigs) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListCodeSigningConfigs) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListCodeSigningConfigs) \ No newline at end of file diff --git a/doc_source/API_ListEventSourceMappings.md b/doc_source/API_ListEventSourceMappings.md old mode 100644 new mode 100755 index 05fffac7..4c9b3cc4 --- a/doc_source/API_ListEventSourceMappings.md +++ b/doc_source/API_ListEventSourceMappings.md @@ -12,7 +12,7 @@ GET /2015-03-31/event-source-mappings/?EventSourceArn=EventSourceArn&FunctionNam The request uses the following URI parameters\. - ** [ EventSourceArn ](#API_ListEventSourceMappings_RequestSyntax) ** + ** [EventSourceArn](#API_ListEventSourceMappings_RequestSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. + **Amazon Kinesis** \- The ARN of the data stream or a stream consumer\. + **Amazon DynamoDB Streams** \- The ARN of the stream\. @@ -20,7 +20,7 @@ The Amazon Resource Name \(ARN\) of the event source\. + **Amazon Managed Streaming for Apache Kafka** \- The ARN of the cluster\. Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ FunctionName ](#API_ListEventSourceMappings_RequestSyntax) ** + ** [FunctionName](#API_ListEventSourceMappings_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -32,10 +32,10 @@ The length constraint applies only to the full ARN\. If you specify only the fun 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-_]+))?` - ** [ Marker ](#API_ListEventSourceMappings_RequestSyntax) ** + ** [Marker](#API_ListEventSourceMappings_RequestSyntax) ** A pagination token returned by a previous call\. - ** [ MaxItems ](#API_ListEventSourceMappings_RequestSyntax) ** + ** [MaxItems](#API_ListEventSourceMappings_RequestSyntax) ** The maximum number of event source mappings to return\. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -63,6 +63,13 @@ Content-type: application/json } }, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionArn": "string", "FunctionResponseTypes": [ "string" ], "LastModified": number, @@ -102,11 +109,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ EventSourceMappings ](#API_ListEventSourceMappings_ResponseSyntax) ** + ** [EventSourceMappings](#API_ListEventSourceMappings_ResponseSyntax) ** A list of event source mappings\. -Type: Array of [ EventSourceMappingConfiguration ](API_EventSourceMappingConfiguration.md) objects +Type: Array of [EventSourceMappingConfiguration](API_EventSourceMappingConfiguration.md) objects - ** [ NextMarker ](#API_ListEventSourceMappings_ResponseSyntax) ** + ** [NextMarker](#API_ListEventSourceMappings_ResponseSyntax) ** A pagination token that's returned when the response doesn't contain all event source mappings\. Type: String @@ -131,12 +138,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListEventSourceMappings) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListEventSourceMappings) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListEventSourceMappings) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListEventSourceMappings) \ No newline at end of file diff --git a/doc_source/API_ListFunctionEventInvokeConfigs.md b/doc_source/API_ListFunctionEventInvokeConfigs.md old mode 100644 new mode 100755 index 86f29bc5..56f281a8 --- a/doc_source/API_ListFunctionEventInvokeConfigs.md +++ b/doc_source/API_ListFunctionEventInvokeConfigs.md @@ -2,7 +2,7 @@ Retrieves a list of configurations for asynchronous invocation for a function\. -To configure options for asynchronous invocation, use [ PutFunctionEventInvokeConfig ](API_PutFunctionEventInvokeConfig.md)\. +To configure options for asynchronous invocation, use [PutFunctionEventInvokeConfig](API_PutFunctionEventInvokeConfig.md)\. ## Request Syntax @@ -14,7 +14,7 @@ GET /2019-09-25/functions/FunctionName/event-invoke-config/list?Marker=Marker&Ma The request uses the following URI parameters\. - ** [ FunctionName ](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** + ** [FunctionName](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -26,10 +26,10 @@ 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 - ** [ Marker ](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** + ** [Marker](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** + ** [MaxItems](#API_ListFunctionEventInvokeConfigs_RequestSyntax) ** The maximum number of configurations to return\. Valid Range: Minimum value of 1\. Maximum value of 50\. @@ -70,11 +70,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ FunctionEventInvokeConfigs ](#API_ListFunctionEventInvokeConfigs_ResponseSyntax) ** + ** [FunctionEventInvokeConfigs](#API_ListFunctionEventInvokeConfigs_ResponseSyntax) ** A list of configurations\. -Type: Array of [ FunctionEventInvokeConfig ](API_FunctionEventInvokeConfig.md) objects +Type: Array of [FunctionEventInvokeConfig](API_FunctionEventInvokeConfig.md) objects - ** [ NextMarker ](#API_ListFunctionEventInvokeConfigs_ResponseSyntax) ** + ** [NextMarker](#API_ListFunctionEventInvokeConfigs_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String @@ -99,12 +99,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctionEventInvokeConfigs) \ No newline at end of file diff --git a/doc_source/API_ListFunctions.md b/doc_source/API_ListFunctions.md old mode 100644 new mode 100755 index 06195eff..507ab5ef --- a/doc_source/API_ListFunctions.md +++ b/doc_source/API_ListFunctions.md @@ -5,7 +5,7 @@ Returns a list of Lambda functions, with the version\-specific configuration of Set `FunctionVersion` to `ALL` to include all published versions of each function in addition to the unpublished version\. **Note** -The `ListFunctions` action returns a subset of the [ FunctionConfiguration ](API_FunctionConfiguration.md) fields\. To get the additional fields \(State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode\) for a function or version, use [ GetFunction ](API_GetFunction.md)\. +The `ListFunctions` action returns a subset of the [FunctionConfiguration](API_FunctionConfiguration.md) fields\. To get the additional fields \(State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode\) for a function or version, use [GetFunction](API_GetFunction.md)\. ## Request Syntax @@ -17,18 +17,18 @@ GET /2015-03-31/functions/?FunctionVersion=FunctionVersion&Marker=Marker&MasterR The request uses the following URI parameters\. - ** [ FunctionVersion ](#API_ListFunctions_RequestSyntax) ** + ** [FunctionVersion](#API_ListFunctions_RequestSyntax) ** Set to `ALL` to include entries for all published versions of each function\. Valid Values:` ALL` - ** [ Marker ](#API_ListFunctions_RequestSyntax) ** + ** [Marker](#API_ListFunctions_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MasterRegion ](#API_ListFunctions_RequestSyntax) ** + ** [MasterRegion](#API_ListFunctions_RequestSyntax) ** For Lambda@Edge functions, the AWS Region of the master function\. For example, `us-east-1` filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East \(N\. Virginia\)\. If specified, you must set `FunctionVersion` to `ALL`\. Pattern: `ALL|[a-z]{2}(-gov)?-[a-z]+-\d{1}` - ** [ MaxItems ](#API_ListFunctions_RequestSyntax) ** + ** [MaxItems](#API_ListFunctions_RequestSyntax) ** The maximum number of functions to return in the response\. Note that `ListFunctions` returns a maximum of 50 items in each response, even if you set the number higher\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -127,11 +127,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Functions ](#API_ListFunctions_ResponseSyntax) ** + ** [Functions](#API_ListFunctions_ResponseSyntax) ** A list of Lambda functions\. -Type: Array of [ FunctionConfiguration ](API_FunctionConfiguration.md) objects +Type: Array of [FunctionConfiguration](API_FunctionConfiguration.md) objects - ** [ NextMarker ](#API_ListFunctions_ResponseSyntax) ** + ** [NextMarker](#API_ListFunctions_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String @@ -152,12 +152,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctions) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctions) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctions) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctions) \ No newline at end of file diff --git a/doc_source/API_ListFunctionsByCodeSigningConfig.md b/doc_source/API_ListFunctionsByCodeSigningConfig.md old mode 100644 new mode 100755 index 04be90ec..60377544 --- a/doc_source/API_ListFunctionsByCodeSigningConfig.md +++ b/doc_source/API_ListFunctionsByCodeSigningConfig.md @@ -12,16 +12,16 @@ GET /2020-04-22/code-signing-configs/CodeSigningConfigArn/functions?Marker=Marke The request uses the following URI parameters\. - ** [ CodeSigningConfigArn ](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` Required: Yes - ** [ Marker ](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** + ** [Marker](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** + ** [MaxItems](#API_ListFunctionsByCodeSigningConfig_RequestSyntax) ** Maximum number of items to return\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -47,12 +47,12 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ FunctionArns ](#API_ListFunctionsByCodeSigningConfig_ResponseSyntax) ** + ** [FunctionArns](#API_ListFunctionsByCodeSigningConfig_ResponseSyntax) ** The function ARNs\. Type: Array of strings 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-_]+))?` - ** [ NextMarker ](#API_ListFunctionsByCodeSigningConfig_ResponseSyntax) ** + ** [NextMarker](#API_ListFunctionsByCodeSigningConfig_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String @@ -73,12 +73,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListFunctionsByCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_ListLayerVersions.md b/doc_source/API_ListLayerVersions.md old mode 100644 new mode 100755 index 76259787..c5d0bf21 --- a/doc_source/API_ListLayerVersions.md +++ b/doc_source/API_ListLayerVersions.md @@ -1,6 +1,6 @@ # ListLayerVersions -Lists the versions of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. Versions that have been deleted aren't listed\. Specify a [runtime identifier](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only versions that indicate that they're compatible with that runtime\. Specify a compatible architecture to include only layer versions that are compatible with that architecture\. +Lists the versions of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. Versions that have been deleted aren't listed\. Specify a [runtime identifier](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only versions that indicate that they're compatible with that runtime\. Specify a compatible architecture to include only layer versions that are compatible with that architecture\. ## Request Syntax @@ -12,24 +12,24 @@ GET /2018-10-31/layers/LayerName/versions?CompatibleArchitecture=CompatibleArchi The request uses the following URI parameters\. - ** [ CompatibleArchitecture ](#API_ListLayerVersions_RequestSyntax) ** + ** [CompatibleArchitecture](#API_ListLayerVersions_RequestSyntax) ** The compatible [instruction set architecture](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Valid Values:` x86_64 | arm64` - ** [ CompatibleRuntime ](#API_ListLayerVersions_RequestSyntax) ** + ** [CompatibleRuntime](#API_ListLayerVersions_RequestSyntax) ** A runtime identifier\. For example, `go1.x`\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ LayerName ](#API_ListLayerVersions_RequestSyntax) ** + ** [LayerName](#API_ListLayerVersions_RequestSyntax) ** 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 - ** [ Marker ](#API_ListLayerVersions_RequestSyntax) ** + ** [Marker](#API_ListLayerVersions_RequestSyntax) ** A pagination token returned by a previous call\. - ** [ MaxItems ](#API_ListLayerVersions_RequestSyntax) ** + ** [MaxItems](#API_ListLayerVersions_RequestSyntax) ** The maximum number of versions to return\. Valid Range: Minimum value of 1\. Maximum value of 50\. @@ -65,11 +65,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ LayerVersions ](#API_ListLayerVersions_ResponseSyntax) ** + ** [LayerVersions](#API_ListLayerVersions_ResponseSyntax) ** A list of versions\. -Type: Array of [ LayerVersionsListItem ](API_LayerVersionsListItem.md) objects +Type: Array of [LayerVersionsListItem](API_LayerVersionsListItem.md) objects - ** [ NextMarker ](#API_ListLayerVersions_ResponseSyntax) ** + ** [NextMarker](#API_ListLayerVersions_ResponseSyntax) ** A pagination token returned when the response doesn't contain all versions\. Type: String @@ -94,12 +94,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListLayerVersions) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListLayerVersions) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListLayerVersions) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListLayerVersions) \ No newline at end of file diff --git a/doc_source/API_ListLayers.md b/doc_source/API_ListLayers.md old mode 100644 new mode 100755 index a95db624..a8379dd6 --- a/doc_source/API_ListLayers.md +++ b/doc_source/API_ListLayers.md @@ -1,6 +1,6 @@ # ListLayers -Lists [ AWS Lambda layers](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html) and shows information about the latest version of each\. Specify a [runtime identifier](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only layers that indicate that they're compatible with that runtime\. Specify a compatible architecture to include only layers that are compatible with that [instruction set architecture](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. +Lists [AWS Lambda layers](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html) and shows information about the latest version of each\. Specify a [runtime identifier](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only layers that indicate that they're compatible with that runtime\. Specify a compatible architecture to include only layers that are compatible with that [instruction set architecture](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. ## Request Syntax @@ -12,18 +12,18 @@ GET /2018-10-31/layers?CompatibleArchitecture=CompatibleArchitecture&CompatibleR The request uses the following URI parameters\. - ** [ CompatibleArchitecture ](#API_ListLayers_RequestSyntax) ** + ** [CompatibleArchitecture](#API_ListLayers_RequestSyntax) ** The compatible [instruction set architecture](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Valid Values:` x86_64 | arm64` - ** [ CompatibleRuntime ](#API_ListLayers_RequestSyntax) ** + ** [CompatibleRuntime](#API_ListLayers_RequestSyntax) ** A runtime identifier\. For example, `go1.x`\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ Marker ](#API_ListLayers_RequestSyntax) ** + ** [Marker](#API_ListLayers_RequestSyntax) ** A pagination token returned by a previous call\. - ** [ MaxItems ](#API_ListLayers_RequestSyntax) ** + ** [MaxItems](#API_ListLayers_RequestSyntax) ** The maximum number of layers to return\. Valid Range: Minimum value of 1\. Maximum value of 50\. @@ -63,11 +63,11 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Layers ](#API_ListLayers_ResponseSyntax) ** + ** [Layers](#API_ListLayers_ResponseSyntax) ** A list of function layers\. -Type: Array of [ LayersListItem ](API_LayersListItem.md) objects +Type: Array of [LayersListItem](API_LayersListItem.md) objects - ** [ NextMarker ](#API_ListLayers_ResponseSyntax) ** + ** [NextMarker](#API_ListLayers_ResponseSyntax) ** A pagination token returned when the response doesn't contain all layers\. Type: String @@ -88,12 +88,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListLayers) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListLayers) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListLayers) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListLayers) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListLayers) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListLayers) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListLayers) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListLayers) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListLayers) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListLayers) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListLayers) \ No newline at end of file diff --git a/doc_source/API_ListProvisionedConcurrencyConfigs.md b/doc_source/API_ListProvisionedConcurrencyConfigs.md old mode 100644 new mode 100755 index bd1e9916..e05f6c95 --- a/doc_source/API_ListProvisionedConcurrencyConfigs.md +++ b/doc_source/API_ListProvisionedConcurrencyConfigs.md @@ -12,7 +12,7 @@ GET /2019-09-30/functions/FunctionName/provisioned-concurrency?List=ALL&Marker=M The request uses the following URI parameters\. - ** [ FunctionName ](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** + ** [FunctionName](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,10 +24,10 @@ 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 - ** [ Marker ](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** + ** [Marker](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** + ** [MaxItems](#API_ListProvisionedConcurrencyConfigs_RequestSyntax) ** Specify a number to limit the number of configurations returned\. Valid Range: Minimum value of 1\. Maximum value of 50\. @@ -63,13 +63,13 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ NextMarker ](#API_ListProvisionedConcurrencyConfigs_ResponseSyntax) ** + ** [NextMarker](#API_ListProvisionedConcurrencyConfigs_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String - ** [ ProvisionedConcurrencyConfigs ](#API_ListProvisionedConcurrencyConfigs_ResponseSyntax) ** + ** [ProvisionedConcurrencyConfigs](#API_ListProvisionedConcurrencyConfigs_ResponseSyntax) ** A list of provisioned concurrency configurations\. -Type: Array of [ ProvisionedConcurrencyConfigListItem ](API_ProvisionedConcurrencyConfigListItem.md) objects +Type: Array of [ProvisionedConcurrencyConfigListItem](API_ProvisionedConcurrencyConfigListItem.md) objects ## Errors @@ -92,12 +92,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListProvisionedConcurrencyConfigs) \ No newline at end of file diff --git a/doc_source/API_ListTags.md b/doc_source/API_ListTags.md old mode 100644 new mode 100755 index 394361bc..bf96edde --- a/doc_source/API_ListTags.md +++ b/doc_source/API_ListTags.md @@ -1,6 +1,6 @@ # ListTags -Returns a function's [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)\. You can also view tags with [ GetFunction ](API_GetFunction.md)\. +Returns a function's [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)\. You can also view tags with [GetFunction](API_GetFunction.md)\. ## Request Syntax @@ -12,7 +12,7 @@ GET /2017-03-31/tags/ARN HTTP/1.1 The request uses the following URI parameters\. - ** [ ARN ](#API_ListTags_RequestSyntax) ** + ** [ARN](#API_ListTags_RequestSyntax) ** The function's Amazon Resource Name \(ARN\)\. Note: Lambda does not support adding tags to aliases or versions\. 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 @@ -40,7 +40,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Tags ](#API_ListTags_ResponseSyntax) ** + ** [Tags](#API_ListTags_ResponseSyntax) ** The function's tags\. Type: String to string map @@ -65,12 +65,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListTags) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListTags) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListTags) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListTags) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListTags) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListTags) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListTags) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListTags) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListTags) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListTags) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListTags) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListTags) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListTags) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListTags) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListTags) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListTags) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListTags) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListTags) \ No newline at end of file diff --git a/doc_source/API_ListVersionsByFunction.md b/doc_source/API_ListVersionsByFunction.md old mode 100644 new mode 100755 index ad35ed08..fe5215a2 --- a/doc_source/API_ListVersionsByFunction.md +++ b/doc_source/API_ListVersionsByFunction.md @@ -12,7 +12,7 @@ GET /2015-03-31/functions/FunctionName/versions?Marker=Marker&MaxItems=MaxItems The request uses the following URI parameters\. - ** [ FunctionName ](#API_ListVersionsByFunction_RequestSyntax) ** + ** [FunctionName](#API_ListVersionsByFunction_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -24,10 +24,10 @@ Length Constraints: Minimum length of 1\. Maximum length of 170\. 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 - ** [ Marker ](#API_ListVersionsByFunction_RequestSyntax) ** + ** [Marker](#API_ListVersionsByFunction_RequestSyntax) ** Specify the pagination token that's returned by a previous request to retrieve the next page of results\. - ** [ MaxItems ](#API_ListVersionsByFunction_RequestSyntax) ** + ** [MaxItems](#API_ListVersionsByFunction_RequestSyntax) ** The maximum number of versions to return\. Note that `ListVersionsByFunction` returns a maximum of 50 items in each response, even if you set the number higher\. Valid Range: Minimum value of 1\. Maximum value of 10000\. @@ -126,13 +126,13 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ NextMarker ](#API_ListVersionsByFunction_ResponseSyntax) ** + ** [NextMarker](#API_ListVersionsByFunction_ResponseSyntax) ** The pagination token that's included if more results are available\. Type: String - ** [ Versions ](#API_ListVersionsByFunction_ResponseSyntax) ** + ** [Versions](#API_ListVersionsByFunction_ResponseSyntax) ** A list of Lambda function versions\. -Type: Array of [ FunctionConfiguration ](API_FunctionConfiguration.md) objects +Type: Array of [FunctionConfiguration](API_FunctionConfiguration.md) objects ## Errors @@ -155,12 +155,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListVersionsByFunction) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListVersionsByFunction) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/ListVersionsByFunction) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ListVersionsByFunction) \ No newline at end of file diff --git a/doc_source/API_OnFailure.md b/doc_source/API_OnFailure.md old mode 100644 new mode 100755 index e85b7838..6bb084a9 --- a/doc_source/API_OnFailure.md +++ b/doc_source/API_OnFailure.md @@ -14,7 +14,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/OnFailure) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/OnFailure) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/OnFailure) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/OnFailure) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/OnFailure) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/OnFailure) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/OnFailure) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/OnFailure) \ No newline at end of file diff --git a/doc_source/API_OnSuccess.md b/doc_source/API_OnSuccess.md old mode 100644 new mode 100755 index 5447b3fa..7dd22ba6 --- a/doc_source/API_OnSuccess.md +++ b/doc_source/API_OnSuccess.md @@ -14,7 +14,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/OnSuccess) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/OnSuccess) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/OnSuccess) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/OnSuccess) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/OnSuccess) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/OnSuccess) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/OnSuccess) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/OnSuccess) \ No newline at end of file diff --git a/doc_source/API_Operations.md b/doc_source/API_Operations.md old mode 100644 new mode 100755 index 8c67257d..70a90b0c --- a/doc_source/API_Operations.md +++ b/doc_source/API_Operations.md @@ -1,61 +1,61 @@ # Actions The following actions are supported: -+ [ AddLayerVersionPermission ](API_AddLayerVersionPermission.md) -+ [ AddPermission ](API_AddPermission.md) -+ [ CreateAlias ](API_CreateAlias.md) -+ [ CreateCodeSigningConfig ](API_CreateCodeSigningConfig.md) -+ [ CreateEventSourceMapping ](API_CreateEventSourceMapping.md) -+ [ CreateFunction ](API_CreateFunction.md) -+ [ DeleteAlias ](API_DeleteAlias.md) -+ [ DeleteCodeSigningConfig ](API_DeleteCodeSigningConfig.md) -+ [ DeleteEventSourceMapping ](API_DeleteEventSourceMapping.md) -+ [ DeleteFunction ](API_DeleteFunction.md) -+ [ DeleteFunctionCodeSigningConfig ](API_DeleteFunctionCodeSigningConfig.md) -+ [ DeleteFunctionConcurrency ](API_DeleteFunctionConcurrency.md) -+ [ DeleteFunctionEventInvokeConfig ](API_DeleteFunctionEventInvokeConfig.md) -+ [ DeleteLayerVersion ](API_DeleteLayerVersion.md) -+ [ DeleteProvisionedConcurrencyConfig ](API_DeleteProvisionedConcurrencyConfig.md) -+ [ GetAccountSettings ](API_GetAccountSettings.md) -+ [ GetAlias ](API_GetAlias.md) -+ [ GetCodeSigningConfig ](API_GetCodeSigningConfig.md) -+ [ GetEventSourceMapping ](API_GetEventSourceMapping.md) -+ [ GetFunction ](API_GetFunction.md) -+ [ GetFunctionCodeSigningConfig ](API_GetFunctionCodeSigningConfig.md) -+ [ GetFunctionConcurrency ](API_GetFunctionConcurrency.md) -+ [ GetFunctionConfiguration ](API_GetFunctionConfiguration.md) -+ [ GetFunctionEventInvokeConfig ](API_GetFunctionEventInvokeConfig.md) -+ [ GetLayerVersion ](API_GetLayerVersion.md) -+ [ GetLayerVersionByArn ](API_GetLayerVersionByArn.md) -+ [ GetLayerVersionPolicy ](API_GetLayerVersionPolicy.md) -+ [ GetPolicy ](API_GetPolicy.md) -+ [ GetProvisionedConcurrencyConfig ](API_GetProvisionedConcurrencyConfig.md) -+ [ Invoke ](API_Invoke.md) -+ [ InvokeAsync ](API_InvokeAsync.md) -+ [ ListAliases ](API_ListAliases.md) -+ [ ListCodeSigningConfigs ](API_ListCodeSigningConfigs.md) -+ [ ListEventSourceMappings ](API_ListEventSourceMappings.md) -+ [ ListFunctionEventInvokeConfigs ](API_ListFunctionEventInvokeConfigs.md) -+ [ ListFunctions ](API_ListFunctions.md) -+ [ ListFunctionsByCodeSigningConfig ](API_ListFunctionsByCodeSigningConfig.md) -+ [ ListLayers ](API_ListLayers.md) -+ [ ListLayerVersions ](API_ListLayerVersions.md) -+ [ ListProvisionedConcurrencyConfigs ](API_ListProvisionedConcurrencyConfigs.md) -+ [ ListTags ](API_ListTags.md) -+ [ ListVersionsByFunction ](API_ListVersionsByFunction.md) -+ [ PublishLayerVersion ](API_PublishLayerVersion.md) -+ [ PublishVersion ](API_PublishVersion.md) -+ [ PutFunctionCodeSigningConfig ](API_PutFunctionCodeSigningConfig.md) -+ [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md) -+ [ PutFunctionEventInvokeConfig ](API_PutFunctionEventInvokeConfig.md) -+ [ PutProvisionedConcurrencyConfig ](API_PutProvisionedConcurrencyConfig.md) -+ [ RemoveLayerVersionPermission ](API_RemoveLayerVersionPermission.md) -+ [ RemovePermission ](API_RemovePermission.md) -+ [ TagResource ](API_TagResource.md) -+ [ UntagResource ](API_UntagResource.md) -+ [ UpdateAlias ](API_UpdateAlias.md) -+ [ UpdateCodeSigningConfig ](API_UpdateCodeSigningConfig.md) -+ [ UpdateEventSourceMapping ](API_UpdateEventSourceMapping.md) -+ [ UpdateFunctionCode ](API_UpdateFunctionCode.md) -+ [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md) -+ [ UpdateFunctionEventInvokeConfig ](API_UpdateFunctionEventInvokeConfig.md) \ No newline at end of file ++ [AddLayerVersionPermission](API_AddLayerVersionPermission.md) ++ [AddPermission](API_AddPermission.md) ++ [CreateAlias](API_CreateAlias.md) ++ [CreateCodeSigningConfig](API_CreateCodeSigningConfig.md) ++ [CreateEventSourceMapping](API_CreateEventSourceMapping.md) ++ [CreateFunction](API_CreateFunction.md) ++ [DeleteAlias](API_DeleteAlias.md) ++ [DeleteCodeSigningConfig](API_DeleteCodeSigningConfig.md) ++ [DeleteEventSourceMapping](API_DeleteEventSourceMapping.md) ++ [DeleteFunction](API_DeleteFunction.md) ++ [DeleteFunctionCodeSigningConfig](API_DeleteFunctionCodeSigningConfig.md) ++ [DeleteFunctionConcurrency](API_DeleteFunctionConcurrency.md) ++ [DeleteFunctionEventInvokeConfig](API_DeleteFunctionEventInvokeConfig.md) ++ [DeleteLayerVersion](API_DeleteLayerVersion.md) ++ [DeleteProvisionedConcurrencyConfig](API_DeleteProvisionedConcurrencyConfig.md) ++ [GetAccountSettings](API_GetAccountSettings.md) ++ [GetAlias](API_GetAlias.md) ++ [GetCodeSigningConfig](API_GetCodeSigningConfig.md) ++ [GetEventSourceMapping](API_GetEventSourceMapping.md) ++ [GetFunction](API_GetFunction.md) ++ [GetFunctionCodeSigningConfig](API_GetFunctionCodeSigningConfig.md) ++ [GetFunctionConcurrency](API_GetFunctionConcurrency.md) ++ [GetFunctionConfiguration](API_GetFunctionConfiguration.md) ++ [GetFunctionEventInvokeConfig](API_GetFunctionEventInvokeConfig.md) ++ [GetLayerVersion](API_GetLayerVersion.md) ++ [GetLayerVersionByArn](API_GetLayerVersionByArn.md) ++ [GetLayerVersionPolicy](API_GetLayerVersionPolicy.md) ++ [GetPolicy](API_GetPolicy.md) ++ [GetProvisionedConcurrencyConfig](API_GetProvisionedConcurrencyConfig.md) ++ [Invoke](API_Invoke.md) ++ [InvokeAsync](API_InvokeAsync.md) ++ [ListAliases](API_ListAliases.md) ++ [ListCodeSigningConfigs](API_ListCodeSigningConfigs.md) ++ [ListEventSourceMappings](API_ListEventSourceMappings.md) ++ [ListFunctionEventInvokeConfigs](API_ListFunctionEventInvokeConfigs.md) ++ [ListFunctions](API_ListFunctions.md) ++ [ListFunctionsByCodeSigningConfig](API_ListFunctionsByCodeSigningConfig.md) ++ [ListLayers](API_ListLayers.md) ++ [ListLayerVersions](API_ListLayerVersions.md) ++ [ListProvisionedConcurrencyConfigs](API_ListProvisionedConcurrencyConfigs.md) ++ [ListTags](API_ListTags.md) ++ [ListVersionsByFunction](API_ListVersionsByFunction.md) ++ [PublishLayerVersion](API_PublishLayerVersion.md) ++ [PublishVersion](API_PublishVersion.md) ++ [PutFunctionCodeSigningConfig](API_PutFunctionCodeSigningConfig.md) ++ [PutFunctionConcurrency](API_PutFunctionConcurrency.md) ++ [PutFunctionEventInvokeConfig](API_PutFunctionEventInvokeConfig.md) ++ [PutProvisionedConcurrencyConfig](API_PutProvisionedConcurrencyConfig.md) ++ [RemoveLayerVersionPermission](API_RemoveLayerVersionPermission.md) ++ [RemovePermission](API_RemovePermission.md) ++ [TagResource](API_TagResource.md) ++ [UntagResource](API_UntagResource.md) ++ [UpdateAlias](API_UpdateAlias.md) ++ [UpdateCodeSigningConfig](API_UpdateCodeSigningConfig.md) ++ [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) ++ [UpdateFunctionCode](API_UpdateFunctionCode.md) ++ [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md) ++ [UpdateFunctionEventInvokeConfig](API_UpdateFunctionEventInvokeConfig.md) \ No newline at end of file diff --git a/doc_source/API_ProvisionedConcurrencyConfigListItem.md b/doc_source/API_ProvisionedConcurrencyConfigListItem.md old mode 100644 new mode 100755 index 4f1830eb..71a88d0f --- a/doc_source/API_ProvisionedConcurrencyConfigListItem.md +++ b/doc_source/API_ProvisionedConcurrencyConfigListItem.md @@ -47,7 +47,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/ProvisionedConcurrencyConfigListItem) \ No newline at end of file diff --git a/doc_source/API_PublishLayerVersion.md b/doc_source/API_PublishLayerVersion.md old mode 100644 new mode 100755 index 2c9adb46..90016955 --- a/doc_source/API_PublishLayerVersion.md +++ b/doc_source/API_PublishLayerVersion.md @@ -1,8 +1,8 @@ # PublishLayerVersion -Creates an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive\. Each time you call `PublishLayerVersion` with the same layer name, a new version is created\. +Creates an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive\. Each time you call `PublishLayerVersion` with the same layer name, a new version is created\. -Add layers to your function with [ CreateFunction ](API_CreateFunction.md) or [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md)\. +Add layers to your function with [CreateFunction](API_CreateFunction.md) or [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md)\. ## Request Syntax @@ -28,7 +28,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ LayerName ](#API_PublishLayerVersion_RequestSyntax) ** + ** [LayerName](#API_PublishLayerVersion_RequestSyntax) ** 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-_]+` @@ -38,32 +38,32 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ CompatibleArchitectures ](#API_PublishLayerVersion_RequestSyntax) ** + ** [CompatibleArchitectures](#API_PublishLayerVersion_RequestSyntax) ** A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Type: Array of strings Array Members: Maximum number of 2 items\. Valid Values:` x86_64 | arm64` Required: No - ** [ CompatibleRuntimes ](#API_PublishLayerVersion_RequestSyntax) ** -A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. Used for filtering with [ ListLayers ](API_ListLayers.md) and [ ListLayerVersions ](API_ListLayerVersions.md)\. + ** [CompatibleRuntimes](#API_PublishLayerVersion_RequestSyntax) ** +A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. Used for filtering with [ListLayers](API_ListLayers.md) and [ListLayerVersions](API_ListLayerVersions.md)\. Type: Array of strings Array Members: Maximum number of 15 items\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` Required: No - ** [ Content ](#API_PublishLayerVersion_RequestSyntax) ** + ** [Content](#API_PublishLayerVersion_RequestSyntax) ** The function layer archive\. -Type: [ LayerVersionContentInput ](API_LayerVersionContentInput.md) object +Type: [LayerVersionContentInput](API_LayerVersionContentInput.md) object Required: Yes - ** [ Description ](#API_PublishLayerVersion_RequestSyntax) ** + ** [Description](#API_PublishLayerVersion_RequestSyntax) ** The description of the version\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ LicenseInfo ](#API_PublishLayerVersion_RequestSyntax) ** + ** [LicenseInfo](#API_PublishLayerVersion_RequestSyntax) ** The layer's software license\. It can be any of the following: + An [SPDX license identifier](https://spdx.org/licenses/)\. For example, `MIT`\. + The URL of a license hosted on the internet\. For example, `https://opensource.org/licenses/MIT`\. @@ -103,49 +103,49 @@ If the action is successful, the service sends back an HTTP 201 response\. The following data is returned in JSON format by the service\. - ** [ CompatibleArchitectures ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [CompatibleArchitectures](#API_PublishLayerVersion_ResponseSyntax) ** A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)\. Type: Array of strings Array Members: Maximum number of 2 items\. Valid Values:` x86_64 | arm64` - ** [ CompatibleRuntimes ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [CompatibleRuntimes](#API_PublishLayerVersion_ResponseSyntax) ** The layer's compatible runtimes\. Type: Array of strings Array Members: Maximum number of 15 items\. Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ Content ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [Content](#API_PublishLayerVersion_ResponseSyntax) ** Details about the layer version\. -Type: [ LayerVersionContentOutput ](API_LayerVersionContentOutput.md) object +Type: [LayerVersionContentOutput](API_LayerVersionContentOutput.md) object - ** [ CreatedDate ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [CreatedDate](#API_PublishLayerVersion_ResponseSyntax) ** The date that the layer version was created, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ Description ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [Description](#API_PublishLayerVersion_ResponseSyntax) ** The description of the version\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ LayerArn ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [LayerArn](#API_PublishLayerVersion_ResponseSyntax) ** The ARN of the layer\. Type: String 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-_]+` - ** [ LayerVersionArn ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [LayerVersionArn](#API_PublishLayerVersion_ResponseSyntax) ** The ARN of the layer version\. Type: String 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-_]+:[0-9]+` - ** [ LicenseInfo ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [LicenseInfo](#API_PublishLayerVersion_ResponseSyntax) ** The layer's software license\. Type: String Length Constraints: Maximum length of 512\. - ** [ Version ](#API_PublishLayerVersion_ResponseSyntax) ** + ** [Version](#API_PublishLayerVersion_ResponseSyntax) ** The version number\. Type: Long @@ -174,12 +174,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PublishLayerVersion) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PublishLayerVersion) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PublishLayerVersion) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PublishLayerVersion) \ No newline at end of file diff --git a/doc_source/API_PublishVersion.md b/doc_source/API_PublishVersion.md old mode 100644 new mode 100755 index 12c42030..b7ef43ae --- a/doc_source/API_PublishVersion.md +++ b/doc_source/API_PublishVersion.md @@ -2,9 +2,9 @@ Creates a [version](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) from the current code and configuration of a function\. Use versions to create a snapshot of your function code and configuration that doesn't change\. - AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version\. Use [ UpdateFunctionCode ](API_UpdateFunctionCode.md) or [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md) to update the function before publishing a version\. + AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version\. Use [UpdateFunctionCode](API_UpdateFunctionCode.md) or [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md) to update the function before publishing a version\. -Clients can invoke versions directly or with an alias\. To create an alias, use [ CreateAlias ](API_CreateAlias.md)\. +Clients can invoke versions directly or with an alias\. To create an alias, use [CreateAlias](API_CreateAlias.md)\. ## Request Syntax @@ -23,7 +23,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_PublishVersion_RequestSyntax) ** + ** [FunctionName](#API_PublishVersion_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -39,18 +39,18 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ CodeSha256 ](#API_PublishVersion_RequestSyntax) ** -Only publish a version if the hash value matches the value that's specified\. Use this option to avoid publishing a version if the function code has changed since you last updated it\. You can get the hash for the version that you uploaded from the output of [ UpdateFunctionCode ](API_UpdateFunctionCode.md)\. + ** [CodeSha256](#API_PublishVersion_RequestSyntax) ** +Only publish a version if the hash value matches the value that's specified\. Use this option to avoid publishing a version if the function code has changed since you last updated it\. You can get the hash for the version that you uploaded from the output of [UpdateFunctionCode](API_UpdateFunctionCode.md)\. Type: String Required: No - ** [ Description ](#API_PublishVersion_RequestSyntax) ** + ** [Description](#API_PublishVersion_RequestSyntax) ** A description for the version to override the description in the function configuration\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ RevisionId ](#API_PublishVersion_RequestSyntax) ** + ** [RevisionId](#API_PublishVersion_RequestSyntax) ** Only update the function if the revision ID matches the ID that's specified\. Use this option to avoid publishing a version if the function configuration has changed since you last updated it\. Type: String Required: No @@ -141,157 +141,157 @@ If the action is successful, the service sends back an HTTP 201 response\. The following data is returned in JSON format by the service\. - ** [ Architectures ](#API_PublishVersion_ResponseSyntax) ** + ** [Architectures](#API_PublishVersion_ResponseSyntax) ** The instruction set architecture that the function supports\. Architecture is a string array with one of the valid values\. The default architecture value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` - ** [ CodeSha256 ](#API_PublishVersion_ResponseSyntax) ** + ** [CodeSha256](#API_PublishVersion_ResponseSyntax) ** The SHA256 hash of the function's deployment package\. Type: String - ** [ CodeSize ](#API_PublishVersion_ResponseSyntax) ** + ** [CodeSize](#API_PublishVersion_ResponseSyntax) ** The size of the function's deployment package, in bytes\. Type: Long - ** [ DeadLetterConfig ](#API_PublishVersion_ResponseSyntax) ** + ** [DeadLetterConfig](#API_PublishVersion_ResponseSyntax) ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object - ** [ Description ](#API_PublishVersion_ResponseSyntax) ** + ** [Description](#API_PublishVersion_ResponseSyntax) ** The function's description\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ Environment ](#API_PublishVersion_ResponseSyntax) ** + ** [Environment](#API_PublishVersion_ResponseSyntax) ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object - ** [ FileSystemConfigs ](#API_PublishVersion_ResponseSyntax) ** + ** [FileSystemConfigs](#API_PublishVersion_ResponseSyntax) ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. - ** [ FunctionArn ](#API_PublishVersion_ResponseSyntax) ** + ** [FunctionArn](#API_PublishVersion_ResponseSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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-_]+))?` - ** [ FunctionName ](#API_PublishVersion_ResponseSyntax) ** + ** [FunctionName](#API_PublishVersion_ResponseSyntax) ** The name of the function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 170\. 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-_]+))?` - ** [ Handler ](#API_PublishVersion_ResponseSyntax) ** + ** [Handler](#API_PublishVersion_ResponseSyntax) ** The function that Lambda calls to begin executing your function\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` - ** [ ImageConfigResponse ](#API_PublishVersion_ResponseSyntax) ** + ** [ImageConfigResponse](#API_PublishVersion_ResponseSyntax) ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object - ** [ KMSKeyArn ](#API_PublishVersion_ResponseSyntax) ** + ** [KMSKeyArn](#API_PublishVersion_ResponseSyntax) ** The AWS KMS key that's used to encrypt the function's environment variables\. This key is only returned if you've configured a customer managed key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` - ** [ LastModified ](#API_PublishVersion_ResponseSyntax) ** + ** [LastModified](#API_PublishVersion_ResponseSyntax) ** The date and time that the function was last updated, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ LastUpdateStatus ](#API_PublishVersion_ResponseSyntax) ** + ** [LastUpdateStatus](#API_PublishVersion_ResponseSyntax) ** The status of the last update that was performed on the function\. This is first set to `Successful` after function creation completes\. Type: String Valid Values:` Successful | Failed | InProgress` - ** [ LastUpdateStatusReason ](#API_PublishVersion_ResponseSyntax) ** + ** [LastUpdateStatusReason](#API_PublishVersion_ResponseSyntax) ** The reason for the last update that was performed on the function\. Type: String - ** [ LastUpdateStatusReasonCode ](#API_PublishVersion_ResponseSyntax) ** + ** [LastUpdateStatusReasonCode](#API_PublishVersion_ResponseSyntax) ** The reason code for the last update that was performed on the function\. Type: String Valid Values:` EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Layers ](#API_PublishVersion_ResponseSyntax) ** + ** [Layers](#API_PublishVersion_ResponseSyntax) ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects - ** [ MasterArn ](#API_PublishVersion_ResponseSyntax) ** + ** [MasterArn](#API_PublishVersion_ResponseSyntax) ** For Lambda@Edge functions, the ARN of the main function\. 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-_]+))?` - ** [ MemorySize ](#API_PublishVersion_ResponseSyntax) ** + ** [MemorySize](#API_PublishVersion_ResponseSyntax) ** The amount of memory available to the function at runtime\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. - ** [ PackageType ](#API_PublishVersion_ResponseSyntax) ** + ** [PackageType](#API_PublishVersion_ResponseSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for \.zip file archive\. Type: String Valid Values:` Zip | Image` - ** [ RevisionId ](#API_PublishVersion_ResponseSyntax) ** + ** [RevisionId](#API_PublishVersion_ResponseSyntax) ** The latest updated revision of the function or alias\. Type: String - ** [ Role ](#API_PublishVersion_ResponseSyntax) ** + ** [Role](#API_PublishVersion_ResponseSyntax) ** The function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` - ** [ Runtime ](#API_PublishVersion_ResponseSyntax) ** + ** [Runtime](#API_PublishVersion_ResponseSyntax) ** The runtime environment for the Lambda function\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ SigningJobArn ](#API_PublishVersion_ResponseSyntax) ** + ** [SigningJobArn](#API_PublishVersion_ResponseSyntax) ** The ARN of the signing job\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ SigningProfileVersionArn ](#API_PublishVersion_ResponseSyntax) ** + ** [SigningProfileVersionArn](#API_PublishVersion_ResponseSyntax) ** The ARN of the signing profile version\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ State ](#API_PublishVersion_ResponseSyntax) ** + ** [State](#API_PublishVersion_ResponseSyntax) ** The current state of the function\. When the state is `Inactive`, you can reactivate the function by invoking it\. Type: String Valid Values:` Pending | Active | Inactive | Failed` - ** [ StateReason ](#API_PublishVersion_ResponseSyntax) ** + ** [StateReason](#API_PublishVersion_ResponseSyntax) ** The reason for the function's current state\. Type: String - ** [ StateReasonCode ](#API_PublishVersion_ResponseSyntax) ** + ** [StateReasonCode](#API_PublishVersion_ResponseSyntax) ** The reason code for the function's current state\. When the code is `Creating`, you can't invoke or modify the function\. Type: String Valid Values:` Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Timeout ](#API_PublishVersion_ResponseSyntax) ** + ** [Timeout](#API_PublishVersion_ResponseSyntax) ** The amount of time in seconds that Lambda allows a function to run before stopping it\. Type: Integer Valid Range: Minimum value of 1\. - ** [ TracingConfig ](#API_PublishVersion_ResponseSyntax) ** + ** [TracingConfig](#API_PublishVersion_ResponseSyntax) ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object - ** [ Version ](#API_PublishVersion_ResponseSyntax) ** + ** [Version](#API_PublishVersion_ResponseSyntax) ** The version of the Lambda function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ VpcConfig ](#API_PublishVersion_ResponseSyntax) ** + ** [VpcConfig](#API_PublishVersion_ResponseSyntax) ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object ## Errors @@ -326,12 +326,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PublishVersion) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PublishVersion) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PublishVersion) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PublishVersion) \ No newline at end of file diff --git a/doc_source/API_PutFunctionCodeSigningConfig.md b/doc_source/API_PutFunctionCodeSigningConfig.md old mode 100644 new mode 100755 index f8d5b31e..c2cf8b73 --- a/doc_source/API_PutFunctionCodeSigningConfig.md +++ b/doc_source/API_PutFunctionCodeSigningConfig.md @@ -17,7 +17,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_PutFunctionCodeSigningConfig_RequestSyntax) ** + ** [FunctionName](#API_PutFunctionCodeSigningConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -33,7 +33,7 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ CodeSigningConfigArn ](#API_PutFunctionCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_PutFunctionCodeSigningConfig_RequestSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Type: String Length Constraints: Maximum length of 200\. @@ -58,13 +58,13 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfigArn ](#API_PutFunctionCodeSigningConfig_ResponseSyntax) ** + ** [CodeSigningConfigArn](#API_PutFunctionCodeSigningConfig_ResponseSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Type: String Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` - ** [ FunctionName ](#API_PutFunctionCodeSigningConfig_ResponseSyntax) ** + ** [FunctionName](#API_PutFunctionCodeSigningConfig_ResponseSyntax) ** The name of the Lambda function\. **Name formats** @@ -105,12 +105,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_PutFunctionConcurrency.md b/doc_source/API_PutFunctionConcurrency.md old mode 100644 new mode 100755 index 20dac787..22521e8a --- a/doc_source/API_PutFunctionConcurrency.md +++ b/doc_source/API_PutFunctionConcurrency.md @@ -2,9 +2,9 @@ Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level\. -Concurrency settings apply to the function as a whole, including all published versions and the unpublished version\. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level\. Use [ GetFunction ](API_GetFunction.md) to see the current setting for a function\. +Concurrency settings apply to the function as a whole, including all published versions and the unpublished version\. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level\. Use [GetFunction](API_GetFunction.md) to see the current setting for a function\. -Use [ GetAccountSettings ](API_GetAccountSettings.md) to see your Regional concurrency limit\. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per\-function limit\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\. +Use [GetAccountSettings](API_GetAccountSettings.md) to see your Regional concurrency limit\. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per\-function limit\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\. ## Request Syntax @@ -21,7 +21,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_PutFunctionConcurrency_RequestSyntax) ** + ** [FunctionName](#API_PutFunctionConcurrency_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -37,7 +37,7 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ ReservedConcurrentExecutions ](#API_PutFunctionConcurrency_RequestSyntax) ** + ** [ReservedConcurrentExecutions](#API_PutFunctionConcurrency_RequestSyntax) ** The number of simultaneous executions to reserve for the function\. Type: Integer Valid Range: Minimum value of 0\. @@ -60,7 +60,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ ReservedConcurrentExecutions ](#API_PutFunctionConcurrency_ResponseSyntax) ** + ** [ReservedConcurrentExecutions](#API_PutFunctionConcurrency_ResponseSyntax) ** The number of concurrent executions that are reserved for this function\. For more information, see [Managing Concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html)\. Type: Integer Valid Range: Minimum value of 0\. @@ -90,12 +90,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionConcurrency) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionConcurrency) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionConcurrency) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionConcurrency) \ No newline at end of file diff --git a/doc_source/API_PutFunctionEventInvokeConfig.md b/doc_source/API_PutFunctionEventInvokeConfig.md old mode 100644 new mode 100755 index 306e9aaf..48345d0c --- a/doc_source/API_PutFunctionEventInvokeConfig.md +++ b/doc_source/API_PutFunctionEventInvokeConfig.md @@ -1,8 +1,8 @@ # PutFunctionEventInvokeConfig -Configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a function, version, or alias\. If a configuration already exists for a function, version, or alias, this operation overwrites it\. If you exclude any settings, they are removed\. To set one option without affecting existing settings for other options, use [ UpdateFunctionEventInvokeConfig ](API_UpdateFunctionEventInvokeConfig.md)\. +Configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a function, version, or alias\. If a configuration already exists for a function, version, or alias, this operation overwrites it\. If you exclude any settings, they are removed\. To set one option without affecting existing settings for other options, use [UpdateFunctionEventInvokeConfig](API_UpdateFunctionEventInvokeConfig.md)\. -By default, Lambda retries an asynchronous invocation twice if the function returns an error\. It retains events in a queue for up to six hours\. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it\. To retain discarded events, configure a dead\-letter queue with [ UpdateFunctionConfiguration ](API_UpdateFunctionConfiguration.md)\. +By default, Lambda retries an asynchronous invocation twice if the function returns an error\. It retains events in a queue for up to six hours\. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it\. To retain discarded events, configure a dead\-letter queue with [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md)\. To send an invocation record to a queue, topic, function, or event bus, specify a [destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations)\. You can configure separate destinations for successful invocations \(on\-success\) and events that fail all processing attempts \(on\-failure\)\. You can configure destinations in addition to or instead of a dead\-letter queue\. @@ -30,7 +30,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** + ** [FunctionName](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -42,7 +42,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_PutFunctionEventInvokeConfig_RequestSyntax) ** + ** [Qualifier](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** A version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -51,7 +51,7 @@ Pattern: `(|[a-zA-Z0-9$_-]+)` The request accepts the following data in JSON format\. - ** [ DestinationConfig ](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** + ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** A destination for events after they have been sent to a function for processing\. **Destinations** @@ -59,16 +59,16 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No - ** [ MaximumEventAgeInSeconds ](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** + ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** The maximum age of a request that Lambda sends to a function for processing\. Type: Integer Valid Range: Minimum value of 60\. Maximum value of 21600\. Required: No - ** [ MaximumRetryAttempts ](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** + ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_RequestSyntax) ** The maximum number of times to retry when the function returns an error\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 2\. @@ -102,7 +102,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ DestinationConfig ](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** + ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** A destination for events after they have been sent to a function for processing\. **Destinations** @@ -110,23 +110,23 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ FunctionArn ](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** + ** [FunctionArn](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the function\. 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-_]+))?` - ** [ LastModified ](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** + ** [LastModified](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** The date and time that the configuration was last updated, in Unix time seconds\. Type: Timestamp - ** [ MaximumEventAgeInSeconds ](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** The maximum age of a request that Lambda sends to a function for processing\. Type: Integer Valid Range: Minimum value of 60\. Maximum value of 21600\. - ** [ MaximumRetryAttempts ](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_ResponseSyntax) ** The maximum number of times to retry when the function returns an error\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 2\. @@ -156,12 +156,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionEventInvokeConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionEventInvokeConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) \ No newline at end of file diff --git a/doc_source/API_PutProvisionedConcurrencyConfig.md b/doc_source/API_PutProvisionedConcurrencyConfig.md old mode 100644 new mode 100755 index 7dca3a23..bcea56b2 --- a/doc_source/API_PutProvisionedConcurrencyConfig.md +++ b/doc_source/API_PutProvisionedConcurrencyConfig.md @@ -17,7 +17,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_PutProvisionedConcurrencyConfig_RequestSyntax) ** + ** [FunctionName](#API_PutProvisionedConcurrencyConfig_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -29,7 +29,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_PutProvisionedConcurrencyConfig_RequestSyntax) ** + ** [Qualifier](#API_PutProvisionedConcurrencyConfig_RequestSyntax) ** The version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -39,7 +39,7 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ ProvisionedConcurrentExecutions ](#API_PutProvisionedConcurrencyConfig_RequestSyntax) ** + ** [ProvisionedConcurrentExecutions](#API_PutProvisionedConcurrencyConfig_RequestSyntax) ** The amount of provisioned concurrency to allocate for the version or alias\. Type: Integer Valid Range: Minimum value of 1\. @@ -67,31 +67,31 @@ If the action is successful, the service sends back an HTTP 202 response\. The following data is returned in JSON format by the service\. - ** [ AllocatedProvisionedConcurrentExecutions ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [AllocatedProvisionedConcurrentExecutions](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency allocated\. Type: Integer Valid Range: Minimum value of 0\. - ** [ AvailableProvisionedConcurrentExecutions ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [AvailableProvisionedConcurrentExecutions](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency available\. Type: Integer Valid Range: Minimum value of 0\. - ** [ LastModified ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [LastModified](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** The date and time that a user last updated the configuration, in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)\. Type: String - ** [ RequestedProvisionedConcurrentExecutions ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [RequestedProvisionedConcurrentExecutions](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** The amount of provisioned concurrency requested\. Type: Integer Valid Range: Minimum value of 1\. - ** [ Status ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [Status](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** The status of the allocation process\. Type: String Valid Values:` IN_PROGRESS | READY | FAILED` - ** [ StatusReason ](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** + ** [StatusReason](#API_PutProvisionedConcurrencyConfig_ResponseSyntax) ** For failed allocations, the reason that provisioned concurrency could not be allocated\. Type: String @@ -120,12 +120,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutProvisionedConcurrencyConfig) \ No newline at end of file diff --git a/doc_source/API_Reference.md b/doc_source/API_Reference.md old mode 100644 new mode 100755 diff --git a/doc_source/API_RemoveLayerVersionPermission.md b/doc_source/API_RemoveLayerVersionPermission.md old mode 100644 new mode 100755 index c9d5478d..8c1673de --- a/doc_source/API_RemoveLayerVersionPermission.md +++ b/doc_source/API_RemoveLayerVersionPermission.md @@ -1,6 +1,6 @@ # RemoveLayerVersionPermission -Removes a statement from the permissions policy for a version of an [ AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. For more information, see [ AddLayerVersionPermission ](API_AddLayerVersionPermission.md)\. +Removes a statement from the permissions policy for a version of an [AWS Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. For more information, see [AddLayerVersionPermission](API_AddLayerVersionPermission.md)\. ## Request Syntax @@ -12,22 +12,22 @@ DELETE /2018-10-31/layers/LayerName/versions/VersionNumber/policy/StatementId?Re The request uses the following URI parameters\. - ** [ LayerName ](#API_RemoveLayerVersionPermission_RequestSyntax) ** + ** [LayerName](#API_RemoveLayerVersionPermission_RequestSyntax) ** 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_RemoveLayerVersionPermission_RequestSyntax) ** + ** [RevisionId](#API_RemoveLayerVersionPermission_RequestSyntax) ** 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\. - ** [ StatementId ](#API_RemoveLayerVersionPermission_RequestSyntax) ** + ** [StatementId](#API_RemoveLayerVersionPermission_RequestSyntax) ** The identifier that was specified when the statement was added\. Length Constraints: Minimum length of 1\. Maximum length of 100\. Pattern: `([a-zA-Z0-9-_]+)` Required: Yes - ** [ VersionNumber ](#API_RemoveLayerVersionPermission_RequestSyntax) ** + ** [VersionNumber](#API_RemoveLayerVersionPermission_RequestSyntax) ** The version number\. Required: Yes @@ -70,12 +70,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/RemoveLayerVersionPermission) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/RemoveLayerVersionPermission) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/RemoveLayerVersionPermission) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/RemoveLayerVersionPermission) \ No newline at end of file diff --git a/doc_source/API_RemovePermission.md b/doc_source/API_RemovePermission.md old mode 100644 new mode 100755 index bc601ef3..58c33758 --- a/doc_source/API_RemovePermission.md +++ b/doc_source/API_RemovePermission.md @@ -1,6 +1,6 @@ # RemovePermission -Revokes function\-use permission from an AWS service or another account\. You can get the ID of the statement from the output of [ GetPolicy ](API_GetPolicy.md)\. +Revokes function\-use permission from an AWS service or another account\. You can get the ID of the statement from the output of [GetPolicy](API_GetPolicy.md)\. ## Request Syntax @@ -12,7 +12,7 @@ DELETE /2015-03-31/functions/FunctionName/policy/StatementId?Qualifier=Qualifier The request uses the following URI parameters\. - ** [ FunctionName ](#API_RemovePermission_RequestSyntax) ** + ** [FunctionName](#API_RemovePermission_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -24,15 +24,15 @@ 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_RemovePermission_RequestSyntax) ** + ** [Qualifier](#API_RemovePermission_RequestSyntax) ** Specify a version or alias to remove permissions from a published version of the function\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` - ** [ RevisionId ](#API_RemovePermission_RequestSyntax) ** + ** [RevisionId](#API_RemovePermission_RequestSyntax) ** 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\. - ** [ StatementId ](#API_RemovePermission_RequestSyntax) ** + ** [StatementId](#API_RemovePermission_RequestSyntax) ** Statement ID of the permission to remove\. Length Constraints: Minimum length of 1\. Maximum length of 100\. Pattern: `([a-zA-Z0-9-_.]+)` @@ -77,12 +77,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/RemovePermission) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/RemovePermission) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/RemovePermission) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/RemovePermission) \ No newline at end of file diff --git a/doc_source/API_SelfManagedEventSource.md b/doc_source/API_SelfManagedEventSource.md old mode 100644 new mode 100755 index 26ec3da5..04777747 --- a/doc_source/API_SelfManagedEventSource.md +++ b/doc_source/API_SelfManagedEventSource.md @@ -17,7 +17,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/SelfManagedEventSource) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/SelfManagedEventSource) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/SelfManagedEventSource) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/SelfManagedEventSource) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/SelfManagedEventSource) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/SelfManagedEventSource) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/SelfManagedEventSource) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/SelfManagedEventSource) \ No newline at end of file diff --git a/doc_source/API_SourceAccessConfiguration.md b/doc_source/API_SourceAccessConfiguration.md old mode 100644 new mode 100755 index 88c9fcdb..12faeaad --- a/doc_source/API_SourceAccessConfiguration.md +++ b/doc_source/API_SourceAccessConfiguration.md @@ -13,8 +13,10 @@ The type of authentication protocol, VPC components, or virtual host for your ev + `SASL_SCRAM_256_AUTH` \- The Secrets Manager ARN of your secret key used for SASL SCRAM\-256 authentication of your self\-managed Apache Kafka brokers\. + `SASL_SCRAM_512_AUTH` \- The Secrets Manager ARN of your secret key used for SASL SCRAM\-512 authentication of your self\-managed Apache Kafka brokers\. + `VIRTUAL_HOST` \- \(Amazon MQ\) The name of the virtual host in your RabbitMQ broker\. Lambda uses this RabbitMQ host as the event source\. This property cannot be specified in an UpdateEventSourceMapping API call\. ++ `CLIENT_CERTIFICATE_TLS_AUTH` \- \(Amazon MSK, Self\-managed Apache Kafka\) The Secrets Manager ARN of your secret key containing the certificate chain \(X\.509 PEM\), private key \(PKCS\#8 PEM\), and private key password \(optional\) used for mutual TLS authentication of your MSK/Apache Kafka brokers\. ++ `SERVER_ROOT_CA_CERTIFICATE` \- \(Self\-managed Apache Kafka\) The Secrets Manager ARN of your secret key containing the root CA certificate \(X\.509 PEM\) used for TLS encryption of your Apache Kafka brokers\. Type: String -Valid Values:` BASIC_AUTH | VPC_SUBNET | VPC_SECURITY_GROUP | SASL_SCRAM_512_AUTH | SASL_SCRAM_256_AUTH | VIRTUAL_HOST` +Valid Values:` BASIC_AUTH | VPC_SUBNET | VPC_SECURITY_GROUP | SASL_SCRAM_512_AUTH | SASL_SCRAM_256_AUTH | VIRTUAL_HOST | CLIENT_CERTIFICATE_TLS_AUTH | SERVER_ROOT_CA_CERTIFICATE` Required: No ** URI ** @@ -27,7 +29,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/SourceAccessConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/SourceAccessConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/SourceAccessConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/SourceAccessConfiguration) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/SourceAccessConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/SourceAccessConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/SourceAccessConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/SourceAccessConfiguration) \ No newline at end of file diff --git a/doc_source/API_TagResource.md b/doc_source/API_TagResource.md old mode 100644 new mode 100755 index 45444747..0104ba08 --- a/doc_source/API_TagResource.md +++ b/doc_source/API_TagResource.md @@ -19,7 +19,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ ARN ](#API_TagResource_RequestSyntax) ** + ** [ARN](#API_TagResource_RequestSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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 @@ -28,7 +28,7 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ Tags ](#API_TagResource_RequestSyntax) ** + ** [Tags](#API_TagResource_RequestSyntax) ** A list of tags to apply to the function\. Type: String to string map Required: Yes @@ -68,12 +68,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/TagResource) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/TagResource) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TagResource) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TagResource) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TagResource) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/TagResource) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/TagResource) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/TagResource) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TagResource) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/TagResource) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/TagResource) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TagResource) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TagResource) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TagResource) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/TagResource) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/TagResource) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/TagResource) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TagResource) \ No newline at end of file diff --git a/doc_source/API_TracingConfig.md b/doc_source/API_TracingConfig.md old mode 100644 new mode 100755 index a4348db1..4833a916 --- a/doc_source/API_TracingConfig.md +++ b/doc_source/API_TracingConfig.md @@ -1,6 +1,6 @@ # TracingConfig -The function's [ AWS X\-Ray ](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration\. To sample and record incoming requests, set `Mode` to `Active`\. +The function's [AWS X\-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration\. To sample and record incoming requests, set `Mode` to `Active`\. ## Contents @@ -13,7 +13,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TracingConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TracingConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TracingConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TracingConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TracingConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TracingConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TracingConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TracingConfig) \ No newline at end of file diff --git a/doc_source/API_TracingConfigResponse.md b/doc_source/API_TracingConfigResponse.md old mode 100644 new mode 100755 index 9d666f16..d5bf88f8 --- a/doc_source/API_TracingConfigResponse.md +++ b/doc_source/API_TracingConfigResponse.md @@ -13,7 +13,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TracingConfigResponse) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TracingConfigResponse) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TracingConfigResponse) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TracingConfigResponse) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/TracingConfigResponse) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/TracingConfigResponse) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/TracingConfigResponse) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/TracingConfigResponse) \ No newline at end of file diff --git a/doc_source/API_Types.md b/doc_source/API_Types.md old mode 100644 new mode 100755 index f6188166..9d81625a --- a/doc_source/API_Types.md +++ b/doc_source/API_Types.md @@ -1,39 +1,41 @@ # Data Types The following data types are supported: -+ [ AccountLimit ](API_AccountLimit.md) -+ [ AccountUsage ](API_AccountUsage.md) -+ [ AliasConfiguration ](API_AliasConfiguration.md) -+ [ AliasRoutingConfiguration ](API_AliasRoutingConfiguration.md) -+ [ AllowedPublishers ](API_AllowedPublishers.md) -+ [ CodeSigningConfig ](API_CodeSigningConfig.md) -+ [ CodeSigningPolicies ](API_CodeSigningPolicies.md) -+ [ Concurrency ](API_Concurrency.md) -+ [ DeadLetterConfig ](API_DeadLetterConfig.md) -+ [ DestinationConfig ](API_DestinationConfig.md) -+ [ Environment ](API_Environment.md) -+ [ EnvironmentError ](API_EnvironmentError.md) -+ [ EnvironmentResponse ](API_EnvironmentResponse.md) -+ [ EventSourceMappingConfiguration ](API_EventSourceMappingConfiguration.md) -+ [ FileSystemConfig ](API_FileSystemConfig.md) -+ [ FunctionCode ](API_FunctionCode.md) -+ [ FunctionCodeLocation ](API_FunctionCodeLocation.md) -+ [ FunctionConfiguration ](API_FunctionConfiguration.md) -+ [ FunctionEventInvokeConfig ](API_FunctionEventInvokeConfig.md) -+ [ ImageConfig ](API_ImageConfig.md) -+ [ ImageConfigError ](API_ImageConfigError.md) -+ [ ImageConfigResponse ](API_ImageConfigResponse.md) -+ [ Layer ](API_Layer.md) -+ [ LayersListItem ](API_LayersListItem.md) -+ [ LayerVersionContentInput ](API_LayerVersionContentInput.md) -+ [ LayerVersionContentOutput ](API_LayerVersionContentOutput.md) -+ [ LayerVersionsListItem ](API_LayerVersionsListItem.md) -+ [ OnFailure ](API_OnFailure.md) -+ [ OnSuccess ](API_OnSuccess.md) -+ [ ProvisionedConcurrencyConfigListItem ](API_ProvisionedConcurrencyConfigListItem.md) -+ [ SelfManagedEventSource ](API_SelfManagedEventSource.md) -+ [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) -+ [ TracingConfig ](API_TracingConfig.md) -+ [ TracingConfigResponse ](API_TracingConfigResponse.md) -+ [ VpcConfig ](API_VpcConfig.md) -+ [ VpcConfigResponse ](API_VpcConfigResponse.md) \ No newline at end of file ++ [AccountLimit](API_AccountLimit.md) ++ [AccountUsage](API_AccountUsage.md) ++ [AliasConfiguration](API_AliasConfiguration.md) ++ [AliasRoutingConfiguration](API_AliasRoutingConfiguration.md) ++ [AllowedPublishers](API_AllowedPublishers.md) ++ [CodeSigningConfig](API_CodeSigningConfig.md) ++ [CodeSigningPolicies](API_CodeSigningPolicies.md) ++ [Concurrency](API_Concurrency.md) ++ [DeadLetterConfig](API_DeadLetterConfig.md) ++ [DestinationConfig](API_DestinationConfig.md) ++ [Environment](API_Environment.md) ++ [EnvironmentError](API_EnvironmentError.md) ++ [EnvironmentResponse](API_EnvironmentResponse.md) ++ [EventSourceMappingConfiguration](API_EventSourceMappingConfiguration.md) ++ [FileSystemConfig](API_FileSystemConfig.md) ++ [Filter](API_Filter.md) ++ [FilterCriteria](API_FilterCriteria.md) ++ [FunctionCode](API_FunctionCode.md) ++ [FunctionCodeLocation](API_FunctionCodeLocation.md) ++ [FunctionConfiguration](API_FunctionConfiguration.md) ++ [FunctionEventInvokeConfig](API_FunctionEventInvokeConfig.md) ++ [ImageConfig](API_ImageConfig.md) ++ [ImageConfigError](API_ImageConfigError.md) ++ [ImageConfigResponse](API_ImageConfigResponse.md) ++ [Layer](API_Layer.md) ++ [LayersListItem](API_LayersListItem.md) ++ [LayerVersionContentInput](API_LayerVersionContentInput.md) ++ [LayerVersionContentOutput](API_LayerVersionContentOutput.md) ++ [LayerVersionsListItem](API_LayerVersionsListItem.md) ++ [OnFailure](API_OnFailure.md) ++ [OnSuccess](API_OnSuccess.md) ++ [ProvisionedConcurrencyConfigListItem](API_ProvisionedConcurrencyConfigListItem.md) ++ [SelfManagedEventSource](API_SelfManagedEventSource.md) ++ [SourceAccessConfiguration](API_SourceAccessConfiguration.md) ++ [TracingConfig](API_TracingConfig.md) ++ [TracingConfigResponse](API_TracingConfigResponse.md) ++ [VpcConfig](API_VpcConfig.md) ++ [VpcConfigResponse](API_VpcConfigResponse.md) \ No newline at end of file diff --git a/doc_source/API_UntagResource.md b/doc_source/API_UntagResource.md old mode 100644 new mode 100755 index 88cfb1be..8abf4139 --- a/doc_source/API_UntagResource.md +++ b/doc_source/API_UntagResource.md @@ -12,12 +12,12 @@ DELETE /2017-03-31/tags/ARN?tagKeys=TagKeys HTTP/1.1 The request uses the following URI parameters\. - ** [ ARN ](#API_UntagResource_RequestSyntax) ** + ** [ARN](#API_UntagResource_RequestSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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 - ** [ TagKeys ](#API_UntagResource_RequestSyntax) ** + ** [TagKeys](#API_UntagResource_RequestSyntax) ** A list of tag keys to remove from the function\. Required: Yes @@ -60,12 +60,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UntagResource) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UntagResource) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UntagResource) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UntagResource) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UntagResource) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UntagResource) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UntagResource) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UntagResource) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UntagResource) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UntagResource) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UntagResource) \ No newline at end of file diff --git a/doc_source/API_UpdateAlias.md b/doc_source/API_UpdateAlias.md old mode 100644 new mode 100755 index 98f85781..c1ffe2e9 --- a/doc_source/API_UpdateAlias.md +++ b/doc_source/API_UpdateAlias.md @@ -24,7 +24,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_UpdateAlias_RequestSyntax) ** + ** [FunctionName](#API_UpdateAlias_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -36,7 +36,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 - ** [ Name ](#API_UpdateAlias_RequestSyntax) ** + ** [Name](#API_UpdateAlias_RequestSyntax) ** The name of the alias\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` @@ -46,27 +46,27 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ Description ](#API_UpdateAlias_RequestSyntax) ** + ** [Description](#API_UpdateAlias_RequestSyntax) ** A description of the alias\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ FunctionVersion ](#API_UpdateAlias_RequestSyntax) ** + ** [FunctionVersion](#API_UpdateAlias_RequestSyntax) ** 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 - ** [ RevisionId ](#API_UpdateAlias_RequestSyntax) ** + ** [RevisionId](#API_UpdateAlias_RequestSyntax) ** Only update the alias if the revision ID matches the ID that's specified\. Use this option to avoid modifying an alias that has changed since you last read it\. Type: String Required: No - ** [ RoutingConfig ](#API_UpdateAlias_RequestSyntax) ** + ** [RoutingConfig](#API_UpdateAlias_RequestSyntax) ** The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) of the alias\. -Type: [ AliasRoutingConfiguration ](API_AliasRoutingConfiguration.md) object +Type: [AliasRoutingConfiguration](API_AliasRoutingConfiguration.md) object Required: No ## Response Syntax @@ -95,35 +95,35 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ AliasArn ](#API_UpdateAlias_ResponseSyntax) ** + ** [AliasArn](#API_UpdateAlias_ResponseSyntax) ** 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-_]+))?` - ** [ Description ](#API_UpdateAlias_ResponseSyntax) ** + ** [Description](#API_UpdateAlias_ResponseSyntax) ** A description of the alias\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ FunctionVersion ](#API_UpdateAlias_ResponseSyntax) ** + ** [FunctionVersion](#API_UpdateAlias_ResponseSyntax) ** The function version that the alias invokes\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ Name ](#API_UpdateAlias_ResponseSyntax) ** + ** [Name](#API_UpdateAlias_ResponseSyntax) ** The name of the alias\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` - ** [ RevisionId ](#API_UpdateAlias_ResponseSyntax) ** + ** [RevisionId](#API_UpdateAlias_ResponseSyntax) ** A unique identifier that changes when you update the alias\. Type: String - ** [ RoutingConfig ](#API_UpdateAlias_ResponseSyntax) ** + ** [RoutingConfig](#API_UpdateAlias_ResponseSyntax) ** 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 ## Errors @@ -154,12 +154,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateAlias) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateAlias) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateAlias) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateAlias) \ No newline at end of file diff --git a/doc_source/API_UpdateCodeSigningConfig.md b/doc_source/API_UpdateCodeSigningConfig.md old mode 100644 new mode 100755 index 181a153a..5ea4611b --- a/doc_source/API_UpdateCodeSigningConfig.md +++ b/doc_source/API_UpdateCodeSigningConfig.md @@ -23,7 +23,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ CodeSigningConfigArn ](#API_UpdateCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningConfigArn](#API_UpdateCodeSigningConfig_RequestSyntax) ** The The Amazon Resource Name \(ARN\) of the code signing configuration\. Length Constraints: Maximum length of 200\. Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}` @@ -33,17 +33,17 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ AllowedPublishers ](#API_UpdateCodeSigningConfig_RequestSyntax) ** + ** [AllowedPublishers](#API_UpdateCodeSigningConfig_RequestSyntax) ** Signing profiles for this code signing configuration\. -Type: [ AllowedPublishers ](API_AllowedPublishers.md) object +Type: [AllowedPublishers](API_AllowedPublishers.md) object Required: No - ** [ CodeSigningPolicies ](#API_UpdateCodeSigningConfig_RequestSyntax) ** + ** [CodeSigningPolicies](#API_UpdateCodeSigningConfig_RequestSyntax) ** The code signing policy\. -Type: [ CodeSigningPolicies ](API_CodeSigningPolicies.md) object +Type: [CodeSigningPolicies](API_CodeSigningPolicies.md) object Required: No - ** [ Description ](#API_UpdateCodeSigningConfig_RequestSyntax) ** + ** [Description](#API_UpdateCodeSigningConfig_RequestSyntax) ** Descriptive name for this code signing configuration\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. @@ -77,9 +77,9 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ CodeSigningConfig ](#API_UpdateCodeSigningConfig_ResponseSyntax) ** + ** [CodeSigningConfig](#API_UpdateCodeSigningConfig_ResponseSyntax) ** The code signing configuration -Type: [ CodeSigningConfig ](API_CodeSigningConfig.md) object +Type: [CodeSigningConfig](API_CodeSigningConfig.md) object ## Errors @@ -98,12 +98,12 @@ HTTP Status Code: 500 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateCodeSigningConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateCodeSigningConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateCodeSigningConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateCodeSigningConfig) \ No newline at end of file diff --git a/doc_source/API_UpdateEventSourceMapping.md b/doc_source/API_UpdateEventSourceMapping.md old mode 100644 new mode 100755 index 260e96cd..eb06196f --- a/doc_source/API_UpdateEventSourceMapping.md +++ b/doc_source/API_UpdateEventSourceMapping.md @@ -43,6 +43,13 @@ Content-type: application/json } }, "Enabled": boolean, + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionName": "string", "FunctionResponseTypes": [ "string" ], "MaximumBatchingWindowInSeconds": number, @@ -63,7 +70,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ UUID ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [UUID](#API_UpdateEventSourceMapping_RequestSyntax) ** The identifier of the event source mapping\. Required: Yes @@ -71,7 +78,7 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ BatchSize ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [BatchSize](#API_UpdateEventSourceMapping_RequestSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. + **Amazon Kinesis** \- Default 100\. Max 10,000\. + **Amazon DynamoDB Streams** \- Default 100\. Max 1,000\. @@ -83,23 +90,28 @@ Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. Required: No - ** [ BisectBatchOnFunctionError ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [BisectBatchOnFunctionError](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. Type: Boolean Required: No - ** [ DestinationConfig ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [DestinationConfig](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No - ** [ Enabled ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [Enabled](#API_UpdateEventSourceMapping_RequestSyntax) ** When true, the event source mapping is active\. When false, Lambda pauses polling and invocation\. Default: True Type: Boolean Required: No - ** [ FunctionName ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [FilterCriteria](#API_UpdateEventSourceMapping_RequestSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object +Required: No + + ** [FunctionName](#API_UpdateEventSourceMapping_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -113,14 +125,14 @@ 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: No - ** [ FunctionResponseTypes ](#API_UpdateEventSourceMapping_RequestSyntax) ** -\(Streams only\) A list of current response type enums applied to the event source mapping\. + ** [FunctionResponseTypes](#API_UpdateEventSourceMapping_RequestSyntax) ** +\(Streams and Amazon SQS\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` Required: No - ** [ MaximumBatchingWindowInSeconds ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. @@ -128,31 +140,31 @@ Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. Required: No - ** [ MaximumRecordAgeInSeconds ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is infinite \(\-1\)\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. Required: No - ** [ MaximumRetryAttempts ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [MaximumRetryAttempts](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is infinite \(\-1\)\. When set to infinite \(\-1\), failed records will be retried until the record expires\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. Required: No - ** [ ParallelizationFactor ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [ParallelizationFactor](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) The number of batches to process from each shard concurrently\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. Required: No - ** [ SourceAccessConfigurations ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [SourceAccessConfigurations](#API_UpdateEventSourceMapping_RequestSyntax) ** An array of authentication protocols or VPC components required to secure your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. Required: No - ** [ TumblingWindowInSeconds ](#API_UpdateEventSourceMapping_RequestSyntax) ** + ** [TumblingWindowInSeconds](#API_UpdateEventSourceMapping_RequestSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is between 1 second up to 900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. @@ -176,6 +188,13 @@ Content-type: application/json } }, "EventSourceArn": "string", + "FilterCriteria": { + "Filters": [ + { + "Pattern": "string" + } + ] + }, "FunctionArn": "string", "FunctionResponseTypes": [ "string" ], "LastModified": number, @@ -212,113 +231,117 @@ If the action is successful, the service sends back an HTTP 202 response\. The following data is returned in JSON format by the service\. - ** [ BatchSize ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [BatchSize](#API_UpdateEventSourceMapping_ResponseSyntax) ** The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function\. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation \(6 MB\)\. Default value: Varies by service\. For Amazon SQS, the default is 10\. For all other services, the default is 100\. Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10000\. - ** [ BisectBatchOnFunctionError ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [BisectBatchOnFunctionError](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) If the function returns an error, split the batch in two and retry\. The default value is false\. Type: Boolean - ** [ DestinationConfig ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [DestinationConfig](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) An Amazon SQS queue or Amazon SNS topic destination for discarded records\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ EventSourceArn ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [EventSourceArn](#API_UpdateEventSourceMapping_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the event source\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ FunctionArn ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [FilterCriteria](#API_UpdateEventSourceMapping_ResponseSyntax) ** +\(Streams and Amazon SQS\) An object that defines the filter criteria that determine whether Lambda should process an event\. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)\. +Type: [FilterCriteria](API_FilterCriteria.md) object + + ** [FunctionArn](#API_UpdateEventSourceMapping_ResponseSyntax) ** The ARN of the Lambda function\. 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-_]+))?` - ** [ FunctionResponseTypes ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [FunctionResponseTypes](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) A list of current response type enums applied to the event source mapping\. Type: Array of strings Array Members: Minimum number of 0 items\. Maximum number of 1 item\. Valid Values:` ReportBatchItemFailures` - ** [ LastModified ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [LastModified](#API_UpdateEventSourceMapping_ResponseSyntax) ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds\. Type: Timestamp - ** [ LastProcessingResult ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [LastProcessingResult](#API_UpdateEventSourceMapping_ResponseSyntax) ** The result of the last Lambda invocation of your function\. Type: String - ** [ MaximumBatchingWindowInSeconds ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [MaximumBatchingWindowInSeconds](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams and Amazon SQS standard queues\) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function\. Default: 0 Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 300\. - ** [ MaximumRecordAgeInSeconds ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [MaximumRecordAgeInSeconds](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records older than the specified age\. The default value is \-1, which sets the maximum age to infinite\. When the value is set to infinite, Lambda never discards old records\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 604800\. - ** [ MaximumRetryAttempts ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) Discard records after the specified number of retries\. The default value is \-1, which sets the maximum number of retries to infinite\. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source\. Type: Integer Valid Range: Minimum value of \-1\. Maximum value of 10000\. - ** [ ParallelizationFactor ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [ParallelizationFactor](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) The number of batches to process concurrently from each shard\. The default value is 1\. Type: Integer Valid Range: Minimum value of 1\. Maximum value of 10\. - ** [ Queues ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [Queues](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Amazon MQ\) The name of the Amazon MQ broker destination queue to consume\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 1000\. Pattern: `[\s\S]*` - ** [ SelfManagedEventSource ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [SelfManagedEventSource](#API_UpdateEventSourceMapping_ResponseSyntax) ** The self\-managed Apache Kafka cluster for your event source\. -Type: [ SelfManagedEventSource ](API_SelfManagedEventSource.md) object +Type: [SelfManagedEventSource](API_SelfManagedEventSource.md) object - ** [ SourceAccessConfigurations ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [SourceAccessConfigurations](#API_UpdateEventSourceMapping_ResponseSyntax) ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source\. -Type: Array of [ SourceAccessConfiguration ](API_SourceAccessConfiguration.md) objects +Type: Array of [SourceAccessConfiguration](API_SourceAccessConfiguration.md) objects Array Members: Minimum number of 0 items\. Maximum number of 22 items\. - ** [ StartingPosition ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [StartingPosition](#API_UpdateEventSourceMapping_ResponseSyntax) ** The position in a stream from which to start reading\. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources\. `AT_TIMESTAMP` is supported only for Amazon Kinesis streams\. Type: String Valid Values:` TRIM_HORIZON | LATEST | AT_TIMESTAMP` - ** [ StartingPositionTimestamp ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [StartingPositionTimestamp](#API_UpdateEventSourceMapping_ResponseSyntax) ** With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\. Type: Timestamp - ** [ State ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [State](#API_UpdateEventSourceMapping_ResponseSyntax) ** The state of the event source mapping\. It can be one of the following: `Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`\. Type: String - ** [ StateTransitionReason ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [StateTransitionReason](#API_UpdateEventSourceMapping_ResponseSyntax) ** Indicates whether a user or Lambda made the last change to the event source mapping\. Type: String - ** [ Topics ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [Topics](#API_UpdateEventSourceMapping_ResponseSyntax) ** The name of the Kafka topic\. Type: Array of strings Array Members: Fixed number of 1 item\. Length Constraints: Minimum length of 1\. Maximum length of 249\. Pattern: `^[^.]([a-zA-Z0-9\-_.]+)` - ** [ TumblingWindowInSeconds ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [TumblingWindowInSeconds](#API_UpdateEventSourceMapping_ResponseSyntax) ** \(Streams only\) The duration in seconds of a processing window\. The range is 1–900 seconds\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 900\. - ** [ UUID ](#API_UpdateEventSourceMapping_ResponseSyntax) ** + ** [UUID](#API_UpdateEventSourceMapping_ResponseSyntax) ** The identifier of the event source mapping\. Type: String @@ -351,12 +374,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateEventSourceMapping) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateEventSourceMapping) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateEventSourceMapping) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateEventSourceMapping) \ No newline at end of file diff --git a/doc_source/API_UpdateFunctionCode.md b/doc_source/API_UpdateFunctionCode.md old mode 100644 new mode 100755 index 4d310a1b..1af1d49a --- a/doc_source/API_UpdateFunctionCode.md +++ b/doc_source/API_UpdateFunctionCode.md @@ -2,6 +2,12 @@ Updates a Lambda function's code\. If code signing is enabled for the function, the code package must be signed by a trusted publisher\. For more information, see [Configuring code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-trustedcode.html)\. +If the function's package type is `Image`, you must specify the code package in `ImageUri` as the URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry\. + +If the function's package type is `Zip`, you must specify the deployment package as a [\.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip)\. Enter the Amazon S3 bucket and key of the code \.zip file location\. You can also provide the function code inline using the `ZipFile` field\. + +The code in the deployment package must be compatible with the target instruction set architecture of the function \(`x86-64` or `arm64`\)\. + The function's code is locked when you publish a version\. You can't modify the code of a published version, only the unpublished version\. **Note** @@ -30,7 +36,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_UpdateFunctionCode_RequestSyntax) ** + ** [FunctionName](#API_UpdateFunctionCode_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -46,54 +52,54 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ Architectures ](#API_UpdateFunctionCode_RequestSyntax) ** + ** [Architectures](#API_UpdateFunctionCode_RequestSyntax) ** The instruction set architecture that the function supports\. Enter a string array with one of the valid values \(arm64 or x86\_64\)\. The default value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` Required: No - ** [ DryRun ](#API_UpdateFunctionCode_RequestSyntax) ** + ** [DryRun](#API_UpdateFunctionCode_RequestSyntax) ** Set to true to validate the request parameters and access permissions without modifying the function code\. Type: Boolean Required: No - ** [ ImageUri ](#API_UpdateFunctionCode_RequestSyntax) ** -URI of a container image in the Amazon ECR registry\. + ** [ImageUri](#API_UpdateFunctionCode_RequestSyntax) ** +URI of a container image in the Amazon ECR registry\. Do not use for a function defined with a \.zip file archive\. Type: String Required: No - ** [ Publish ](#API_UpdateFunctionCode_RequestSyntax) ** -Set to true to publish a new version of the function after updating the code\. This has the same effect as calling [ PublishVersion ](API_PublishVersion.md) separately\. + ** [Publish](#API_UpdateFunctionCode_RequestSyntax) ** +Set to true to publish a new version of the function after updating the code\. This has the same effect as calling [PublishVersion](API_PublishVersion.md) separately\. Type: Boolean Required: No - ** [ RevisionId ](#API_UpdateFunctionCode_RequestSyntax) ** + ** [RevisionId](#API_UpdateFunctionCode_RequestSyntax) ** Only update the function if the revision ID matches the ID that's specified\. Use this option to avoid modifying a function that has changed since you last read it\. Type: String Required: No - ** [ S3Bucket ](#API_UpdateFunctionCode_RequestSyntax) ** -An Amazon S3 bucket in the same AWS Region as your function\. The bucket can be in a different AWS account\. + ** [S3Bucket](#API_UpdateFunctionCode_RequestSyntax) ** +An Amazon S3 bucket in the same AWS Region as your function\. The bucket can be in a different AWS account\. Use only with a function defined with a \.zip file archive deployment package\. Type: String Length Constraints: Minimum length of 3\. Maximum length of 63\. Pattern: `^[0-9A-Za-z\.\-_]*(? -The Amazon S3 key of the deployment package\. + ** [S3Key](#API_UpdateFunctionCode_RequestSyntax) ** +The Amazon S3 key of the deployment package\. Use only with a function defined with a \.zip file archive deployment package\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Required: No - ** [ S3ObjectVersion ](#API_UpdateFunctionCode_RequestSyntax) ** + ** [S3ObjectVersion](#API_UpdateFunctionCode_RequestSyntax) ** For versioned objects, the version of the deployment package object to use\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Required: No - ** [ ZipFile ](#API_UpdateFunctionCode_RequestSyntax) ** -The base64\-encoded contents of the deployment package\. AWS SDK and AWS CLI clients handle the encoding for you\. + ** [ZipFile](#API_UpdateFunctionCode_RequestSyntax) ** +The base64\-encoded contents of the deployment package\. AWS SDK and AWS CLI clients handle the encoding for you\. Use only with a function defined with a \.zip file archive deployment package\. Type: Base64\-encoded binary data object Required: No @@ -183,157 +189,157 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Architectures ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Architectures](#API_UpdateFunctionCode_ResponseSyntax) ** The instruction set architecture that the function supports\. Architecture is a string array with one of the valid values\. The default architecture value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` - ** [ CodeSha256 ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [CodeSha256](#API_UpdateFunctionCode_ResponseSyntax) ** The SHA256 hash of the function's deployment package\. Type: String - ** [ CodeSize ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [CodeSize](#API_UpdateFunctionCode_ResponseSyntax) ** The size of the function's deployment package, in bytes\. Type: Long - ** [ DeadLetterConfig ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [DeadLetterConfig](#API_UpdateFunctionCode_ResponseSyntax) ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object - ** [ Description ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Description](#API_UpdateFunctionCode_ResponseSyntax) ** The function's description\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ Environment ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Environment](#API_UpdateFunctionCode_ResponseSyntax) ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object - ** [ FileSystemConfigs ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [FileSystemConfigs](#API_UpdateFunctionCode_ResponseSyntax) ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. - ** [ FunctionArn ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [FunctionArn](#API_UpdateFunctionCode_ResponseSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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-_]+))?` - ** [ FunctionName ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [FunctionName](#API_UpdateFunctionCode_ResponseSyntax) ** The name of the function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 170\. 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-_]+))?` - ** [ Handler ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Handler](#API_UpdateFunctionCode_ResponseSyntax) ** The function that Lambda calls to begin executing your function\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` - ** [ ImageConfigResponse ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [ImageConfigResponse](#API_UpdateFunctionCode_ResponseSyntax) ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object - ** [ KMSKeyArn ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [KMSKeyArn](#API_UpdateFunctionCode_ResponseSyntax) ** The AWS KMS key that's used to encrypt the function's environment variables\. This key is only returned if you've configured a customer managed key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` - ** [ LastModified ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [LastModified](#API_UpdateFunctionCode_ResponseSyntax) ** The date and time that the function was last updated, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ LastUpdateStatus ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [LastUpdateStatus](#API_UpdateFunctionCode_ResponseSyntax) ** The status of the last update that was performed on the function\. This is first set to `Successful` after function creation completes\. Type: String Valid Values:` Successful | Failed | InProgress` - ** [ LastUpdateStatusReason ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [LastUpdateStatusReason](#API_UpdateFunctionCode_ResponseSyntax) ** The reason for the last update that was performed on the function\. Type: String - ** [ LastUpdateStatusReasonCode ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [LastUpdateStatusReasonCode](#API_UpdateFunctionCode_ResponseSyntax) ** The reason code for the last update that was performed on the function\. Type: String Valid Values:` EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Layers ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Layers](#API_UpdateFunctionCode_ResponseSyntax) ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects - ** [ MasterArn ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [MasterArn](#API_UpdateFunctionCode_ResponseSyntax) ** For Lambda@Edge functions, the ARN of the main function\. 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-_]+))?` - ** [ MemorySize ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [MemorySize](#API_UpdateFunctionCode_ResponseSyntax) ** The amount of memory available to the function at runtime\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. - ** [ PackageType ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [PackageType](#API_UpdateFunctionCode_ResponseSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for \.zip file archive\. Type: String Valid Values:` Zip | Image` - ** [ RevisionId ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [RevisionId](#API_UpdateFunctionCode_ResponseSyntax) ** The latest updated revision of the function or alias\. Type: String - ** [ Role ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Role](#API_UpdateFunctionCode_ResponseSyntax) ** The function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` - ** [ Runtime ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Runtime](#API_UpdateFunctionCode_ResponseSyntax) ** The runtime environment for the Lambda function\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ SigningJobArn ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [SigningJobArn](#API_UpdateFunctionCode_ResponseSyntax) ** The ARN of the signing job\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ SigningProfileVersionArn ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [SigningProfileVersionArn](#API_UpdateFunctionCode_ResponseSyntax) ** The ARN of the signing profile version\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ State ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [State](#API_UpdateFunctionCode_ResponseSyntax) ** The current state of the function\. When the state is `Inactive`, you can reactivate the function by invoking it\. Type: String Valid Values:` Pending | Active | Inactive | Failed` - ** [ StateReason ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [StateReason](#API_UpdateFunctionCode_ResponseSyntax) ** The reason for the function's current state\. Type: String - ** [ StateReasonCode ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [StateReasonCode](#API_UpdateFunctionCode_ResponseSyntax) ** The reason code for the function's current state\. When the code is `Creating`, you can't invoke or modify the function\. Type: String Valid Values:` Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Timeout ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Timeout](#API_UpdateFunctionCode_ResponseSyntax) ** The amount of time in seconds that Lambda allows a function to run before stopping it\. Type: Integer Valid Range: Minimum value of 1\. - ** [ TracingConfig ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [TracingConfig](#API_UpdateFunctionCode_ResponseSyntax) ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object - ** [ Version ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [Version](#API_UpdateFunctionCode_ResponseSyntax) ** The version of the Lambda function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ VpcConfig ](#API_UpdateFunctionCode_ResponseSyntax) ** + ** [VpcConfig](#API_UpdateFunctionCode_ResponseSyntax) ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object ## Errors @@ -380,12 +386,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionCode) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionCode) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionCode) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionCode) \ No newline at end of file diff --git a/doc_source/API_UpdateFunctionConfiguration.md b/doc_source/API_UpdateFunctionConfiguration.md old mode 100644 new mode 100755 index a32e845b..94358f2a --- a/doc_source/API_UpdateFunctionConfiguration.md +++ b/doc_source/API_UpdateFunctionConfiguration.md @@ -2,11 +2,11 @@ Modify the version\-specific settings of a Lambda function\. -When you update a function, Lambda provisions an instance of the function and its supporting resources\. If your function connects to a VPC, this process can take a minute\. During this time, you can't modify the function, but you can still invoke it\. The `LastUpdateStatus`, `LastUpdateStatusReason`, and `LastUpdateStatusReasonCode` fields in the response from [ GetFunctionConfiguration ](API_GetFunctionConfiguration.md) indicate when the update is complete and the function is processing events with the new configuration\. For more information, see [Function States](https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html)\. +When you update a function, Lambda provisions an instance of the function and its supporting resources\. If your function connects to a VPC, this process can take a minute\. During this time, you can't modify the function, but you can still invoke it\. The `LastUpdateStatus`, `LastUpdateStatusReason`, and `LastUpdateStatusReasonCode` fields in the response from [GetFunctionConfiguration](API_GetFunctionConfiguration.md) indicate when the update is complete and the function is processing events with the new configuration\. For more information, see [Function States](https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html)\. These settings can vary between versions of a function and are locked when you publish a version\. You can't modify the configuration of a published version, only the unpublished version\. -To configure function concurrency, use [ PutFunctionConcurrency ](API_PutFunctionConcurrency.md)\. To grant invoke permissions to an account or AWS service, use [ AddPermission ](API_AddPermission.md)\. +To configure function concurrency, use [PutFunctionConcurrency](API_PutFunctionConcurrency.md)\. To grant invoke permissions to an account or AWS service, use [AddPermission](API_AddPermission.md)\. ## Request Syntax @@ -57,7 +57,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [FunctionName](#API_UpdateFunctionConfiguration_RequestSyntax) ** The name of the Lambda function\. **Name formats** @@ -73,90 +73,90 @@ Required: Yes The request accepts the following data in JSON format\. - ** [ DeadLetterConfig ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [DeadLetterConfig](#API_UpdateFunctionConfiguration_RequestSyntax) ** A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing\. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq)\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object Required: No - ** [ Description ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [Description](#API_UpdateFunctionConfiguration_RequestSyntax) ** A description of the function\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. Required: No - ** [ Environment ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [Environment](#API_UpdateFunctionConfiguration_RequestSyntax) ** Environment variables that are accessible from function code during execution\. -Type: [ Environment ](API_Environment.md) object +Type: [Environment](API_Environment.md) object Required: No - ** [ FileSystemConfigs ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [FileSystemConfigs](#API_UpdateFunctionConfiguration_RequestSyntax) ** Connection settings for an Amazon EFS file system\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. Required: No - ** [ Handler ](#API_UpdateFunctionConfiguration_RequestSyntax) ** -The name of the method within your code that Lambda calls to execute your function\. The format includes the file name\. It can also include namespaces and other qualifiers, depending on the runtime\. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html)\. + ** [Handler](#API_UpdateFunctionConfiguration_RequestSyntax) ** +The name of the method within your code that Lambda calls to execute your function\. Handler is required if the deployment package is a \.zip file archive\. The format includes the file name\. It can also include namespaces and other qualifiers, depending on the runtime\. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html)\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` Required: No - ** [ ImageConfig ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [ImageConfig](#API_UpdateFunctionConfiguration_RequestSyntax) ** [Container image configuration values](https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html) that override the values in the container image Docker file\. -Type: [ ImageConfig ](API_ImageConfig.md) object +Type: [ImageConfig](API_ImageConfig.md) object Required: No - ** [ KMSKeyArn ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [KMSKeyArn](#API_UpdateFunctionConfiguration_RequestSyntax) ** The ARN of the AWS Key Management Service \(AWS KMS\) key that's used to encrypt your function's environment variables\. If it's not provided, AWS Lambda uses a default service key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` Required: No - ** [ Layers ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [Layers](#API_UpdateFunctionConfiguration_RequestSyntax) ** A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment\. Specify each layer by its ARN, including the version\. Type: Array of strings 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-_]+:[0-9]+` Required: No - ** [ MemorySize ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [MemorySize](#API_UpdateFunctionConfiguration_RequestSyntax) ** The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime\. Increasing the function memory also increases its CPU allocation\. The default value is 128 MB\. The value can be any multiple of 1 MB\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. Required: No - ** [ RevisionId ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [RevisionId](#API_UpdateFunctionConfiguration_RequestSyntax) ** Only update the function if the revision ID matches the ID that's specified\. Use this option to avoid modifying a function that has changed since you last read it\. Type: String Required: No - ** [ Role ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [Role](#API_UpdateFunctionConfiguration_RequestSyntax) ** The Amazon Resource Name \(ARN\) of the function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No - ** [ Runtime ](#API_UpdateFunctionConfiguration_RequestSyntax) ** -The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. + ** [Runtime](#API_UpdateFunctionConfiguration_RequestSyntax) ** +The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)\. Runtime is required if the deployment package is a \.zip file archive\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` Required: No - ** [ Timeout ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [Timeout](#API_UpdateFunctionConfiguration_RequestSyntax) ** The amount of time \(in seconds\) that Lambda allows a function to run before stopping it\. The default is 3 seconds\. The maximum allowed value is 900 seconds\. For additional information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)\. Type: Integer Valid Range: Minimum value of 1\. Required: No - ** [ TracingConfig ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [TracingConfig](#API_UpdateFunctionConfiguration_RequestSyntax) ** Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X\-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)\. -Type: [ TracingConfig ](API_TracingConfig.md) object +Type: [TracingConfig](API_TracingConfig.md) object Required: No - ** [ VpcConfig ](#API_UpdateFunctionConfiguration_RequestSyntax) ** + ** [VpcConfig](#API_UpdateFunctionConfiguration_RequestSyntax) ** For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC\. When you connect a function to a VPC, it can only access resources and the internet through that VPC\. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)\. -Type: [ VpcConfig ](API_VpcConfig.md) object +Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax @@ -245,157 +245,157 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ Architectures ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Architectures](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The instruction set architecture that the function supports\. Architecture is a string array with one of the valid values\. The default architecture value is `x86_64`\. Type: Array of strings Array Members: Fixed number of 1 item\. Valid Values:` x86_64 | arm64` - ** [ CodeSha256 ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [CodeSha256](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The SHA256 hash of the function's deployment package\. Type: String - ** [ CodeSize ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [CodeSize](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The size of the function's deployment package, in bytes\. Type: Long - ** [ DeadLetterConfig ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [DeadLetterConfig](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's dead letter queue\. -Type: [ DeadLetterConfig ](API_DeadLetterConfig.md) object +Type: [DeadLetterConfig](API_DeadLetterConfig.md) object - ** [ Description ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Description](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's description\. Type: String Length Constraints: Minimum length of 0\. Maximum length of 256\. - ** [ Environment ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Environment](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)\. -Type: [ EnvironmentResponse ](API_EnvironmentResponse.md) object +Type: [EnvironmentResponse](API_EnvironmentResponse.md) object - ** [ FileSystemConfigs ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [FileSystemConfigs](#API_UpdateFunctionConfiguration_ResponseSyntax) ** Connection settings for an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html)\. -Type: Array of [ FileSystemConfig ](API_FileSystemConfig.md) objects +Type: Array of [FileSystemConfig](API_FileSystemConfig.md) objects Array Members: Maximum number of 1 item\. - ** [ FunctionArn ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [FunctionArn](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's Amazon Resource Name \(ARN\)\. 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-_]+))?` - ** [ FunctionName ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [FunctionName](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The name of the function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 170\. 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-_]+))?` - ** [ Handler ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Handler](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function that Lambda calls to begin executing your function\. Type: String Length Constraints: Maximum length of 128\. Pattern: `[^\s]+` - ** [ ImageConfigResponse ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [ImageConfigResponse](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's image configuration values\. -Type: [ ImageConfigResponse ](API_ImageConfigResponse.md) object +Type: [ImageConfigResponse](API_ImageConfigResponse.md) object - ** [ KMSKeyArn ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [KMSKeyArn](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The AWS KMS key that's used to encrypt the function's environment variables\. This key is only returned if you've configured a customer managed key\. Type: String Pattern: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()` - ** [ LastModified ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [LastModified](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The date and time that the function was last updated, in [ISO\-8601 format](https://www.w3.org/TR/NOTE-datetime) \(YYYY\-MM\-DDThh:mm:ss\.sTZD\)\. Type: String - ** [ LastUpdateStatus ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatus](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The status of the last update that was performed on the function\. This is first set to `Successful` after function creation completes\. Type: String Valid Values:` Successful | Failed | InProgress` - ** [ LastUpdateStatusReason ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatusReason](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The reason for the last update that was performed on the function\. Type: String - ** [ LastUpdateStatusReasonCode ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [LastUpdateStatusReasonCode](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The reason code for the last update that was performed on the function\. Type: String Valid Values:` EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Layers ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Layers](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's [ layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\. -Type: Array of [ Layer ](API_Layer.md) objects +Type: Array of [Layer](API_Layer.md) objects - ** [ MasterArn ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [MasterArn](#API_UpdateFunctionConfiguration_ResponseSyntax) ** For Lambda@Edge functions, the ARN of the main function\. 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-_]+))?` - ** [ MemorySize ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [MemorySize](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The amount of memory available to the function at runtime\. Type: Integer Valid Range: Minimum value of 128\. Maximum value of 10240\. - ** [ PackageType ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [PackageType](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The type of deployment package\. Set to `Image` for container image and set `Zip` for \.zip file archive\. Type: String Valid Values:` Zip | Image` - ** [ RevisionId ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [RevisionId](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The latest updated revision of the function or alias\. Type: String - ** [ Role ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Role](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's execution role\. Type: String Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` - ** [ Runtime ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Runtime](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The runtime environment for the Lambda function\. Type: String Valid Values:` nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2` - ** [ SigningJobArn ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [SigningJobArn](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The ARN of the signing job\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ SigningProfileVersionArn ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [SigningProfileVersionArn](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The ARN of the signing profile version\. Type: String Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` - ** [ State ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [State](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The current state of the function\. When the state is `Inactive`, you can reactivate the function by invoking it\. Type: String Valid Values:` Pending | Active | Inactive | Failed` - ** [ StateReason ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [StateReason](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The reason for the function's current state\. Type: String - ** [ StateReasonCode ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [StateReasonCode](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The reason code for the function's current state\. When the code is `Creating`, you can't invoke or modify the function\. Type: String Valid Values:` Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage` - ** [ Timeout ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Timeout](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The amount of time in seconds that Lambda allows a function to run before stopping it\. Type: Integer Valid Range: Minimum value of 1\. - ** [ TracingConfig ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [TracingConfig](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's AWS X\-Ray tracing configuration\. -Type: [ TracingConfigResponse ](API_TracingConfigResponse.md) object +Type: [TracingConfigResponse](API_TracingConfigResponse.md) object - ** [ Version ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [Version](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The version of the Lambda function\. Type: String Length Constraints: Minimum length of 1\. Maximum length of 1024\. Pattern: `(\$LATEST|[0-9]+)` - ** [ VpcConfig ](#API_UpdateFunctionConfiguration_ResponseSyntax) ** + ** [VpcConfig](#API_UpdateFunctionConfiguration_ResponseSyntax) ** The function's networking configuration\. -Type: [ VpcConfigResponse ](API_VpcConfigResponse.md) object +Type: [VpcConfigResponse](API_VpcConfigResponse.md) object ## Errors @@ -438,12 +438,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionConfiguration) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionConfiguration) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionConfiguration) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionConfiguration) \ No newline at end of file diff --git a/doc_source/API_UpdateFunctionEventInvokeConfig.md b/doc_source/API_UpdateFunctionEventInvokeConfig.md old mode 100644 new mode 100755 index 35d1ba27..cd8ae575 --- a/doc_source/API_UpdateFunctionEventInvokeConfig.md +++ b/doc_source/API_UpdateFunctionEventInvokeConfig.md @@ -2,7 +2,7 @@ Updates the configuration for asynchronous invocation for a function, version, or alias\. -To configure options for asynchronous invocation, use [ PutFunctionEventInvokeConfig ](API_PutFunctionEventInvokeConfig.md)\. +To configure options for asynchronous invocation, use [PutFunctionEventInvokeConfig](API_PutFunctionEventInvokeConfig.md)\. ## Request Syntax @@ -28,7 +28,7 @@ Content-type: application/json The request uses the following URI parameters\. - ** [ FunctionName ](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** + ** [FunctionName](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** The name of the Lambda function, version, or alias\. **Name formats** @@ -40,7 +40,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_UpdateFunctionEventInvokeConfig_RequestSyntax) ** + ** [Qualifier](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** A version number or alias name\. Length Constraints: Minimum length of 1\. Maximum length of 128\. Pattern: `(|[a-zA-Z0-9$_-]+)` @@ -49,7 +49,7 @@ Pattern: `(|[a-zA-Z0-9$_-]+)` The request accepts the following data in JSON format\. - ** [ DestinationConfig ](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** + ** [DestinationConfig](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** A destination for events after they have been sent to a function for processing\. **Destinations** @@ -57,16 +57,16 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object Required: No - ** [ MaximumEventAgeInSeconds ](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** + ** [MaximumEventAgeInSeconds](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** The maximum age of a request that Lambda sends to a function for processing\. Type: Integer Valid Range: Minimum value of 60\. Maximum value of 21600\. Required: No - ** [ MaximumRetryAttempts ](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** + ** [MaximumRetryAttempts](#API_UpdateFunctionEventInvokeConfig_RequestSyntax) ** The maximum number of times to retry when the function returns an error\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 2\. @@ -100,7 +100,7 @@ If the action is successful, the service sends back an HTTP 200 response\. The following data is returned in JSON format by the service\. - ** [ DestinationConfig ](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** + ** [DestinationConfig](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** A destination for events after they have been sent to a function for processing\. **Destinations** @@ -108,23 +108,23 @@ A destination for events after they have been sent to a function for processing\ + **Queue** \- The ARN of an SQS queue\. + **Topic** \- The ARN of an SNS topic\. + **Event Bus** \- The ARN of an Amazon EventBridge event bus\. -Type: [ DestinationConfig ](API_DestinationConfig.md) object +Type: [DestinationConfig](API_DestinationConfig.md) object - ** [ FunctionArn ](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** + ** [FunctionArn](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** The Amazon Resource Name \(ARN\) of the function\. 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-_]+))?` - ** [ LastModified ](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** + ** [LastModified](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** The date and time that the configuration was last updated, in Unix time seconds\. Type: Timestamp - ** [ MaximumEventAgeInSeconds ](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumEventAgeInSeconds](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** The maximum age of a request that Lambda sends to a function for processing\. Type: Integer Valid Range: Minimum value of 60\. Maximum value of 21600\. - ** [ MaximumRetryAttempts ](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** + ** [MaximumRetryAttempts](#API_UpdateFunctionEventInvokeConfig_ResponseSyntax) ** The maximum number of times to retry when the function returns an error\. Type: Integer Valid Range: Minimum value of 0\. Maximum value of 2\. @@ -154,12 +154,12 @@ HTTP Status Code: 429 ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) \ No newline at end of file ++ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/UpdateFunctionEventInvokeConfig) \ No newline at end of file diff --git a/doc_source/API_VpcConfig.md b/doc_source/API_VpcConfig.md old mode 100644 new mode 100755 index 5cf2d276..00a22693 --- a/doc_source/API_VpcConfig.md +++ b/doc_source/API_VpcConfig.md @@ -19,7 +19,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/VpcConfig) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/VpcConfig) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/VpcConfig) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/VpcConfig) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/VpcConfig) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/VpcConfig) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/VpcConfig) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/VpcConfig) \ No newline at end of file diff --git a/doc_source/API_VpcConfigResponse.md b/doc_source/API_VpcConfigResponse.md old mode 100644 new mode 100755 index af0b36fd..24c5badc --- a/doc_source/API_VpcConfigResponse.md +++ b/doc_source/API_VpcConfigResponse.md @@ -24,7 +24,7 @@ Required: No ## See Also For more information about using this API in one of the language\-specific AWS SDKs, see the following: -+ [ AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/VpcConfigResponse) -+ [ AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/VpcConfigResponse) -+ [ AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/VpcConfigResponse) -+ [ AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/VpcConfigResponse) \ No newline at end of file ++ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/VpcConfigResponse) ++ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/VpcConfigResponse) ++ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/VpcConfigResponse) ++ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/VpcConfigResponse) \ No newline at end of file diff --git a/doc_source/access-control-identity-based.md b/doc_source/access-control-identity-based.md old mode 100644 new mode 100755 diff --git a/doc_source/access-control-resource-based.md b/doc_source/access-control-resource-based.md old mode 100644 new mode 100755 index f1bb64c7..32620b0f --- a/doc_source/access-control-resource-based.md +++ b/doc_source/access-control-resource-based.md @@ -6,7 +6,7 @@ For Lambda functions, you can [grant an account permission](#permissions-resourc **To view a function's resource\-based policy** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -27,7 +27,7 @@ For Lambda functions, you can [grant an account permission](#permissions-resourc "Service": "s3.amazonaws.com" }, "Action": "lambda:InvokeFunction", - "Resource": "arn:aws:lambda:us-east-2:123456789012:function:my-function:*", + "Resource": "arn:aws:lambda:us-east-2:123456789012:function:my-function", "Condition": { "StringEquals": { "AWS:SourceAccount": "123456789012" diff --git a/doc_source/applications-console.md b/doc_source/applications-console.md old mode 100644 new mode 100755 diff --git a/doc_source/applications-tutorial.md b/doc_source/applications-tutorial.md old mode 100644 new mode 100755 diff --git a/doc_source/applications-usecases.md b/doc_source/applications-usecases.md old mode 100644 new mode 100755 diff --git a/doc_source/best-practices.md b/doc_source/best-practices.md old mode 100644 new mode 100755 index 0cc90bf8..a8793dde --- a/doc_source/best-practices.md +++ b/doc_source/best-practices.md @@ -36,6 +36,7 @@ For more information about best practices for Lambda applications, see [Applicat + **Reduce the time it takes Lambda to unpack deployment packages** authored in Java by putting your dependency `.jar` files in a separate /lib directory\. This is faster than putting all your function’s code in a single jar with a large number of `.class` files\. See [Deploy Java Lambda functions with \.zip or JAR file archives](java-package.md) for instructions\. + **Minimize the complexity of your dependencies\.** Prefer simpler frameworks that load quickly on [execution environment](runtimes-context.md) startup\. For example, prefer simpler Java dependency injection \(IoC\) frameworks like [Dagger](https://google.github.io/dagger/) or [Guice](https://github.com/google/guice), over more complex ones like [Spring Framework](https://github.com/spring-projects/spring-framework)\. + **Avoid using recursive code** in your Lambda function, wherein the function automatically calls itself until some arbitrary criteria is met\. This could lead to unintended volume of function invocations and escalated costs\. If you do accidentally do so, set the function reserved concurrency to `0` immediately to throttle all invocations to the function, while you update the code\. ++ **Do not use non\-documented, non\-public APIs** in your Lambda function code\. For AWS Lambda managed runtimes, Lambda periodically applies security and functional updates to Lambda's internal APIs\. These internal API updates may be backwards\-incompatible, leading to unintended consequences such as invocation failures if your function has a dependency on these non\-public APIs\. See [the API reference](API_Operations.md) for a list of publicly available APIs\. ## Function configuration + **Performance testing your Lambda function** is a crucial part in ensuring you pick the optimum memory size configuration\. Any increase in memory size triggers an equivalent increase in CPU available to your function\. The memory usage for your function is determined per\-invoke and can be viewed in [Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatchLogs.html)\. On each invoke a `REPORT:` entry will be made, as shown below: @@ -58,12 +59,12 @@ For more information about best practices for Lambda applications, see [Applicat + In the case of **UpdateFunctionConfiguration**, it could result in duplicate invocations of the function\. ## Metrics and alarms -+ **Use [Working with AWS Lambda function metrics](monitoring-metrics.md) and [ CloudWatch Alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)** instead of creating or updating a metric from within your Lambda function code\. It's a much more efficient way to track the health of your Lambda functions, allowing you to catch issues early in the development process\. For instance, you can configure an alarm based on the expected duration of your Lambda function invocation in order to address any bottlenecks or latencies attributable to your function code\. ++ **Use [Working with Lambda function metrics](monitoring-metrics.md) and [ CloudWatch Alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)** instead of creating or updating a metric from within your Lambda function code\. It's a much more efficient way to track the health of your Lambda functions, allowing you to catch issues early in the development process\. For instance, you can configure an alarm based on the expected duration of your Lambda function invocation in order to address any bottlenecks or latencies attributable to your function code\. + **Leverage your logging library and [AWS Lambda Metrics and Dimensions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/lam-metricscollected.html)** to catch app errors \(e\.g\. ERR, ERROR, WARNING, etc\.\) ## Working with streams + **Test with different batch and record sizes **so that the polling frequency of each event source is tuned to how quickly your function is able to complete its task\. The [CreateEventSourceMapping](API_CreateEventSourceMapping.md) BatchSize parameter controls the maximum number of records that can be sent to your function with each invoke\. A larger batch size can often more efficiently absorb the invoke overhead across a larger set of records, increasing your throughput\. - By default, Lambda invokes your function as soon as records are available in the stream\. If the batch that Lambda reads from the stream only has one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to five minutes by configuring a *batch window*\. Before invoking the function, Lambda continues to read records from the stream until it has gathered a full batch, or until the batch window expires\. + By default, Lambda invokes your function as soon as records are available\. If the batch that Lambda reads from the event source has only one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to 5 minutes by configuring a *batching window*\. Before invoking the function, Lambda continues to read records from the event source until it has gathered a full batch, the batching window expires, or the batch reaches the payload limit of 6 MB\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. + **Increase Kinesis stream processing throughput by adding shards\.** A Kinesis stream is composed of one or more shards\. Lambda will poll each shard with at most one concurrent invocation\. For example, if your stream has 100 active shards, there will be at most 100 Lambda function invocations running concurrently\. Increasing the number of shards will directly increase the number of maximum concurrent Lambda function invocations and can increase your Kinesis stream processing throughput\. If you are increasing the number of shards in a Kinesis stream, make sure you have picked a good partition key \(see [Partition Keys](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key)\) for your data, so that related records end up on the same shards and your data is well distributed\. + **Use [Amazon CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html)** on IteratorAge to determine if your Kinesis stream is being processed\. For example, configure a CloudWatch alarm with a maximum setting to 30000 \(30 seconds\)\. \ No newline at end of file diff --git a/doc_source/configuration-aliases.md b/doc_source/configuration-aliases.md old mode 100644 new mode 100755 index 1b3f53ba..ba8e9806 --- a/doc_source/configuration-aliases.md +++ b/doc_source/configuration-aliases.md @@ -15,7 +15,7 @@ You can create a function alias using the Lambda console\. **To create an alias** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -62,7 +62,7 @@ aws lambda delete-alias --function-name my-function --name alias-name Each alias has a unique ARN\. An alias can point only to a function version, not to another alias\. You can update an alias to point to a new version of the function\. -Event sources such as Amazon Simple Storage Service \(Amazon S3\) invoke your Lambda function\. These event sources maintain a mapping that identifies the function to invoke when events occur\. If you specify a Lambda function alias in the mapping configuration, you don't need to update the mapping when the function version changes\. For more information, see [AWS Lambda event source mappings](invocation-eventsourcemapping.md)\. +Event sources such as Amazon Simple Storage Service \(Amazon S3\) invoke your Lambda function\. These event sources maintain a mapping that identifies the function to invoke when events occur\. If you specify a Lambda function alias in the mapping configuration, you don't need to update the mapping when the function version changes\. For more information, see [Lambda event source mappings](invocation-eventsourcemapping.md)\. In a resource policy, you can grant permissions for event sources to use your Lambda function\. If you specify an alias ARN in the policy, you don't need to update the policy when the function version changes\. @@ -97,7 +97,7 @@ You can point an alias to a maximum of two Lambda function versions\. The versio **Note** Verify that the function has at least two published versions\. To create additional versions, follow the instructions in [Lambda function versions](configuration-versions.md)\. -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -155,7 +155,7 @@ When you configure traffic weights between two function versions, there are two `19:44:37 START RequestId: request id Version: $version ` - For alias invocations, Lambda uses the `Executed Version` dimension to filter the metric data by the invoked version\. For more information, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. + For alias invocations, Lambda uses the `Executed Version` dimension to filter the metric data by the invoked version\. For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. + **Response payload \(synchronous invocations\)** – Responses to synchronous function invocations include an `x-amz-executed-version` header to indicate which function version has been invoked\. \ No newline at end of file diff --git a/doc_source/configuration-codesigning.md b/doc_source/configuration-codesigning.md old mode 100644 new mode 100755 index f61f5d92..49be75a6 --- a/doc_source/configuration-codesigning.md +++ b/doc_source/configuration-codesigning.md @@ -119,7 +119,7 @@ To enable code signing for a function, you associate a code signing configuratio **To associate a code signing configuration with a function \(console\)** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function for which you want to enable code signing\. diff --git a/doc_source/configuration-concurrency.md b/doc_source/configuration-concurrency.md old mode 100644 new mode 100755 index eece79db..bbfbefac --- a/doc_source/configuration-concurrency.md +++ b/doc_source/configuration-concurrency.md @@ -20,7 +20,7 @@ To manage reserved concurrency settings for a function, use the Lambda console\. **To reserve concurrency for a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/configuration-database.md b/doc_source/configuration-database.md old mode 100644 new mode 100755 index b7a76747..04478967 --- a/doc_source/configuration-database.md +++ b/doc_source/configuration-database.md @@ -13,7 +13,7 @@ You can use the Lambda console to create an Amazon RDS Proxy database proxy\. **To create a database proxy** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -85,9 +85,9 @@ For more information, see [IAM database authentication](https://docs.aws.amazon. Sample applications that demonstrate the use of Lambda with an Amazon RDS database are available in this guide's GitHub repository\. There are two applications: + [RDS MySQL](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/rds-mysql) – The AWS CloudFormation template `template-vpcrds.yml` creates a MySQL 5\.7 database in a private VPC\. In the sample application, a Lambda function proxies queries to the database\. The function and database templates both use Secrets Manager to access database credentials\. - [ ![\[The dbadmin function relays queries to a database.\]](http://docs.aws.amazon.com/lambda/latest/dg/images/sample-rdsmysql.png)](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/rds-mysql) + [https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/rds-mysql](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/rds-mysql) + [List Manager](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/list-manager) – A processor function reads events from a Kinesis stream\. It uses the data from the events to update DynamoDB tables, and stores a copy of the event in a MySQL database\. - [ ![\[The processor function processes Kinesis events and stores the events in a MySQL database.\]](http://docs.aws.amazon.com/lambda/latest/dg/images/sample-listmanager.png)](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/list-manager) + [https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/list-manager](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/list-manager) To use the sample applications, follow the instructions in the GitHub repository: [RDS MySQL](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/rds-mysql/README.md), [List Manager](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/list-manager/README.md)\. \ No newline at end of file diff --git a/doc_source/configuration-envvars.md b/doc_source/configuration-envvars.md old mode 100644 new mode 100755 index 4de65981..ff33dc53 --- a/doc_source/configuration-envvars.md +++ b/doc_source/configuration-envvars.md @@ -24,7 +24,7 @@ You create an environment variable for your function by defining a key and a val **To set environment variables in the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -228,7 +228,7 @@ For additional security, you can enable helpers for encryption in transit, which 1. Using the Lambda console, navigate to the **Edit environment variables** page\. - 1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. + 1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -242,7 +242,7 @@ For additional security, you can enable helpers for encryption in transit, which 1. Under **Encryption in transit**, choose **Enable helpers for encryption in transit**\. - 1. For each environment variable that you want to enable console encryption helpers for, choose **Encrypt** next ot the environment variable\. + 1. For each environment variable that you want to enable console encryption helpers for, choose **Encrypt** next to the environment variable\. 1. Under AWS KMS key to encrypt in transit, choose a customer managed key that you created at the beginning of this procedure\. diff --git a/doc_source/configuration-filesystem.md b/doc_source/configuration-filesystem.md old mode 100644 new mode 100755 index dfc08d2d..93ea99d0 --- a/doc_source/configuration-filesystem.md +++ b/doc_source/configuration-filesystem.md @@ -12,13 +12,13 @@ You can configure a function to mount an Amazon Elastic File System \(Amazon EFS ## Execution role and user permissions -Lambda uses your function's permissions to mount file systems\. To connect to a file system, your function's execution role must have the following permissions in addition to the [permissions required to connect to the file system's VPC](configuration-vpc.md#vpc-permissions): +If the file system doesn't have a user\-configured IAM policy, EFS uses a default policy that grants full access to any client that can connect to the file system using a file system mount target\. If the file system has a user\-configured IAM policy, your function's execution role must have the correct `elasticfilesystem` permissions\. **Execution role permissions** + **elasticfilesystem:ClientMount** + **elasticfilesystem:ClientWrite \(not required for read\-only connections\)** -These permissions are included in the **AmazonElasticFileSystemClientReadWriteAccess** managed policy\. +These permissions are included in the **AmazonElasticFileSystemClientReadWriteAccess** managed policy\. Additionally, your execution role must have the [permissions required to connect to the file system's VPC](configuration-vpc.md#vpc-permissions)\. When you configure a file system, Lambda uses your permissions to verify mount targets\. To configure a function to connect to a file system, your IAM user needs the following permissions: @@ -58,7 +58,7 @@ If your function is not already connected to a VPC, see [Configuring a Lambda fu **To configure file system access** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/configuration-function-common.md b/doc_source/configuration-function-common.md old mode 100644 new mode 100755 index 1c963dc4..840bb9ad --- a/doc_source/configuration-function-common.md +++ b/doc_source/configuration-function-common.md @@ -30,7 +30,7 @@ The **Function overview** shows a visualization of your function and its upstrea ## Configuring functions \(console\) -For the following function configurations, you can change the settings only for the unpublished version of a function\. In the console, the function **configuration** tab provides the following sections: +For the following function configurations, you can change the settings only for the unpublished version of a function\. In the console, the function **Configuration** tab provides the following sections: + **General configuration** – Configure [memory](#configuration-memory-console) or opt in to the [AWS Compute Optimizer](#configuration-memory-optimization-accept)\. You can also configure function timeout and the execution role\. + **Permissions** – Configure the execution role and other [permissions](lambda-permissions.md)\. + **Environment variables** – Key\-value pairs that Lambda sets in the execution environment\. To extend your function's configuration outside of code, [use environment variables](configuration-envvars.md)\. @@ -81,7 +81,7 @@ You can configure the memory of your function in the Lambda console\. **To update the memory of a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -102,7 +102,7 @@ When you've opted in and your [Lambda function meets Compute Optimizer requireme **To accept a function memory recommendation** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -120,7 +120,7 @@ For details about how services trigger Lambda functions, see [Using AWS Lambda w **To add a trigger to your function\.** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update\. @@ -136,7 +136,7 @@ You can create test events for your function from the **Test** tab\. **To create a test event** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -152,7 +152,7 @@ Saved test events are also available from the **Code** tab, under the **Test** m **To test the function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. diff --git a/doc_source/configuration-function-zip.md b/doc_source/configuration-function-zip.md old mode 100644 new mode 100755 index 5e4ed1d7..dead45ae --- a/doc_source/configuration-function-zip.md +++ b/doc_source/configuration-function-zip.md @@ -22,7 +22,7 @@ When you create a function defined with a \.zip file archive, you choose a code **To create the function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -30,7 +30,7 @@ When you create a function defined with a \.zip file archive, you choose a code 1. Under **Basic information**, do the following: - 1. For **Function name**, enter the function name\. + 1. For **Function name**, enter the function name\. Function names are limited to 64 characters in length\. 1. For **Runtime**, choose the language version to use for your function\. @@ -59,7 +59,7 @@ For scripting languages \(Node\.js, Python, and Ruby\), you can edit your functi **To upload function code as a \.zip archive** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update and choose the **Code** tab\. @@ -116,7 +116,7 @@ If you update the function configuration to use a new runtime version, you may n **To change the runtime or runtime version** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update and choose the **Code** tab\. @@ -177,7 +177,7 @@ However, if you provide your function code using a \.zip file archive deployment **To change the instruction set architecture** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update and choose the **Code** tab\. diff --git a/doc_source/configuration-images.md b/doc_source/configuration-images.md old mode 100644 new mode 100755 index f5ffb645..0d8ff94c --- a/doc_source/configuration-images.md +++ b/doc_source/configuration-images.md @@ -122,7 +122,7 @@ To create a function defined as a container image, you must first [create the im **To create the function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -130,7 +130,7 @@ To create a function defined as a container image, you must first [create the im 1. Under **Basic information**, do the following: - 1. For **Function name**, enter the function name\. + 1. For **Function name**, enter the function name\. Function names are limited to 64 characters in length\. 1. For **Container image URI**, provide a container image that is compatible with the instruction set architecture that you want for your function code\. @@ -169,7 +169,7 @@ After you deploy a container image to a function, the image is read\-only\. To u **To configure the function to use an updated container image** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update\. @@ -187,7 +187,7 @@ You can use the Lambda console to override the configuration values in the conta **To override the configuration values in the container image** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to update\. diff --git a/doc_source/configuration-layers.md b/doc_source/configuration-layers.md old mode 100644 new mode 100755 index bdff631f..63b41caa --- a/doc_source/configuration-layers.md +++ b/doc_source/configuration-layers.md @@ -1,6 +1,8 @@ # Creating and sharing Lambda layers -A Lambda layer is a \.zip file archive that can contain additional code or data\. A layer can contain libraries, a [custom runtime](runtimes-custom.md), data, or configuration files\. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic\. +Lambda [layers](gettingstarted-concepts.md#gettingstarted-concepts-layer) provide a convenient way to package libraries and other dependencies that you can use with your Lambda functions\. Using layers reduces the size of uploaded deployment archives and makes it faster to deploy your code\. + +A layer is a \.zip file archive that can contain additional code or data\. A layer can contain libraries, a [custom runtime](runtimes-custom.md), data, or configuration files\. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic\. You can use layers only with Lambda functions [deployed as a \.zip file archive](gettingstarted-package.md#gettingstarted-package-zip)\. For functions [defined as a container image](lambda-images.md), you package your preferred runtime and all code dependencies when you create the container image\. For more information, see [Working with Lambda layers and extensions in container images](http://aws.amazon.com/blogs/compute/working-with-lambda-layers-and-extensions-in-container-images/) on the AWS Compute Blog\. diff --git a/doc_source/configuration-tags.md b/doc_source/configuration-tags.md old mode 100644 new mode 100755 index 8e85efb3..3c3cc12e --- a/doc_source/configuration-tags.md +++ b/doc_source/configuration-tags.md @@ -21,7 +21,7 @@ You can use the console to add tags to existing functions and to filter function For more information, see [Identity\-based IAM policies for Lambda](access-control-identity-based.md)\. -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -48,7 +48,7 @@ Tags apply at the function level, not to versions or aliases\. Tags are not part + lambda:ListTags grants permission to view functions that have tags\. + lambda:TagResource grants permission to add tags to a function\. -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Click within the search bar to see a list of function attributes and tag keys\. ![\[\]](http://docs.aws.amazon.com/lambda/latest/dg/images/configuration-tags-key.png) @@ -130,4 +130,4 @@ The following requirements apply to tags: + Maximum value length—256 Unicode characters in UTF\-8 + Tag keys and values are case sensitive\. + Do not use the `aws:` prefix in your tag names or values because it is reserved for AWS use\. You can't edit or delete tag names or values with this prefix\. Tags with this prefix do not count against your tags per resource limit\. -+ If your tagging schema will be used across multiple services and resources, remember that other services may have restrictions on allowed characters\. Generally allowed characters are: letters, spaces, and numbers representable in UTF\-8, plus the following special characters: \+ \- = \. \_ : / @\. ++ If your tagging schema will be used across multiple services and resources, remember that other services may have restrictions on allowed characters\. Generally allowed characters are: letters, spaces, and numbers representable in UTF\-8, plus the following special characters: \+ \- = \. \_ : / @\. \ No newline at end of file diff --git a/doc_source/configuration-versions.md b/doc_source/configuration-versions.md old mode 100644 new mode 100755 index e8b3b26e..da0fcc7c --- a/doc_source/configuration-versions.md +++ b/doc_source/configuration-versions.md @@ -25,7 +25,7 @@ You can create a function version using the Lambda console\. **To create a new function version** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function and then choose **Versions**\. diff --git a/doc_source/configuration-vpc-endpoints.md b/doc_source/configuration-vpc-endpoints.md old mode 100644 new mode 100755 diff --git a/doc_source/configuration-vpc.md b/doc_source/configuration-vpc.md old mode 100644 new mode 100755 index de3d4e65..8ac162f6 --- a/doc_source/configuration-vpc.md +++ b/doc_source/configuration-vpc.md @@ -54,7 +54,7 @@ If your [IAM permissions](#vpc-conditions) allow you only to create Lambda funct **To configure a VPC when you create a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -72,7 +72,7 @@ To access private resources, connect your function to private subnets\. If your **To configure a VPC for an existing function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/csharp-context.md b/doc_source/csharp-context.md old mode 100644 new mode 100755 diff --git a/doc_source/csharp-exceptions.md b/doc_source/csharp-exceptions.md old mode 100644 new mode 100755 index 767bfdc4..dc25eefe --- a/doc_source/csharp-exceptions.md +++ b/doc_source/csharp-exceptions.md @@ -14,7 +14,7 @@ This page describes how to view Lambda function invocation errors for the C\# ru ## Syntax -In the initialization phase, exceptions can be thrown for invalid handler strings, a rule\-breaking type or method \(see [Lambda function handler restrictions ](csharp-handler.md#csharp-handler-restrictions)\), or any other validation method \(such as forgetting the serializer attribute and having a POCO as your input or output type\)\. These exceptions are of type `LambdaException`\. For example: +In the initialization phase, exceptions can be thrown for invalid handler strings, a rule\-breaking type or method \(see [Lambda function handler restrictions](csharp-handler.md#csharp-handler-restrictions)\), or any other validation method \(such as forgetting the serializer attribute and having a POCO as your input or output type\)\. These exceptions are of type `LambdaException`\. For example: ``` { @@ -151,7 +151,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -184,7 +184,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: @@ -204,7 +204,7 @@ cat output.txt You should see the invocation response in your command prompt\. -Lambda also records up to 256 KB of the error object in the function's logs\. For more information, see [AWS Lambda function logging in C\#](csharp-logging.md)\. +Lambda also records up to 256 KB of the error object in the function's logs\. For more information, see [Lambda function logging in C\#](csharp-logging.md)\. ## Error handling in other AWS services @@ -219,4 +219,4 @@ We recommend using AWS X\-Ray to determine the source of an error and its cause\ For more information, see [Instrumenting C\# code in AWS Lambda](csharp-tracing.md)\. ## What's next? -+ Learn how to show logging events for your Lambda function on the [AWS Lambda function logging in C\#](csharp-logging.md) page\. \ No newline at end of file ++ Learn how to show logging events for your Lambda function on the [Lambda function logging in C\#](csharp-logging.md) page\. \ No newline at end of file diff --git a/doc_source/csharp-handler.md b/doc_source/csharp-handler.md old mode 100644 new mode 100755 index c53803cc..f2423e9b --- a/doc_source/csharp-handler.md +++ b/doc_source/csharp-handler.md @@ -1,8 +1,8 @@ -# AWS Lambda function handler in C\# +# Lambda function handler in C\# The Lambda function *handler* is the method in your function code that processes events\. When your function is invoked, Lambda runs the handler method\. When the handler exits or returns a response, it becomes available to handle another event\. -You define a Lambda function handler as an instance or static method in a class\. If you want access to the Lambda context object, it is available by defining a method parameter of type *ILambdaContext*, an interface you can use to access information about the current invocation, such as the name of the current function, the memory limit, execution time remaining, and logging\. +You define a Lambda function handler as an instance or static method in a class\. For access to the Lambda context object, you can define a method parameter of type *ILambdaContext*\. You can use this to access information about the current invocation, such as the name of the function, memory limit, remaining execution time, and logging\. ``` returnType handler-name(inputType input, ILambdaContext context) { @@ -11,17 +11,17 @@ returnType handler-name(inputType input, ILambdaContext context) { ``` In the syntax, note the following: -+ *inputType* – The first handler parameter is the input to the handler, which can be event data \(published by an event source\) or custom input that you provide such as a string or any custom data object\. -+ *returnType* – If you plan to invoke the Lambda function synchronously \(using the `RequestResponse` invocation type\), you can return the output of your function using any of the supported data types\. For example, if you use a Lambda function as a mobile application backend, you are invoking it synchronously\. Your output data type will be serialized into JSON\. ++ *inputType* – The first handler parameter is the input to the handler\. This can be event data \(that an event source publishes\) or custom input that you provide, such as a string or any custom data object\. ++ *returnType* – If you plan to invoke the Lambda function synchronously \(using the `RequestResponse` invocation type\), you can return the output of your function using any of the supported data types\. For example, if you use a Lambda function as a mobile application backend, you are invoking it synchronously\. Your output data type is serialized into JSON\. - If you plan to invoke the Lambda function asynchronously \(using the `Event` invocation type\), the `returnType` should be `void`\. For example, if you use AWS Lambda with event sources such as Amazon S3 or Amazon SNS, these event sources invoke the Lambda function using the `Event` invocation type\. -+ `ILambdaContext context` – The second argument in the handler signature is optional\. It provides access to the [context object](csharp-context.md) which has information about the function and request\. + If you plan to invoke the Lambda function asynchronously \(using the `Event` invocation type\), the `returnType` should be `void`\. For example, if you use Lambda with event sources such as Amazon Simple Storage Service \(Amazon S3\) or Amazon Simple Notification Service \(Amazon SNS\), these event sources invoke the Lambda function using the `Event` invocation type\. ++ `ILambdaContext context` – The second argument in the handler signature is optional\. It provides access to the [context object](csharp-context.md), which has information about the function and request\. ## Handling streams -Only the `System.IO.Stream` type is supported as an input parameter by default\. +By default, Lambda supports only the `System.IO.Stream` type as an input parameter\. -For example, consider the following C\# example code\. +For example, consider the following C\# example code\. ``` using System.IO; @@ -38,34 +38,130 @@ namespace Example } ``` -In the example C\# code, the first handler parameter is the input to the handler \(MyHandler\), which can be event data \(published by an event source such as Amazon S3\) or custom input you provide such as a `Stream` \(as in this example\) or any custom data object\. The output is of type `Stream`\. +In the example C\# code, the first handler parameter is the input to the handler \(MyHandler\)\. This can be event data \(published by an event source such as Amazon S3\) or custom input that you provide, such as a `Stream` \(as in this example\) or any custom data object\. The output is of type `Stream`\. ## Handling standard data types -All other types, as listed below, require you to specify a serializer\. -+ Primitive \.NET types \(such as string or int\)\. -+ Collections and maps \- IList, IEnumerable, IList, Array, IDictionary, IDictionary +All the following other types require you to specify a serializer: ++ Primitive \.NET types \(such as string or int\) ++ Collections and maps – IList, IEnumerable, IList, Array, IDictionary, IDictionary + POCO types \(Plain old CLR objects\) + Predefined AWS event types -+ For asynchronous invocations the return\-type will be ignored by Lambda\. The return type may be set to void in such cases\. -+ If you are using \.NET asynchronous programming, the return type can be Task and Task types and use `async` and `await` keywords\. For more information, see [Using async in C\# functions with AWS Lambda](#csharp-handler-async)\. ++ For asynchronous invocations, Lambda ignores the return type\. In such cases, the return type may be set to void\. ++ If you are using \.NET asynchronous programming, the return type can be Task and Task types and use `async` and `await` keywords\. For more information, see [Using async in C\# functions with Lambda](#csharp-handler-async)\. -Unless your function input and output parameters are of type `System.IO.Stream`, you will need to serialize them\. AWS Lambda provides a default serializers that can be applied at the assembly or method level of your application, or you can define your own by implementing the `ILambdaSerializer` interface provided by the `Amazon.Lambda.Core` library\. For more information, see [Deploy C\# Lambda functions with \.zip file archives](csharp-package.md)\. +Unless your function input and output parameters are of type `System.IO.Stream`, you must serialize them\. Lambda provides default serializers that can be applied at the assembly or method level of your application, or you can define your own by implementing the `ILambdaSerializer` interface provided by the `Amazon.Lambda.Core` library\. For more information, see [Deploy C\# Lambda functions with \.zip file archives](csharp-package.md)\. -Instruction how to define serialize you can find in [Serializing Lambda functions](#csharp-handler-serializer)\. + To add the default serializer attribute to a method, first add a dependency on `Amazon.Lambda.Serialization.SystemTextJson` in your `.csproj` file\. + +``` + + + + net6.0 + enable + enable + true + Lambda + + true + + true + + + + + + + + +``` + +The example below illustrates the flexibility you can leverage by specifying the default System\.Text\.Json serializer on one method and another of your choosing on a different method: + +``` +public class ProductService + { + [LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))] + public Product DescribeProduct(DescribeProductRequest request) + { + return catalogService.DescribeProduct(request.Id); + } + + [LambdaSerializer(typeof(MyJsonSerializer))] + public Customer DescribeCustomer(DescribeCustomerRequest request) + { + return customerService.DescribeCustomer(request.Id); + } +} +``` + +### Source generation for JSON serialization + +C\# 9 provides source generators that allow code generation during compilation\. Starting with \.NET 6, the native JSON library `System.Text.Json` can use source generators, allowing JSON parsing without the need for reflection APIs\. This can help improve cold start performance\. + +**To use the source generator** + +1. In your project, define an empty, partial class that derives from `System.Text.Json.Serialization.JsonSerializerContext`\. + +1. Add the `JsonSerializable` attribute for each \.NET type that the source generator must generate serialization code for\. + +**Example API Gateway integration leveraging source generation** + +``` +using System.Collections.Generic; +using System.Net; +using System.Text.Json.Serialization; + +using Amazon.Lambda.Core; +using Amazon.Lambda.APIGatewayEvents; +using Amazon.Lambda.Serialization.SystemTextJson; + +[assembly: +LambdaSerializer(typeof(SourceGeneratorLambdaJsonSerializer))] + +namespace SourceGeneratorExample; + +[JsonSerializable(typeof(APIGatewayHttpApiV2ProxyRequest))] +[JsonSerializable(typeof(APIGatewayHttpApiV2ProxyResponse))] +public partial class HttpApiJsonSerializerContext : JsonSerializerContext +{ +} + +public class Functions +{ + public APIGatewayProxyResponse Get(APIGatewayHttpApiV2ProxyRequest +request, ILambdaContext context) + { + context.Logger.LogInformation("Get Request"); + var response = new APIGatewayHttpApiV2ProxyResponse + { + StatusCode = (int)HttpStatusCode.OK, + Body = "Hello AWS Serverless", + Headers = new Dictionary { { "Content-Type", +"text/plain" } } + }; + + return response; + } +} +``` + +When you invoke your function, Lambda uses the source\-generated JSON serialization code to handle the serialization of Lambda events and responses\. ## Handler signatures -When creating Lambda functions, you have to provide a handler string that tells AWS Lambda where to look for the code to invoke\. In C\#, the format is: +When creating Lambda functions, you have to provide a handler string that tells Lambda where to look for the code to invoke\. In C\#, the format is: *ASSEMBLY::TYPE::METHOD* where: -+ *ASSEMBLY* is the name of the \.NET assembly file for your application\. When using the \.NET Core CLI to build your application, if you haven't set the assembly name using the `AssemblyName` property in \.csproj, the *ASSEMBLY* name will be the \.csproj file name\. For more information, see [\.NET Core CLI](csharp-package-cli.md)\. In this case, let's assume the \.csproj file is `HelloWorldApp.csproj`\. ++ *ASSEMBLY* is the name of the \.NET assembly file for your application\. When using the \.NET Core CLI to build your application, if you haven't set the assembly name using the `AssemblyName` property in the \.csproj file, the *ASSEMBLY* name is the \.csproj file name\. For more information, see [\.NET Core CLI](csharp-package-cli.md)\. In this case, let's assume that the \.csproj file is `HelloWorldApp.csproj`\. + *TYPE* is the full name of the handler type, which consists of the *Namespace* and the *ClassName*\. In this case `Example.Hello`\. + *METHOD* is name of the function handler, in this case `MyHandler`\. -Ultimately, the signature will be of this format: *Assembly::Namespace\.ClassName::MethodName* +Ultimately, the signature is of this format: *Assembly::Namespace\.ClassName::MethodName* -Again, consider the following example: +Consider the following example: ``` using System.IO; @@ -85,25 +181,44 @@ namespace Example The handler string would be: `HelloWorldApp::Example.Hello::MyHandler` **Important** -If the method specified in your handler string is overloaded, you must provide the exact signature of the method Lambda should invoke\. AWS Lambda will reject an otherwise valid signature if the resolution would require selecting among multiple \(overloaded\) signatures\. +If the method specified in your handler string is overloaded, you must provide the exact signature of the method that Lambda should invoke\. If the resolution would require selecting among multiple \(overloaded\) signatures, Lambda will reject an otherwise valid signature\. + +## Using top\-level statements + +Starting with \.NET 6, you can write functions using *top\-level statements*\. Top\-level statements remove some of the boilerplate code required for \.NET projects, reducing the number of lines of code that you write\. For example, you can rewrite the previous example using top\-level statements: + +``` +using Amazon.Lambda.RuntimeSupport; + +var handler = (Stream stream) => +{ + //function logic +}; + +await LambdaBootstrapBuilder.Create(handler).Build().RunAsync(); +``` + + When using top\-level statements, you only include the `ASSEMBLY` name when providing the handler signature\. Continuing from the previous example, the handler string would be `HelloWorldApp`\. + + By setting the handler to the assembly name Lambda will treat the assembly as an executable and execute it at startup\. You must add the NuGet package `Amazon.Lambda.RuntimeSupport` to the project so that the executable that runs at startup starts the Lambda runtime client\. ## Serializing Lambda functions -For any Lambda functions that use input or output types other than a `Stream` object, you will need to add a serialization library to your application\. You can do this in the following ways: -+ Use the `Amazon.Lambda.Serialization.SystemTextJson` NuGet package\. This library uses native .net core JSON serializer to handle serialization\. This package provides a performance improvement over `Amazon.Lambda.Serialization.Json`, but please note that there are some limitation documented in the [Microsoft's documentation](https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-how-to?pivots=dotnet-core-3-1)\. It is only available for \.net core 3\.1 runtimes or higher\. -+ Use the `Amazon.Lambda.Serialization.Json` NuGet package\. This library uses `Newtonsoft.Json` NuGet package to handle serialization\. +For any Lambda functions that use input or output types other than a `Stream` object, you must add a serialization library to your application\. You can do this in the following ways: ++ Use the `Amazon.Lambda.Serialization.SystemTextJson` NuGet package\. This library uses the native \.NET Core JSON serializer to handle serialization\. This package provides a performance improvement over `Amazon.Lambda.Serialization.Json`, but note the limitations described in the [ Microsoft documentation](https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-how-to?pivots=dotnet-core-3-1)\. This library is available for \.NET Core 3\.1 and later runtimes\. ++ Use the `Amazon.Lambda.Serialization.Json` NuGet package\. This library uses JSON\.NET to handle serialization\. + Create your own serialization library by implementing the `ILambdaSerializer` interface, which is available as part of the `Amazon.Lambda.Core` library\. The interface defines two methods: + `T Deserialize(Stream requestStream);` You implement this method to deserialize the request payload from the `Invoke` API into the object that is passed to the Lambda function handler\. + `T Serialize(T response, Stream responseStream);`\. - You implement this method to serialize the result returned from the Lambda function handler into the response payload that is returned by the `Invoke` API\. - + You implement this method to serialize the result returned from the Lambda function handler into the response payload that the `Invoke` API operation returns\. -To use serializer you need to add a dependency to your `csproj` file\. +To use the serializer, you must add a dependency to your `MyProject.csproj` file\. ``` +... @@ -111,19 +226,19 @@ To use serializer you need to add a dependency to your `csproj` file\. ``` -Next you need to define the serializer. For example you can define it in the AssemblyInfo\.cs file\. If you are using `Amazon.Lambda.Serialization.SystemTextJson`, the serializercan be defined that way: +Next, you must define the serializer\. The following example defines the ` Amazon.Lambda.Serialization.SystemTextJson` serializer in the AssemblyInfo\.cs file\. ``` [assembly: LambdaSerializer(typeof(DefaultLambdaJsonSerializer))] ``` - -Using `Amazon.Lambda.Serialization.Json`, it will be: + +The following example defines the `Amazon.Lambda.Serialization.Json` serializer in the AssemblyInfo\.cs file\. ``` [assembly: LambdaSerializer(typeof(JsonSerializer))] ``` -You can also define a custom serialization attribute at the method level, which will override the default serializer specified at the assembly level\. +You can define a custom serialization attribute at the method level, which overrides the default serializer specified at the assembly level\. ``` public class ProductService{ @@ -145,14 +260,14 @@ public class ProductService{ ## Lambda function handler restrictions Note that there are some restrictions on the handler signature\. -+ It may not be `unsafe` and use pointer types in the handler signature, though `unsafe` context can be used inside the handler method and its dependencies\. For more information, see [unsafe \(C\# reference\)](https://msdn.microsoft.com/en-us/library/chfa2zb8.aspx)\. -+ It may not pass a variable number of parameters using the `params` keyword, or use `ArgIterator` as an input or return parameter which is used to support variable number of parameters\. -+ The handler may not be a generic method \(e\.g\. IList Sort\(IList input\)\)\. ++ It may not be `unsafe` and use pointer types in the handler signature, though you can use `unsafe` context inside the handler method and its dependencies\. For more information, see [unsafe \(C\# Reference\)](https://msdn.microsoft.com/en-us/library/chfa2zb8.aspx) on the Microsoft Docs website\. ++ It may not pass a variable number of parameters using the `params` keyword, or use `ArgIterator` as an input or a return parameter, which is used to support a variable number of parameters\. ++ The handler may not be a generic method, for example, IList Sort\(IList input\)\. + Async handlers with signature `async void` are not supported\. -## Using async in C\# functions with AWS Lambda +## Using async in C\# functions with Lambda -If you know your Lambda function will require a long\-running process, such as uploading large files to Amazon S3 or reading a large stream of records from DynamoDB, you can take advantage of the async/await pattern\. When you use this signature, Lambda invokes the function synchronously and waits for the function to return a response or for execution to time out\. +If you know that your Lambda function will require a long\-running process, such as uploading large files to Amazon S3 or reading a large stream of records from Amazon DynamoDB, you can take advantage of the async/await pattern\. When you use this signature, Lambda invokes the function synchronously and waits for the function to return a response or for execution to time out\. ``` public async Task ProcessS3ImageResizeAsync(SimpleS3Event input) @@ -162,8 +277,8 @@ public async Task ProcessS3ImageResizeAsync(SimpleS3Event input) } ``` -If you use this pattern, there are some considerations you must take into account: -+ AWS Lambda does not support `async void` methods\. +If you use this pattern, consider the following: ++ Lambda does not support `async void` methods\. + If you create an async Lambda function without implementing the `await` operator, \.NET will issue a compiler warning and you will observe unexpected behavior\. For example, some async actions will run while others won't\. Or some async actions won't complete before the function invocation completes\. ``` @@ -172,7 +287,7 @@ If you use this pattern, there are some considerations you must take into accoun client.DoAsyncWork(input); } ``` -+ Your Lambda function can include multiple async calls, which can be invoked in parallel\. You can use the `Task.WhenAll` and `Task.WhenAny` methods to work with multiple tasks\. To use the `Task.WhenAll` method, you pass a list of the operations as an array to the method\. Note that in the example below, if you neglect to include any operation to the array, that call may return before its operation completes\. ++ Your Lambda function can include multiple async calls, which can be invoked in parallel\. You can use the `Task.WhenAll` and `Task.WhenAny` methods to work with multiple tasks\. To use the `Task.WhenAll` method, you pass a list of the operations as an array to the method\. Note that in the following example, if you neglect to include any operation to the array, that call may return before its operation completes\. ``` public async Task DoesNotWaitForAllTasks1() @@ -197,7 +312,7 @@ If you use this pattern, there are some considerations you must take into accoun var task2 = Task.Run(() => Console.WriteLine("Test2")); var task3 = Task.Run(() => Console.WriteLine("Test3")); - // Lambda may return before printing all tests since we're only waiting for one to finish. + // Lambda may return before printing all tests since we're waiting for only one to finish. await Task.WhenAny(task1, task2, task3); } - ``` + ``` \ No newline at end of file diff --git a/doc_source/csharp-image.md b/doc_source/csharp-image.md old mode 100644 new mode 100755 index 9ca53129..14631ea0 --- a/doc_source/csharp-image.md +++ b/doc_source/csharp-image.md @@ -7,7 +7,7 @@ AWS provides the following resources to help you build a container image for you These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. @@ -36,6 +36,7 @@ AWS provides the following base images for \.NET: | Tags | Runtime | Operating system | Dockerfile | | --- | --- | --- | --- | +| 6 | \.NET 6\.0 | Amazon Linux 2 | [Dockerfile for \.NET 6\.0 on GitHub](https://github.com/aws/aws-lambda-dotnet/tree/master/LambdaRuntimeDockerfiles/Images/net6) | | 5\.0 | \.NET 5\.0 | Amazon Linux 2 | [Dockerfile for \.NET 5\.0 on GitHub](https://github.com/aws/aws-lambda-base-images/blob/dotnet5.0/Dockerfile.dotnet5.0) | | core3\.1 | \.NET Core 3\.1 | Amazon Linux 2 | [Dockerfile for \.NET 3\.1 on GitHub](https://github.com/aws/aws-lambda-base-images/blob/dotnetcore3.1/Dockerfile.dotnetcore3.1) | | core2\.1 | \.NET Core 2\.1 | Amazon Linux 2018\.03 | [Dockerfile for \.NET 2\.1 on GitHub](https://github.com/aws/aws-lambda-base-images/blob/dotnetcore2.1/Dockerfile.dotnetcore2.1) | diff --git a/doc_source/csharp-logging.md b/doc_source/csharp-logging.md old mode 100644 new mode 100755 index 02a49dc3..9acc742d --- a/doc_source/csharp-logging.md +++ b/doc_source/csharp-logging.md @@ -1,4 +1,4 @@ -# AWS Lambda function logging in C\# +# Lambda function logging in C\# AWS Lambda automatically monitors Lambda functions on your behalf and sends function metrics to Amazon CloudWatch\. Your Lambda function comes with a CloudWatch Logs log group and a log stream for each instance of your function\. The Lambda runtime environment sends details about each invocation to the log stream, and relays logs and other output from your function's code\. @@ -6,6 +6,7 @@ This page describes how to produce log output from your Lambda function's code, **Topics** + [Creating a function that returns logs](#csharp-logging-output) ++ [Using log levels](#log-levels) + [Using the Lambda console](#csharp-logging-console) + [Using the CloudWatch console](#csharp-logging-cwconsole) + [Using the AWS Command Line Interface \(AWS CLI\)](#csharp-logging-cli) @@ -13,7 +14,7 @@ This page describes how to produce log output from your Lambda function's code, ## Creating a function that returns logs - To output logs from your function code, you can use methods on [the Console class](https://docs.microsoft.com/en-us/dotnet/api/system.console), or any logging library that writes to `stdout` or `stderr`\. The following example uses the `LambdaLogger` class from the [Amazon\.Lambda\.Core](lambda-csharp.md) library\. +To output logs from your function code, you can use methods on the [Console class](https://docs.microsoft.com/en-us/dotnet/api/system.console), or any logging library that writes to `stdout` or `stderr`\. The following example uses the `LambdaLogger` class from the [Amazon\.Lambda\.Core](lambda-csharp.md) library\. **Example [src/blank\-csharp/Function\.cs](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/blank-csharp/src/blank-csharp/Function.cs) – Logging** @@ -37,7 +38,7 @@ public async Task FunctionHandler(SQSEvent invocationEvent, ILambd } ``` -**Example Log format** +**Example log format** ``` START RequestId: d1cf0ccb-xmpl-46e6-950d-04c96c9b1c5d Version: $LATEST @@ -87,6 +88,24 @@ The \.NET runtime logs the `START`, `END`, and `REPORT` lines for each invocatio + **SegmentId** – For traced requests, the X\-Ray segment ID\. + **Sampled** – For traced requests, the sampling result\. +## Using log levels + +Starting with \.NET 6, you can use log levels for additional logging from Lambda functions\. Log levels provide filtering and categorization for the logs that your function writes to Amazon EventBridge \(CloudWatch Events\)\. + +The log levels available are: ++ `LogCritical` ++ `LogError` ++ `LogWarning` ++ `LogInformation` ++ `LogDebug` ++ `LogTrace` + + By default, Lambda writes `LogInformation` level logs and above to CloudWatch\. You can adjust the level of logs that Lambda writes using the `AWS_LAMBDA_HANDLER_LOG_LEVEL` environment variable\. Set the value of the environment variable to the string enum value for the level desired, as outlined in the [LogLevel enum](https://github.com/aws/aws-lambda-dotnet/blob/master/Libraries/src/Amazon.Lambda.Core/ILambdaLogger.cs#L7)\. For example, if you set `AWS_LAMBDA_HANDLER_LOG_LEVEL` to `Error`, Lambda writes `LogError` and `LogCritical` messages to CloudWatch\. + + Lambda writes `Console.WriteLine` calls as info level messages, and `Console.Error.WriteLine` calls as error level messages\. + + If you prefer the previous style of logging in \.NET, set `AWS_LAMBDA_HANDLER_LOG_FORMAT` to `Unformatted`\. + ## Using the Lambda console You can use the Lambda console to view log output after you invoke a Lambda function\. For more information, see [Accessing Amazon CloudWatch logs for AWS Lambda](monitoring-cloudwatchlogs.md)\. @@ -151,7 +170,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/csharp-package-cli.md b/doc_source/csharp-package-cli.md old mode 100644 new mode 100755 index 4e984227..9f0c3583 --- a/doc_source/csharp-package-cli.md +++ b/doc_source/csharp-package-cli.md @@ -2,7 +2,7 @@ The \.NET Core CLI offers a cross\-platform way for you to create \.NET\-based Lambda applications\. This section assumes that you have installed the \.NET Core CLI\. If you haven't, see [Download \.NET](https://dotnet.microsoft.com/download) on the Microsoft website\. -In the \.NET CLI, you use the `new` command to create \.NET projects from a command line\. This is useful if you want to create a project outside of Visual Studio\. To view a list of the available project types, open a command line and navigate to where you installed the \.NET Core runtime and run the following command: +In the \.NET CLI, you use the `new` command to create \.NET projects from a command line\. This is useful if you want to create a project outside of Visual Studio\. To view a list of the available project types, open a command line, navigate to where you installed the \.NET Core runtime, and then run the following command: ``` dotnet new -all @@ -21,7 +21,7 @@ Examples: dotnet new --help ``` -Lambda offers additional templates via the [Amazon\.Lambda\.Templates](https://www.nuget.org/packages/Amazon.Lambda.Templates) nuget package\. To install this package, run the following command: +Lambda offers additional templates via the [Amazon\.Lambda\.Templates](https://www.nuget.org/packages/Amazon.Lambda.Templates) NuGet package\. To install this package, run the following command: ``` dotnet new -i Amazon.Lambda.Templates @@ -53,8 +53,7 @@ Under the `src/myfunction` directory, examine the following files: "profile" : "default", "region" : "us-east-2", "configuration" : "Release", - "framework" : "netcoreapp2.1", - "function-runtime":"dotnetcore3.1", + "function-runtime":"dotnet6", "function-memory-size" : 256, "function-timeout" : 30, "function-handler" : "MyFunction::MyFunction.Function::FunctionHandler" @@ -70,16 +69,16 @@ Under the `src/myfunction` directory, examine the following files: using Amazon.Lambda.Core; // Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class. - [assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.Json.JsonSerializer))] + [assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))] namespace MyFunction { public class Function { - public string FunctionHandler1(string input, ILambdaContext context) + public string FunctionHandler(string input, ILambdaContext context) { - return input?.ToUpper(); + return input.ToUpper(); } } } @@ -90,12 +89,20 @@ Under the `src/myfunction` directory, examine the following files: - netcoreapp2.1 + net6.0 + enable + enable + true + Lambda + + true + + true - - + + @@ -103,13 +110,13 @@ Under the `src/myfunction` directory, examine the following files: + **Readme**: Use this file to document your Lambda function\. Under the `myfunction/test` directory, examine the following files: -+ **myFunction\.Tests\.csproj**: As noted previously, this is an [MSBuild](https://msdn.microsoft.com/en-us/library/dd393574.aspx) file that lists the files and assemblies that comprise your test project\. Note also that it includes the `Amazon.Lambda.Core` library, allowing you to seamlessly integrate any Lambda templates required to test your function\. ++ **myFunction\.Tests\.csproj**: As noted previously, this is an [MSBuild](https://msdn.microsoft.com/en-us/library/dd393574.aspx) file that lists the files and assemblies that comprise your test project\. Note also that it includes the `Amazon.Lambda.Core` library, so you can seamlessly integrate any Lambda templates required to test your function\. ``` ... - + ... ``` + **FunctionTest\.cs**: The same C\# code template file that it is included in the `src` directory\. Edit this file to mirror your function's production code and test it before uploading your Lambda function to a production environment\. @@ -167,16 +174,14 @@ dotnet lambda deploy-function MyFunction --function-role role After deployment, you can re\-test it in a production environment using the following command, and pass in a different value to your Lambda function handler: -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. - ``` -dotnet lambda invoke-function MyFunction --cli-binary-format raw-in-base64-out --payload "Just Checking If Everything is OK" +dotnet lambda invoke-function MyFunction --payload "Just Checking If Everything is OK" ``` If everything is successful, you see the following: ``` -dotnet lambda invoke-function MyFunction --cli-binary-format raw-in-base64-out --payload "Just Checking If Everything is OK" +dotnet lambda invoke-function MyFunction --payload "Just Checking If Everything is OK" Payload: "JUST CHECKING IF EVERYTHING IS OK" diff --git a/doc_source/csharp-package-toolkit.md b/doc_source/csharp-package-toolkit.md old mode 100644 new mode 100755 index 316b45f8..88473f87 --- a/doc_source/csharp-package-toolkit.md +++ b/doc_source/csharp-package-toolkit.md @@ -1,6 +1,6 @@ # AWS Toolkit for Visual Studio -You can build \.NET\-based Lambda applications using the Lambda plugin to the [AWS Toolkit for Visual Studio](http://aws.amazon.com/visualstudio/)\. The toolkit is available as a [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.AWSToolkitforVisualStudio2017)\. +You can build \.NET\-based Lambda applications using the Lambda plugin for the [AWS Toolkit for Visual Studio](http://aws.amazon.com/visualstudio/)\. The toolkit is available as a [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.AWSToolkitforVisualStudio2017)\. 1. Launch Microsoft Visual Studio and choose **New project**\. @@ -8,21 +8,20 @@ You can build \.NET\-based Lambda applications using the Lambda plugin to the [A 1. In the **New Project** window, choose **Lambda Project \(\.NET Core\)**, and then choose **OK**\. - 1. In the **Select Blueprint** window, you can select from a list of sample applications that provide you with sample code to get started with creating a \.NET\-based Lambda application\. + 1. In the **Select Blueprint** window, select from the list of sample applications with sample code to help you get started with creating a \.NET\-based Lambda application\. 1. To create a Lambda application from scratch, choose **Empty Function**, and then choose **Finish**\. 1. Review the `aws-lambda-tools-defaults.json` file, which is created as part of your project\. You can set the options in this file, which the Lambda tooling reads by default\. The project templates created in Visual Studio set many of these fields with default values\. Note the following fields: + **profile** – The name of a profile in your [AWS SDK for \.NET credentials file](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-config-creds.html) - + **function\-handler** – This is where the `function handler` is specified, which is why you don't have to set it in the wizard\. However, whenever you rename the *Assembly*, *Namespace*, *Class*, or *Function* in your function code, you must update the corresponding fields in the `aws-lambda-tools-defaults.json` file\. + + **function\-handler** – The field where you specify the `function handler`\. \(This is why you don't have to set it in the wizard\.\) However, whenever you rename the *Assembly*, *Namespace*, *Class*, or *Function* in your function code, you must update the corresponding fields in the `aws-lambda-tools-defaults.json` file\. ``` { "profile":"default", "region" : "us-east-2", "configuration" : "Release", - "framework" : "netcoreapp2.1", - "function-runtime":"dotnetcore3.1", + "function-runtime":"dotnet6", "function-memory-size" : 256, "function-timeout" : 30, "function-handler" : "Assembly::Namespace.Class::Function" @@ -31,7 +30,7 @@ You can build \.NET\-based Lambda applications using the Lambda plugin to the [A 1. Open the **Function\.cs** file\. You are provided with a template to implement your Lambda function handler code\. -1. Once you have written the code that represents your Lambda function, upload it by opening the context \(right\-click\) menu for the **Project** node in your application and then choosing **Publish to AWS Lambda**\. +1. After writing the code that represents your Lambda function, upload it by opening the context \(right\-click\) menu for the **Project** node in your application and then choosing **Publish to AWS Lambda**\. 1. In the **Upload Lambda Function** window, enter a name for the function, or select a previously published function to republish\. Then choose **Next**\. diff --git a/doc_source/csharp-package.md b/doc_source/csharp-package.md old mode 100644 new mode 100755 diff --git a/doc_source/csharp-tracing.md b/doc_source/csharp-tracing.md old mode 100644 new mode 100755 index 21a62e9f..f468b4d5 --- a/doc_source/csharp-tracing.md +++ b/doc_source/csharp-tracing.md @@ -10,7 +10,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/deploying-lambda-apps.md b/doc_source/deploying-lambda-apps.md old mode 100644 new mode 100755 diff --git a/doc_source/foundation-arch.md b/doc_source/foundation-arch.md old mode 100644 new mode 100755 index 5e278770..579df015 --- a/doc_source/foundation-arch.md +++ b/doc_source/foundation-arch.md @@ -81,4 +81,4 @@ Lambda provides the following runtimes for the arm64 architecture\. These runtim **Note** Runtimes that use the Amazon Linux operating system, such as Go 1\.x, do not support the arm64 architecture\. To use arm64 architecture, you can run Go with the provided\.al2 runtime\. For example, see [Build a Go function for the provided\.al2 runtime](golang-package.md#golang-package-al2) or [Create a Go image from the provided\.al2 base image](go-image.md#go-image-al2)\. -For an example of how to create a function with arm64 architecture, see [ AWS Lambda Functions Powered by AWS Graviton2 Processor](http://aws.amazon.com/blogs/aws/aws-lambda-functions-powered-by-aws-graviton2-processor-run-your-functions-on-arm-and-get-up-to-34-better-price-performance/)\. \ No newline at end of file +For an example of how to create a function with arm64 architecture, see [AWS Lambda Functions Powered by AWS Graviton2 Processor](http://aws.amazon.com/blogs/aws/aws-lambda-functions-powered-by-aws-graviton2-processor-run-your-functions-on-arm-and-get-up-to-34-better-price-performance/)\. \ No newline at end of file diff --git a/doc_source/foundation-console.md b/doc_source/foundation-console.md old mode 100644 new mode 100755 diff --git a/doc_source/foundation-networking.md b/doc_source/foundation-networking.md old mode 100644 new mode 100755 diff --git a/doc_source/foundation-progmodel.md b/doc_source/foundation-progmodel.md old mode 100644 new mode 100755 diff --git a/doc_source/functions-states.md b/doc_source/functions-states.md old mode 100644 new mode 100755 index aad0bb8c..b4747281 --- a/doc_source/functions-states.md +++ b/doc_source/functions-states.md @@ -6,7 +6,7 @@ Lambda includes a state field in the function configuration for all functions to + `Failed` – Indicates that resource configuration or provisioning encountered an error\. + `Inactive` – A function becomes inactive when it has been idle long enough for Lambda to reclaim the external resources that were configured for it\. When you try to invoke a function that is inactive, the invocation fails and Lambda sets the function to pending state until the function resources are recreated\. If Lambda fails to recreate the resources, the function is set to the inactive state\. -If you are utilizing SDK\-based automation workflows or calling Lambda’s service APIs directly, ensure that you check a function's state before invocation to verify that it is active\. You can do this with the Lambda API action [GetFunction](API_GetFunction.md), or by configuring a waiter using the [AWS SDK for Java 2\.0](https://github.com/aws/aws-sdk-java-v2)\. +If you are using SDK\-based automation workflows or calling Lambda’s service APIs directly, ensure that you check a function's state before invocation to verify that it is active\. You can do this with the Lambda API action [GetFunction](API_GetFunction.md), or by configuring a waiter using the [AWS SDK for Java 2\.0](https://github.com/aws/aws-sdk-java-v2)\. ``` aws lambda get-function --function-name my-function --query 'Configuration.[State, LastUpdateStatus]' @@ -66,4 +66,4 @@ The following is the result of `get-function-configuration` on a function underg The following operations fail while an asynchronous update is in progress: + [UpdateFunctionCode](API_UpdateFunctionCode.md) + [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md) -+ [PublishVersion](API_PublishVersion.md) ++ [PublishVersion](API_PublishVersion.md) \ No newline at end of file diff --git a/doc_source/getting-started-create-function.md b/doc_source/getting-started-create-function.md old mode 100644 new mode 100755 index 90bea1d8..f24cab66 --- a/doc_source/getting-started-create-function.md +++ b/doc_source/getting-started-create-function.md @@ -1,6 +1,6 @@ # Create a Lambda function with the console -In this getting started exercise, you create a Lambda function using the console\.The function uses the default code that Lambda creates\. The Lambda console provides a [code editor](foundation-console.md#code-editor) for non\-compiled languages that lets you modify and test code quickly\. +In this getting started exercise, you create a Lambda function using the console\. The function uses the default code that Lambda creates\. The Lambda console provides a [code editor](foundation-console.md#code-editor) for non\-compiled languages that lets you modify and test code quickly\. For compiled languages, you must create a [\.zip archive deployment package](gettingstarted-package.md#gettingstarted-package-zip) to upload your Lambda function code\. **Topics** + [Create the function](#gettingstarted-zip-function) @@ -13,7 +13,7 @@ You create a Node\.js Lambda function using the Lambda console\. Lambda automati **To create a Lambda function with the console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -59,7 +59,7 @@ Invoke your Lambda function using the sample event data provided in the console\ 1. Choose the **Monitor** tab\. This page shows graphs for the metrics that Lambda sends to CloudWatch\. ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/lambda/latest/dg/images/metrics-functions-list.png) - For more information on these graphs, see [Monitoring functions in the AWS Lambda console](monitoring-functions-access-metrics.md)\. + For more information on these graphs, see [Monitoring functions on the Lambda console](monitoring-functions-access-metrics.md)\. ## Clean up @@ -67,7 +67,7 @@ If you are done working with the example function, delete it\. You can also dele **To delete a Lambda function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/getting-started.md b/doc_source/getting-started.md old mode 100644 new mode 100755 diff --git a/doc_source/gettingstarted-awscli.md b/doc_source/gettingstarted-awscli.md old mode 100644 new mode 100755 diff --git a/doc_source/gettingstarted-concepts.md b/doc_source/gettingstarted-concepts.md old mode 100644 new mode 100755 index f910270b..2389af5e --- a/doc_source/gettingstarted-concepts.md +++ b/doc_source/gettingstarted-concepts.md @@ -24,7 +24,7 @@ For more information, see [Configuring AWS Lambda functions](lambda-functions.md ## Trigger -A *trigger* is a resource or configuration that invokes a Lambda function\. Triggers include AWS services that you can configure to invoke a function and [event source mappings](invocation-eventsourcemapping.md)\. An event source mapping is a resource in Lambda that reads items from a stream or queue and invokes a function\. For more information, see [Invoking AWS Lambda functions](lambda-invocation.md) and [Using AWS Lambda with other services](lambda-services.md)\. +A *trigger* is a resource or configuration that invokes a Lambda function\. Triggers include AWS services that you can configure to invoke a function and [event source mappings](invocation-eventsourcemapping.md)\. An event source mapping is a resource in Lambda that reads items from a stream or queue and invokes a function\. For more information, see [Invoking Lambda functions](lambda-invocation.md) and [Using AWS Lambda with other services](lambda-services.md)\. ## Event diff --git a/doc_source/gettingstarted-features.md b/doc_source/gettingstarted-features.md old mode 100644 new mode 100755 index 47b34567..302d59af --- a/doc_source/gettingstarted-features.md +++ b/doc_source/gettingstarted-features.md @@ -14,7 +14,7 @@ Lambda provides a management console and API for managing and invoking functions ## Scaling -Lambda manages the infrastructure that runs your code, and scales automatically in response to incoming requests\. When your function is invoked more quickly than a single instance of your function can process events, Lambda scales up by running additional instances\. When traffic subsides, inactive instances are frozen or stopped\. You only pay for the time that your function is initializing or processing events\. +Lambda manages the infrastructure that runs your code, and scales automatically in response to incoming requests\. When your function is invoked more quickly than a single instance of your function can process events, Lambda scales up by running additional instances\. When traffic subsides, inactive instances are frozen or stopped\. You pay only for the time that your function is initializing or processing events\. ![\[\]](http://docs.aws.amazon.com/lambda/latest/dg/images/features-scaling.png) @@ -50,7 +50,7 @@ To process items from a stream or queue, you can create an *event source mapping Event source mappings maintain a local queue of unprocessed items and handle retries if the function returns an error or is throttled\. You can configure an event source mapping to customize batching behavior and error handling, or to send a record of items that fail processing to a destination\. -For more information, see [AWS Lambda event source mappings](invocation-eventsourcemapping.md)\. +For more information, see [Lambda event source mappings](invocation-eventsourcemapping.md)\. ## Destinations diff --git a/doc_source/gettingstarted-images.md b/doc_source/gettingstarted-images.md old mode 100644 new mode 100755 index d185ab0a..100149e1 --- a/doc_source/gettingstarted-images.md +++ b/doc_source/gettingstarted-images.md @@ -33,7 +33,7 @@ This exercise uses Docker CLI commands to create the container image\. To instal ## Create the container image -AWS provides a set of base images in the Amazon Elastic Container Registry \(Amazon ECR\)\. In this getting started exercise, we use the Node\.js base image to create a container image\. For more information about base images, see [ AWS base images for Lambda](runtimes-images.md#runtimes-images-lp)\. +AWS provides a set of base images in the Amazon Elastic Container Registry \(Amazon ECR\)\. In this getting started exercise, we use the Node\.js base image to create a container image\. For more information about base images, see [AWS base images for Lambda](runtimes-images.md#runtimes-images-lp)\. In the following commands, replace `123456789012` with your AWS account ID\. @@ -88,7 +88,7 @@ In the following commands, replace `123456789012` with your AWS account ID\. ## Upload the image to the Amazon ECR repository -In the following commands, replace `123456789012` with your AWS account ID\. +In the following commands, replace `123456789012` with your AWS account ID and set the region value to the region where you want to create the ECR repository\. 1. Authenticate the Docker CLI to your Amazon ECR registry\. @@ -99,7 +99,7 @@ In the following commands, replace `123456789012` with your AWS account ID\. 1. Create a repository in Amazon ECR using the `create-repository` command\. ``` - aws ecr create-repository --repository-name hello-world --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE + aws ecr create-repository --region us-east-1 --repository-name hello-world --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE ``` 1. Tag your image to match your repository name using the `docker tag` command\. @@ -140,7 +140,7 @@ Use the Lambda console to create a function defined as a container image\. **To create the function with the console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -188,7 +188,7 @@ Invoke your Lambda function using the sample event data provided in the console\ 1. Choose the **Monitor** tab\. This page shows graphs for the metrics that Lambda sends to CloudWatch\. ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/lambda/latest/dg/images/metrics-functions-list.png) - For more information on these graphs, see [Monitoring functions in the AWS Lambda console](monitoring-functions-access-metrics.md)\. + For more information on these graphs, see [Monitoring functions on the Lambda console](monitoring-functions-access-metrics.md)\. ## Clean up @@ -198,7 +198,7 @@ If you are done working with your function, delete it\. You can also delete the **To delete a Lambda function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/gettingstarted-limits.md b/doc_source/gettingstarted-limits.md old mode 100644 new mode 100755 index 1cf0c322..ac8debc9 --- a/doc_source/gettingstarted-limits.md +++ b/doc_source/gettingstarted-limits.md @@ -5,7 +5,7 @@ Lambda sets quotas for the amount of compute and storage resources that you can use to run and store functions\. The following quotas apply per AWS Region and can be increased\. For more information, see [Requesting a quota increase](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) in the *Service Quotas User Guide*\. **Note** -New AWS accounts might start out with limits that are lower than these defaults\. Lambda monitors usage and raises your limits automatically based on your usage\. +A few new AWS accounts might start out with limits that are lower than these defaults\. AWS monitors usage and raises your limits automatically based on your usage\. | Resource | Default quota | Can be increased up to | @@ -28,7 +28,7 @@ The Lambda documentation, log messages, and console use the abbreviation MB \(ra | Resource | Quota | | --- | --- | | Function [memory allocation](configuration-function-common.md) | 128 MB to 10,240 MB, in 1\-MB increments\. | -| Function [ timeout](https://docs.aws.amazon.com/whitepapers/latest/serverless-architectures-lambda/timeout.html) | 900 seconds \(15 minutes\) | +| Function timeout | 900 seconds \(15 minutes\) | | Function [environment variables](configuration-envvars.md) | 4 KB, for all environment variables associated with the function, in aggregate | | Function [resource\-based policy](access-control-resource-based.md) | 20 KB | | Function [layers](configuration-layers.md) | five layers | diff --git a/doc_source/gettingstarted-package.md b/doc_source/gettingstarted-package.md old mode 100644 new mode 100755 diff --git a/doc_source/glossary.md b/doc_source/glossary.md old mode 100644 new mode 100755 diff --git a/doc_source/go-image.md b/doc_source/go-image.md old mode 100644 new mode 100755 index 28da6942..5e2efbb7 --- a/doc_source/go-image.md +++ b/doc_source/go-image.md @@ -5,7 +5,7 @@ You can deploy your Lambda function code as a [container image](images-create.md These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. diff --git a/doc_source/golang-context.md b/doc_source/golang-context.md old mode 100644 new mode 100755 diff --git a/doc_source/golang-envvars.md b/doc_source/golang-envvars.md old mode 100644 new mode 100755 diff --git a/doc_source/golang-exceptions.md b/doc_source/golang-exceptions.md old mode 100644 new mode 100755 index b3d6032e..1c8300a9 --- a/doc_source/golang-exceptions.md +++ b/doc_source/golang-exceptions.md @@ -69,7 +69,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -102,7 +102,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/golang-handler.md b/doc_source/golang-handler.md old mode 100644 new mode 100755 diff --git a/doc_source/golang-logging.md b/doc_source/golang-logging.md old mode 100644 new mode 100755 index a6dac31c..ba85177c --- a/doc_source/golang-logging.md +++ b/doc_source/golang-logging.md @@ -136,7 +136,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/golang-package.md b/doc_source/golang-package.md old mode 100644 new mode 100755 diff --git a/doc_source/golang-tracing.md b/doc_source/golang-tracing.md old mode 100644 new mode 100755 index c7564059..1c22aaf7 --- a/doc_source/golang-tracing.md +++ b/doc_source/golang-tracing.md @@ -10,7 +10,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/images-create.md b/doc_source/images-create.md old mode 100644 new mode 100755 diff --git a/doc_source/images-test.md b/doc_source/images-test.md old mode 100644 new mode 100755 diff --git a/doc_source/index.md b/doc_source/index.md old mode 100644 new mode 100755 index 8c8ead85..3c817e0b --- a/doc_source/index.md +++ b/doc_source/index.md @@ -53,10 +53,11 @@ Amazon's trademarks and trade dress may not be used in + [Configuring code signing for AWS Lambda](configuration-codesigning.md) + [Using tags on AWS Lambda functions](configuration-tags.md) + [Using layers with your Lambda function](invocation-layers.md) -+ [Invoking AWS Lambda functions](lambda-invocation.md) ++ [Invoking Lambda functions](lambda-invocation.md) + [Synchronous invocation](invocation-sync.md) + [Asynchronous invocation](invocation-async.md) - + [AWS Lambda event source mappings](invocation-eventsourcemapping.md) + + [Lambda event source mappings](invocation-eventsourcemapping.md) + + [Lambda event filtering](invocation-eventfiltering.md) + [Lambda function states](functions-states.md) + [Error handling and automatic retries in AWS Lambda](invocation-retries.md) + [Using Lambda extensions](using-extensions.md) @@ -119,13 +120,13 @@ Amazon's trademarks and trade dress may not be used in + [Instrumenting Go code in AWS Lambda](golang-tracing.md) + [Using environment variables](golang-envvars.md) + [Building Lambda functions with C#](lambda-csharp.md) - + [AWS Lambda function handler in C#](csharp-handler.md) + + [Lambda function handler in C#](csharp-handler.md) + [Deploy C# Lambda functions with .zip file archives](csharp-package.md) + [.NET Core CLI](csharp-package-cli.md) + [AWS Toolkit for Visual Studio](csharp-package-toolkit.md) + [Deploy .NET Lambda functions with container images](csharp-image.md) + [AWS Lambda context object in C#](csharp-context.md) - + [AWS Lambda function logging in C#](csharp-logging.md) + + [Lambda function logging in C#](csharp-logging.md) + [AWS Lambda function errors in C#](csharp-exceptions.md) + [Instrumenting C# code in AWS Lambda](csharp-tracing.md) + [Building Lambda functions with PowerShell](lambda-powershell.md) @@ -144,12 +145,11 @@ Amazon's trademarks and trade dress may not be used in + [Create a simple microservice using Lambda and API Gateway](services-apigateway-blueprint.md) + [AWS SAM template for an API Gateway application](services-apigateway-template.md) + [Using AWS Lambda with AWS CloudTrail](with-cloudtrail.md) - + [Logging AWS Lambda API calls with AWS CloudTrail](logging-using-cloudtrail.md) + + [Logging Lambda API calls with CloudTrail](logging-using-cloudtrail.md) + [Tutorial: Triggering a Lambda function with AWS CloudTrail events](with-cloudtrail-example.md) + [Sample function code](with-cloudtrail-create-package.md) + [Using AWS Lambda with Amazon EventBridge (CloudWatch Events)](services-cloudwatchevents.md) + [Tutorial: Using AWS Lambda with scheduled events](services-cloudwatchevents-tutorial.md) - + [AWS SAM template for a EventBridge (CloudWatch Events) application](with-scheduledevents-example-use-app-spec.md) + [Schedule expressions using rate or cron](services-cloudwatchevents-expressions.md) + [Using Lambda with CloudWatch Logs](services-cloudwatchlogs.md) + [Using AWS Lambda with AWS CloudFormation](services-cloudformation.md) @@ -192,16 +192,16 @@ Amazon's trademarks and trade dress may not be used in + [Using AWS Lambda with Amazon SNS](with-sns.md) + [Tutorial: Using AWS Lambda with Amazon Simple Notification Service](with-sns-example.md) + [Sample function code](with-sns-create-package.md) - + [Using AWS Lambda with Amazon SQS](with-sqs.md) + + [Using Lambda with Amazon SQS](with-sqs.md) + [Tutorial: Using Lambda with Amazon SQS](with-sqs-example.md) + [Tutorial: Using a cross-account Amazon SQS queue as an event source](with-sqs-cross-account-example.md) + [Sample Amazon SQS function code](with-sqs-create-package.md) + [AWS SAM template for an Amazon SQS application](with-sqs-example-use-app-spec.md) + [Using AWS Lambda with AWS X-Ray](services-xray.md) + [Monitoring and troubleshooting Lambda applications](lambda-monitoring.md) - + [Monitoring functions in the AWS Lambda console](monitoring-functions-access-metrics.md) + + [Monitoring functions on the Lambda console](monitoring-functions-access-metrics.md) + [Using Lambda Insights in Amazon CloudWatch](monitoring-insights.md) - + [Working with AWS Lambda function metrics](monitoring-metrics.md) + + [Working with Lambda function metrics](monitoring-metrics.md) + [Accessing Amazon CloudWatch logs for AWS Lambda](monitoring-cloudwatchlogs.md) + [Using CodeGuru Profiler with your Lambda function](monitoring-code-profiler.md) + [Example workflows using other AWS services](monitoring-servicemap.md) @@ -315,6 +315,8 @@ Amazon's trademarks and trade dress may not be used in + [EnvironmentResponse](API_EnvironmentResponse.md) + [EventSourceMappingConfiguration](API_EventSourceMappingConfiguration.md) + [FileSystemConfig](API_FileSystemConfig.md) + + [Filter](API_Filter.md) + + [FilterCriteria](API_FilterCriteria.md) + [FunctionCode](API_FunctionCode.md) + [FunctionCodeLocation](API_FunctionCodeLocation.md) + [FunctionConfiguration](API_FunctionConfiguration.md) diff --git a/doc_source/invocation-async.md b/doc_source/invocation-async.md old mode 100644 new mode 100755 index abac18f4..6ded61d8 --- a/doc_source/invocation-async.md +++ b/doc_source/invocation-async.md @@ -25,7 +25,7 @@ aws lambda invoke \ --payload '{ "key": "value" }' response.json ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` { @@ -52,7 +52,7 @@ You can also configure Lambda to send an invocation record to another service\. The invocation record contains details about the request and response in JSON format\. You can configure separate destinations for events that are processed successfully, and events that fail all processing attempts\. Alternatively, you can configure an Amazon SQS queue or Amazon SNS topic as a [dead\-letter queue](#invocation-dlq) for discarded events\. For dead\-letter queues, Lambda only sends the content of the event, without details about the response\. **Note** -To prevent a function from triggering, you can set the function's reserved concurrency to zero\. When you set reserved concurrency to zero for an asynchronously\-invoked function, Lambda immediately sends all events to the configured [dead\-letter queue](#invocation-dlq) or the on\-failure [event destination](#invocation-async-destinations), without any retries\. To process events that were sent while reserved concurrency was set to zero, you need to consume the events from the dead\-letter queue or the on\-failure event destination\. +To prevent a function from triggering, you can set the function's reserved concurrency to zero\. When you set reserved concurrency to zero for an asynchronously\-invoked function, Lambda begins sending new events to the configured [dead\-letter queue](#invocation-dlq) or the on\-failure [event destination](#invocation-async-destinations), without any retries\. To process events that were sent while reserved concurrency was set to zero, you need to consume the events from the dead\-letter queue or the on\-failure event destination\. ## Configuring error handling for asynchronous invocation @@ -60,7 +60,7 @@ Use the Lambda console to configure error handling settings on a function, a ver **To configure error handling** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -94,7 +94,7 @@ Add destinations to your function in the Lambda console's function visualization **To configure a destination for asynchronous invocation records** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -208,7 +208,7 @@ As an alternative to an [on\-failure destination](#invocation-async-destinations To reprocess events in a dead\-letter queue, you can set it as an event source for your Lambda function\. Alternatively, you can manually retrieve the events\. You can choose an Amazon SQS queue or Amazon SNS topic for your dead\-letter queue\. If you don't have a queue or topic, create one\. Choose the target type that matches your use case\. -+ [Amazon SQS queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-create-queue.html) – A queue holds failed events until they're retrieved\. Choose an Amazon SQS queue if you expect a single entity, such as a Lambda function or CloudWatch alarm, to process the failed event\. For more information, see [Using AWS Lambda with Amazon SQS](with-sqs.md)\. ++ [Amazon SQS queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-create-queue.html) – A queue holds failed events until they're retrieved\. Choose an Amazon SQS queue if you expect a single entity, such as a Lambda function or CloudWatch alarm, to process the failed event\. For more information, see [Using Lambda with Amazon SQS](with-sqs.md)\. Create a queue in the [Amazon SQS console](https://console.aws.amazon.com/sqs)\. + [Amazon SNS topic](https://docs.aws.amazon.com/sns/latest/gsg/CreateTopic.html) – A topic relays failed events to one or more destinations\. Choose an Amazon SNS topic if you expect multiple entities to act on a failed event\. For example, you can configure a topic to send events to an email address, a Lambda function, and/or an HTTP endpoint\. For more information, see [Using AWS Lambda with Amazon SNS](with-sns.md)\. @@ -225,7 +225,7 @@ After creating the target and updating your function's execution role, add the d **To configure a dead\-letter queue** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -257,4 +257,4 @@ Lambda sends the event to the dead\-letter queue as\-is, with additional informa If Lambda can't send a message to the dead\-letter queue, it deletes the event and emits the [DeadLetterErrors](monitoring-metrics.md) metric\. This can happen because of lack of permissions, or if the total size of the message exceeds the limit for the target queue or topic\. For example, if an Amazon SNS notification with a body close to 256 KB triggers a function that results in an error, the additional event data added by Amazon SNS, combined with the attributes added by Lambda, can cause the message to exceed the maximum size allowed in the dead\-letter queue\. -If you're using Amazon SQS as an event source, configure a dead\-letter queue on the Amazon SQS queue itself and not on the Lambda function\. For more information, see [Using AWS Lambda with Amazon SQS](with-sqs.md)\. \ No newline at end of file +If you're using Amazon SQS as an event source, configure a dead\-letter queue on the Amazon SQS queue itself and not on the Lambda function\. For more information, see [Using Lambda with Amazon SQS](with-sqs.md)\. \ No newline at end of file diff --git a/doc_source/invocation-eventfiltering.md b/doc_source/invocation-eventfiltering.md new file mode 100755 index 00000000..cf9d458f --- /dev/null +++ b/doc_source/invocation-eventfiltering.md @@ -0,0 +1,312 @@ +# Lambda event filtering + +For Amazon Kinesis, Amazon DynamoDB, and Amazon Simple Queue Service \(Amazon SQS\) event sources, you can use event filtering to control which events Lambda sends to your function for processing\. For example, you can define filter criteria so that you process only the records from a Kinesis stream that have the status code `ERROR`\. + +You can define up to five different filters for a single event source\. If an event satisfies any one of these five filters, Lambda sends the event to your function\. Otherwise, Lambda discards the event\. An event either satisfies the filter criteria or it doesn't\. If you're using batching windows, Lambda applies your filter criteria to each new event to determine whether to add it to the current batch\. + +**Topics** ++ [Event filtering basics](#filtering-basics) ++ [Filter rule syntax](#filtering-syntax) ++ [Filtering examples](#filtering-examples) ++ [Attaching filter criteria to an event source mapping \(console\)](#filtering-console) ++ [Attaching filter criteria to an event source mapping \(AWS CLI\)](#filtering-cli) ++ [Properly filtering Amazon SQS messages](#filtering-sqs) ++ [Properly filtering Kinesis and DynamoDB messages](#filtering-streams) + +## Event filtering basics + +A filter criteria \(`FilterCriteria`\) object is a structure that consists of a list of filters \(`Filters`\)\. Each filter \(`Filter`\) is a structure that defines an event filtering pattern \(`Pattern`\)\. A `Pattern` is a string representation of a JSON filter rule\. A `FilterCriteria` object looks like the following example: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"Metadata1\": [ rule1 ], \"data\": { \"Data1\": [ rule2 ] }}" + } + ] +} +``` + +For added clarity, here is the value of the filter's `Pattern` expanded in plain JSON: + +``` +{ + "Metadata1": [ pattern1 ], + "data": { + "Data1": [ pattern2 ] + } +} +``` + +There are three main parts to a `FilterCriteria` object: metadata properties, data properties, and filter patterns\. For example, suppose you receive a Kinesis event from your event source that looks like the following: + +``` +"kinesis": { + "partitionKey": "1", + "sequenceNumber": "49590338271490256608559692538361571095921575989136588898", + "data": { + "City": "Seattle", + "State": "WA", + "Temperature": "46", + "Month": "December" + }, + "approximateArrivalTimestamp": 1545084650.987 +} +``` ++ **Metadata properties** are the fields of the event object\. In the example `FilterCriteria`, `Metadata1` refers to a metadata property\. In the Kinesis event example, `Metadata1` could refer to a field such as `partitionKey`\. ++ **Data properties** are the fields of the event body\. In the example `FilterCriteria`, `Data1` refers to a data property\. In the Kinesis event example, `Data1` could refer to fields such as `City` and `Temperature`\. +**Note** +To filter on data properties, make sure to contain them in `FilterCriteria` within the proper key\. This key depends on the event source\. For Kinesis event sources, the data key is `data`\. For Amazon SQS event sources, the data key is `body`\. For DynamoDB event sources, the data key is `dynamodb`\. ++ **Filter rules** define the filter that you want to apply to a specific property\. In the example `FilterCriteria`, `rule1` applies to `Metadata1`, and `rule2` applies to `Data1`\. The syntax of your filter rule depends on the comparison operator that you use\. For more information, see [Filter rule syntaxFiltering examples](#filtering-syntax)\. + +When you create a `FilterCriteria` object, specify only the metadata properties and data properties that you want the filter to match on\. For Lambda to consider the event a match, the event must contain all the field names included in a filter\. Lambda ignores the fields that aren't included in a filter\. + +## Filter rule syntax + +For filter rules, Lambda supports the same set of syntax and rules as Amazon EventBridge\. For more information, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) in the *Amazon EventBridge User Guide*\. + +The following is a summary of all the comparison operators available for Lambda event filtering\. + + +| Comparison operator | Example | Rule syntax | +| --- | --- | --- | +| Null | UserID is null | "UserID": \[ null \] | +| Empty | LastName is empty | "LastName": \[""\] | +| Equals | Name is "Alice" | "Name": \[ "Alice" \] | +| And | Location is "New York" and Day is "Monday" | "Location": \[ "New York" \], "Day": \["Monday"\] | +| Or | PaymentType is "Credit" or "Debit" | "PaymentType": \[ "Credit", "Debit"\] | +| Not | Weather is anything but "Raining" | "Weather": \[ \{ "anything\-but": \[ "Raining" \] \} \] | +| Numeric \(equals\) | Price is 100 | "Price": \[ \{ "numeric": \[ "=", 100 \] \} \] | +| Numeric \(range\) | Price is more than 10, and less than or equal to 20 | "Price": \[ \{ "numeric": \[ ">", 10, "<=", 20 \] \} \] | +| Exists | ProductName exists | "ProductName": \[ \{ "exists": true \} \] | +| Does not exist | ProductName does not exist | "ProductName": \[ \{ "exists": false \} \] | +| Begins with | Region is in the US | "Region": \[ \{"prefix": "us\-" \} \] | + +**Note** +Like EventBridge, for strings, Lambda uses exact character\-by\-character matching without case\-folding or any other string normalization\. For numbers, Lambda also uses string representation\. For example, 300, 300\.0, and 3\.0e2 are not considered equal\. + +## Filtering examples + +Suppose you have a Kinesis event source, and you want your function to handle only events with a specific `partitionKey` \(a metadata property\)\. In addition, you want to process only events with the `Location` field \(a data property\) equal to "Los Angeles"\. In this case, your `FilterCriteria` object would look like this: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"partitionKey\": [ \"1\" ], \"data\": { \"Location\": [ \"Los Angeles\" ] }}" + } + ] +} +``` + +For added clarity, here is the value of the filter's `Pattern` expanded in plain JSON\. + +``` +{ + "partitionKey": [ "1" ], + "data": { + "Location": [ "Los Angeles" ] + } +} +``` + +The previous example uses the **Equals** comparison operator for both `partitionKey` and `Location`\. + +As another example, suppose that you want to handle only events where the `Temperature` data property is greater than 50 but less than or equal to 60\. In this case, your `FilterCriteria` object would look like this: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"data\": { \"Temperature\": [ {\"numeric\": [ \">\", 50, \"<=\", 60 ] }]}" + } + ] +} +``` + +For added clarity, here is the value of the filter's `Pattern` expanded in plain JSON\. + +``` +{ + "data": { + "Temperature": [ {"numeric": [ ">", 50, "<=", 60 ] } ] + } +} +``` + +The previous example uses the **Numeric \(range\)** comparison operator for `Temperature`\. + +### Multi\-level filtering + +You can also use event filtering to handle multi\-level JSON filtering\. For example, suppose you receive a DynamoDB stream event with a data object that looks like the following: + +``` +"dynamodb": { + "Keys": { + "Id": { + "N": "101" + } + }, + "NewImage": { + "Message": { + "S": "New item!" + }, + "Id": { + "N": "101" + } + }, + "SequenceNumber": "111", + "SizeBytes": 26, + "StreamViewType": "NEW_AND_OLD_IMAGES" +} +``` + +Suppose you only wanted to handle events where the Key ID value, `N`, is 101\. In this case, your `FilterCriteria` object would look like this: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"dynamodb\": { \"Keys\": { \"Id\": { \"N\": [ "101" ] } } } }" + } + ] +} +``` + +For added clarity, here is the value of the filter's `Pattern` expanded in plain JSON\. + +``` +{ + "dynamodb": { + "Keys": { + "Id": { + "N": [ "101" ] + } + } + } +} +``` + +The previous example uses the **Equals** comparison operator for `N`, which is nested multiple layers within the `dynamodb` data field\. + +## Attaching filter criteria to an event source mapping \(console\) + +Follow these steps to create a new event source mapping with filter criteria using the Lambda console\. + +**To create a new event source mapping with filter criteria \(console\)** + +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. + +1. Choose the name of a function to create an event source mapping for\. + +1. Under **Function overview**, choose **Add trigger**\. + +1. For **Trigger configuration**, choose a trigger type that supports event filtering\. These include **SQS**, **DynamoDB**, and **Kinesis**\. + +1. Expand **Additional settings**\. + +1. Under **Filter criteria**, define and enter your filters\. For example, you can enter the following: + + ``` + { "a" : [ 1, 2 ] } + ``` + + This instructs Lambda to process only the records where field `a` is equal to 1 or 2\. + +1. Choose **Add**\. + +When you enter filter criteria using the console, you provide only the filter pattern\. In step 6 of the preceding instructions, `{ "a" : [ 1, 2 ] }` corresponds to the following `FilterCriteria`: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"a\" : [ 1, 2 ] }" + } + ] +} +``` + +After creating your event source mapping in the console, you can see the formatted `FilterCriteria` in the trigger details\. Note that when entering filters using the console, you don't need to provide the `Pattern` key or escape quotes\. + +**Note** +By default, you can have five different filters per event source\. You can [request a quota increase](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) for up to 10 filters per event source\. The Lambda console lets you add up to 10 filters depending on the current quota for your account\. If you attempt to add more filters than your current quota allows, Lambda throws an error when you try to create the event source\. + +## Attaching filter criteria to an event source mapping \(AWS CLI\) + +Suppose you want an event source mapping to have the following `FilterCriteria`: + +``` +{ + "Filters": [ + { + "Pattern": "{ \"a\" : [ 1, 2 ] }" + } + ] +} +``` + +To create a new event source mapping with these filter criteria using the AWS Command Line Interface \(AWS CLI\), run the following command: + +``` +aws lambda create-event-source-mapping \ + --function-name my-function \ + --event-source-arn arn:aws:sqs:us-east-2:123456789012:my-queue \ + --filter-criteria "{\"Filters\": [{\"Pattern\": \"{ \"a\" : [ 1, 2 ]}\"}]}" +``` + +This [CreateEventSourceMapping](API_CreateEventSourceMapping.md) command creates a new Amazon SQS event source mapping for function `my-function` with the specified `FilterCriteria`\. + +To add these filter criteria to an existing event source mapping, run the following command: + +``` +aws lambda update-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ + --filter-criteria "{\"Filters\": [{\"Pattern\": \"{ \"a\" : [ 1, 2 ]}\"}]}" +``` + +Note that to update an event source mapping, you need its UUID\. You can get the UUID from a [ListEventSourceMappings](API_ListEventSourceMappings.md) call\. Lambda also returns the UUID in the [CreateEventSourceMapping](API_CreateEventSourceMapping.md) API response\. + +To remove filter criteria from an event source, you can run the following [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) command with an empty `FilterCriteria` object: + +``` +aws lambda update-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ + --filter-criteria "{}" +``` + +## Properly filtering Amazon SQS messages + +If an Amazon SQS message doesn't satisfy your filter criteria, Lambda automatically removes the message from the queue\. You don't have to manually delete these messages in Amazon SQS\. + +For Amazon SQS, the message `body` can be any string\. However, this can be problematic if your `FilterCriteria` expects `body` to be in a valid JSON format\. The reverse scenario is also true—if the incoming message `body` is in a valid JSON format, this can lead to unintended behavior if your filter criteria expects `body` to be a plain string\. + +To avoid this issue, ensure that the format of `body` in your `FilterCriteria` matches the expected format of `body` in messages that you receive from your queue\. Before filtering your messages, Lambda automatically evaluates the format of the incoming message `body` and of your filter pattern for `body`\. If there is a mismatch, Lambda drops the message\. The following table summarizes this evaluation: + + +| Incoming message `body` format | Filter pattern `body` format | Resulting action | +| --- | --- | --- | +| Plain string | Plain string | Lambda filters based on your filter criteria\. | +| Plain string | No filter pattern for data properties | Lambda filters \(on the other metadata properties only\) based on your filter criteria\. | +| Plain string | Valid JSON | Lambda drops the message\. | +| Valid JSON | Plain string | Lambda drops the message\. | +| Valid JSON | No filter pattern for data properties | Lambda filters \(on the other metadata properties only\) based on your filter criteria\. | +| Valid JSON | Valid JSON | Lambda filters based on your filter criteria\. | + +If you don't include `body` as part of your `FilterCriteria`, Lambda skips this check\. + +## Properly filtering Kinesis and DynamoDB messages + +Once your filter criteria processes an Kinesis or DynamoDB record, the streams iterator advances past this record\. If the record doesn't satisfy your filter criteria, you don't have to manually delete the record from your event source\. After the retention period, Kinesis and DynamoDB automatically delete these old records\. If you want records to be deleted sooner, see [Changing the Data Retention Period](https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-extended-retention.html)\. + +To properly filter events from stream event sources, both the data field and your filter criteria for the data field must be in valid JSON format\. \(For Kinesis, the data field is `data`\. For DynamoDB, the data field is `dynamodb`\.\) If either field isn't in a valid JSON format, Lambda drops the message or throws an exception\. The following table summarizes the specific behavior: + + +| Incoming data format \(`data` or `dynamodb`\) | Filter pattern format for data properties | Resulting action | +| --- | --- | --- | +| Valid JSON | Valid JSON | Lambda filters based on your filter criteria\. | +| Valid JSON | No filter pattern for data properties | Lambda filters \(on the other metadata properties only\) based on your filter criteria\. | +| Valid JSON | Non\-JSON | Lambda throws an exception at the time of the event source mapping creation or update\. The filter pattern for data properties must be in a valid JSON format\. | +| Non\-JSON | Valid JSON | Lambda drops the record\. | +| Non\-JSON | No filter pattern for data properties | Lambda filters \(on the other metadata properties only\) based on your filter criteria\. | +| Non\-JSON | Non\-JSON | Lambda throws an exception at the time of the event source mapping creation or update\. The filter pattern for data properties must be in a valid JSON format\. | \ No newline at end of file diff --git a/doc_source/invocation-eventsourcemapping.md b/doc_source/invocation-eventsourcemapping.md old mode 100644 new mode 100755 index 854d36dd..60882025 --- a/doc_source/invocation-eventsourcemapping.md +++ b/doc_source/invocation-eventsourcemapping.md @@ -1,25 +1,25 @@ -# AWS Lambda event source mappings +# Lambda event source mappings -An event source mapping is an AWS Lambda resource that reads from an event source and invokes a Lambda function\. You can use event source mappings to process items from a stream or queue in services that don't invoke Lambda functions directly\. Lambda provides event source mappings for the following services\. +An event source mapping is a Lambda resource that reads from an event source and invokes a Lambda function\. You can use event source mappings to process items from a stream or queue in services that don't invoke Lambda functions directly\. Lambda provides event source mappings for the following services\. **Services that Lambda reads events from** + [Amazon DynamoDB](with-ddb.md) + [Amazon Kinesis](with-kinesis.md) + [Amazon MQ](with-mq.md) -+ [Amazon Managed Streaming for Apache Kafka](with-msk.md) -+ [self\-managed Apache Kafka](with-kafka.md) -+ [Amazon Simple Queue Service](with-sqs.md) ++ [Amazon Managed Streaming for Apache Kafka \(Amazon MSK\)](with-msk.md) ++ [Self\-managed Apache Kafka](with-kafka.md) ++ [Amazon Simple Queue Service \(Amazon SQS\)](with-sqs.md) An event source mapping uses permissions in the function's [execution role](lambda-intro-execution-role.md) to read and manage items in the event source\. Permissions, event structure, settings, and polling behavior vary by event source\. For more information, see the linked topic for the service that you use as an event source\. -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) + [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) + [DeleteEventSourceMapping](API_DeleteEventSourceMapping.md) -The following example uses the AWS CLI to map a function named `my-function` to a DynamoDB stream that is specified by its Amazon Resource Name \(ARN\), with a batch size of 500\. +The following example uses the AWS CLI to map a function named `my-function` to a DynamoDB stream that its Amazon Resource Name \(ARN\) specifies, with a batch size of 500\. ``` aws lambda create-event-source-mapping --function-name my-function --batch-size 500 --starting-position LATEST \ @@ -47,17 +47,30 @@ You should see the following output: } ``` -Event source mappings read items from a stream or queue in batches\. They include multiple items in the event that your function receives\. You can configure the size of the batch that the event source mapping sends to your function, up to a maximum that varies by service\. The number of items in the event can be smaller than the batch size if there aren't enough items available, or if the batch is too large to send in one event and has to be split up\. +## Batching behavior + +Event source mappings read items from a target event source\. By default, an event source mapping batches records together into a single payload that Lambda sends to your function\. To fine\-tune batching behavior, you can configure a batching window \(`MaximumBatchingWindowInSeconds`\) and a batch size \(`BatchSize`\)\. A batching window is the maximum amount of time to gather records into a single payload\. A batch size is the maximum number of records in a single batch\. Lambda invokes your function when one of the following three criteria is met: ++ **The batching window reaches its maximum value\.** Batching window behavior varies depending on the specific event source\. + + **For Kinesis, DynamoDB, and Amazon SQS event sources:** The default batching window is 0 seconds\. This means that Lambda sends batches to your function as quickly as possible\. If you configure a `MaximumBatchingWindowInSeconds`, the next batching window begins as soon as the previous function invocation completes\. + + **For Amazon MSK, self\-managed Apache Kafka, and Amazon MQ event sources:** The default batching window is 500 ms\. You can configure `MaximumBatchingWindowInSeconds` to any value from 0 seconds to 300 seconds in increments of seconds\. A batching window begins as soon as the first record arrives\. +**Note** +Because you can only change `MaximumBatchingWindowInSeconds` in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it\. To restore the default batching window, you must create a new event source mapping\. ++ **The batch size is met\.** The minimum batch size is 1\. The default and maximum batch size depend on the event source\. For details about these values, see the [https://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html#SSS-CreateEventSourceMapping-request-BatchSize](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html#SSS-CreateEventSourceMapping-request-BatchSize) specification for the `CreateEventSourceMapping` API operation\. ++ **The payload size reaches [6 MB](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html)\.** You cannot modify this limit\. + +The following diagram illustrates these three conditions\. Suppose a batching window begins at `t = 7` seconds\. In the first scenario, the batching window reaches its 40 second maximum at `t = 47` seconds after accumulating 5 records\. In the second scenario, the batch size reaches 10 before the batching window expires, so the batching window ends early\. In the third scenario, the maximum payload size is reached before the batching window expires, so the batching window ends early\. + +![\[\]](http://docs.aws.amazon.com/lambda/latest/dg/images/batching-window.png) The following example shows an event source mapping that reads from a Kinesis stream\. If a batch of events fails all processing attempts, the event source mapping sends details about the batch to an SQS queue\. ![\[\]](http://docs.aws.amazon.com/lambda/latest/dg/images/features-eventsourcemapping.png) -The event batch is the event that Lambda sends to the function\. It is a batch of records or messages compiled from the items that the event source mapping reads from a stream or queue\. Batch size and other settings only apply to the event batch\. +The event batch is the event that Lambda sends to the function\. It is a batch of records or messages compiled from the items that the event source mapping reads up until the current batching window expires\. -For streams, an event source mapping creates an iterator for each shard in the stream and processes items in each shard in order\. You can configure the event source mapping to read only new items that appear in the stream, or to start with older items\. Processed items aren't removed from the stream and can be processed by other functions or consumers\. +For streams, an event source mapping creates an iterator for each shard in the stream and processes items in each shard in order\. You can configure the event source mapping to read only new items that appear in the stream, or to start with older items\. Processed items aren't removed from the stream, and other functions or consumers can process them\. -By default, if your function returns an error, the entire batch is reprocessed until the function succeeds, or the items in the batch expire\. To ensure in\-order processing, processing for the affected shard is paused until the error is resolved\. You can configure the event source mapping to discard old events, restrict the number of retries, or process multiple batches in parallel\. If you process multiple batches in parallel, in\-order processing is still guaranteed for each partition key, but multiple partition keys in the same shard are processed simultaneously\. +By default, if your function returns an error, the event source mapping reprocesses the entire batch until the function succeeds, or the items in the batch expire\. To ensure in\-order processing, the event source mapping pauses processing for the affected shard until the error is resolved\. You can configure the event source mapping to discard old events, restrict the number of retries, or process multiple batches in parallel\. If you process multiple batches in parallel, in\-order processing is still guaranteed for each partition key, but the event source mapping simultaneously processes multiple partition keys in the same shard\. You can also configure the event source mapping to send an invocation record to another service when it discards an event batch\. Lambda supports the following [destinations](invocation-async.md#invocation-async-destinations) for event source mappings\. + **Amazon SQS** – An SQS queue\. @@ -67,7 +80,7 @@ The invocation record contains details about the failed event batch in JSON form The following example shows an invocation record for a Kinesis stream\. -**Example invocation Record** +**Example invocation record** ``` { @@ -96,6 +109,6 @@ The following example shows an invocation record for a Kinesis stream\. } ``` -Lambda also supports in\-order processing for [FIFO \(first\-in, first\-out\) queues](with-sqs.md), scaling up to the number of active message groups\. For standard queues, items aren't necessarily processed in order\. Lambda scales up to process a standard queue as quickly as possible\. When an error occurs, batches are returned to the queue as individual items and might be processed in a different grouping than the original batch\. Occasionally, the event source mapping might receive the same item from the queue twice, even if no function error occurred\. Lambda deletes items from the queue after they're processed successfully\. You can configure the source queue to send items to a dead\-letter queue if they can't be processed\. +Lambda also supports in\-order processing for [FIFO \(first\-in, first\-out\) queues](with-sqs.md), scaling up to the number of active message groups\. For standard queues, items aren't necessarily processed in order\. Lambda scales up to process a standard queue as quickly as possible\. When an error occurs, Lambda returns batches to the queue as individual items and might process them in a different grouping than the original batch\. Occasionally, the event source mapping might receive the same item from the queue twice, even if no function error occurred\. Lambda deletes items from the queue after they're processed successfully\. You can configure the source queue to send items to a dead\-letter queue if Lambda can't process them\. For information about services that invoke Lambda functions directly, see [Using AWS Lambda with other services](lambda-services.md)\. \ No newline at end of file diff --git a/doc_source/invocation-images.md b/doc_source/invocation-images.md old mode 100644 new mode 100755 diff --git a/doc_source/invocation-layers.md b/doc_source/invocation-layers.md old mode 100644 new mode 100755 index fdafb450..4dd05457 --- a/doc_source/invocation-layers.md +++ b/doc_source/invocation-layers.md @@ -25,7 +25,7 @@ Make sure that the layers that you add to a function are compatible with the run **Adding a layer to a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to configure\. @@ -51,7 +51,7 @@ The order in which you add the layers is the order in which Lambda later merges **Update layer order for your function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to configure\. @@ -67,7 +67,7 @@ Layers are versioned, and the content of each layer version is immutable\. The l **Update layer versions for your function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to configure\. diff --git a/doc_source/invocation-retries.md b/doc_source/invocation-retries.md old mode 100644 new mode 100755 index 649fd7ad..116a32b1 --- a/doc_source/invocation-retries.md +++ b/doc_source/invocation-retries.md @@ -32,7 +32,7 @@ When you invoke a function indirectly, you need to be aware of the retry behavio + **Asynchronous invocation** – Lambda retries function errors twice\. If the function doesn't have enough capacity to handle all incoming requests, events might wait in the queue for hours or days to be sent to the function\. You can configure a dead\-letter queue on the function to capture events that weren't successfully processed\. For more information, see [Asynchronous invocation](invocation-async.md)\. + **Event source mappings** – Event source mappings that read from streams retry the entire batch of items\. Repeated errors block processing of the affected shard until the error is resolved or the items expire\. To detect stalled shards, you can monitor the [Iterator Age](monitoring-metrics.md) metric\. - For event source mappings that read from a queue, you determine the length of time between retries and destination for failed events by configuring the visibility timeout and redrive policy on the source queue\. For more information, see [AWS Lambda event source mappings](invocation-eventsourcemapping.md) and the service\-specific topics under [Using AWS Lambda with other services](lambda-services.md)\. + For event source mappings that read from a queue, you determine the length of time between retries and destination for failed events by configuring the visibility timeout and redrive policy on the source queue\. For more information, see [Lambda event source mappings](invocation-eventsourcemapping.md) and the service\-specific topics under [Using AWS Lambda with other services](lambda-services.md)\. + **AWS services** – AWS services can invoke your function [synchronously](invocation-sync.md) or asynchronously\. For synchronous invocation, the service decides whether to retry\. For example, Amazon S3 batch operations retries the operation if the Lambda function returns a `TemporaryFailure` response code\. Services that proxy requests from an upstream user or client may have a retry strategy or may relay the error response back to the requestor\. For example, API Gateway always relays the error response back to the requestor\. For asynchronous invocation, the behavior is the same as when you invoke the function synchronously\. For more information, see the service\-specific topics under [Using AWS Lambda with other services](lambda-services.md) and the invoking service's documentation\. diff --git a/doc_source/invocation-scaling.md b/doc_source/invocation-scaling.md old mode 100644 new mode 100755 index 28d91bcf..ccec4642 --- a/doc_source/invocation-scaling.md +++ b/doc_source/invocation-scaling.md @@ -2,9 +2,9 @@ The first time you invoke your function, AWS Lambda creates an instance of the function and runs its handler method to process the event\. When the function returns a response, it stays active and waits to process additional events\. If you invoke the function again while the first event is being processed, Lambda initializes another instance, and the function processes the two events concurrently\. As more events come in, Lambda routes them to available instances and creates new instances as needed\. When the number of requests decreases, Lambda stops unused instances to free up scaling capacity for other functions\. -The default regional concurrency limit starts at 1,000\. For more information, or to request an increase on this limit, see [Lambda quotas](gettingstarted-limits.md)\. To allocate capacity on a per\-function basis, you can configure functions with [reserved concurrency](configuration-concurrency.md)\. +The default regional concurrency quota starts at 1,000 instances\. For more information, or to request an increase on this quota, see [Lambda quotas](gettingstarted-limits.md)\. To allocate capacity on a per\-function basis, you can configure functions with [reserved concurrency](configuration-concurrency.md)\. - Your functions' *concurrency* is the number of instances that serve requests at a given time\. For an initial burst of traffic, your functions' cumulative concurrency in a Region can reach an initial level of between 500 and 3000, which varies per Region\. Note that the burst concurrency quota is not per\-function; it applies to all of your functions in the Region\. +Your functions' *concurrency* is the number of instances that serve requests at a given time\. For an initial burst of traffic, your functions' cumulative concurrency in a Region can reach an initial level of between 500 and 3000, which varies per Region\. Note that the burst concurrency quota is not per\-function; it applies to all your functions in the Region\. **Burst concurrency quotas** + **3000** – US West \(Oregon\), US East \(N\. Virginia\), Europe \(Ireland\) @@ -24,7 +24,7 @@ The following example shows a function processing a spike in traffic\. As invoca The function continues to scale until the account's concurrency limit for the function's Region is reached\. The function catches up to demand, requests subside, and unused instances of the function are stopped after being idle for some time\. Unused instances are frozen while they're waiting for requests and don't incur any charges\. -When your function scales up, the first request served by each instance is impacted by the time it takes to load and initialize your code\. If your [initialization code](foundation-progmodel.md) takes a long time, the impact on average and percentile latency can be significant\. To enable your function to scale without fluctuations in latency, use [provisioned concurrency](configuration-concurrency.md)\. The following example shows a function with provisioned concurrency processing a spike in traffic\. +When your function scales up, the first request served by each instance is impacted by the time it takes to load and initialize your code\. If your [initialization code](foundation-progmodel.md) takes a long time, the impact on average and percentile latency can be significant\. To enable your function to scale without fluctuations in latency, use [provisioned concurrency](provisioned-concurrency.md)\. The following example shows a function with provisioned concurrency processing a spike in traffic\. ![\[\]](http://docs.aws.amazon.com/lambda/latest/dg/images/features-scaling-provisioned.png) @@ -34,7 +34,9 @@ When your function scales up, the first request served by each instance is impac + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/lambda/latest/dg/images/features-scaling-provisioned.provisioned.png) Provisioned concurrency + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/lambda/latest/dg/images/features-scaling-provisioned.standard.png) Standard concurrency -When you allocate provisioned concurrency, your function is ready to serve a burst of incoming requests with very low latency\. When all provisioned concurrency is in use, the function scales up normally to handle any additional requests\. +When you configure a number for provisioned concurrency, Lambda initializes that number of execution environments\. Your function is ready to serve a burst of incoming requests with very low latency\. Note that configuring [provisioned concurrency](provisioned-concurrency.md) incurs charges to your AWS account\. + + When all provisioned concurrency is in use, the function scales up normally to handle any additional requests\. Application Auto Scaling takes this a step further by providing autoscaling for provisioned concurrency\. With Application Auto Scaling, you can create a target tracking scaling policy that adjusts provisioned concurrency levels automatically, based on the utilization metric that Lambda emits\. [Use the Application Auto Scaling API](configuration-concurrency.md#configuration-concurrency-api) to register an alias as a scalable target and create a scaling policy\. @@ -50,7 +52,7 @@ In the following example, a function scales between a minimum and maximum amount When you invoke your function asynchronously, by using an event source mapping or another AWS service, scaling behavior varies\. For example, event source mappings that read from a stream are limited by the number of shards in the stream\. Scaling capacity that is unused by an event source is available for use by other clients and event sources\. For more information, see the following topics\. + [Asynchronous invocation](invocation-async.md) -+ [AWS Lambda event source mappings](invocation-eventsourcemapping.md) ++ [Lambda event source mappings](invocation-eventsourcemapping.md) + [Error handling and automatic retries in AWS Lambda](invocation-retries.md) + [Using AWS Lambda with other services](lambda-services.md) @@ -64,4 +66,4 @@ You can monitor concurrency levels in your account by using the following metric + `ProvisionedConcurrencySpilloverInvocations` + `ProvisionedConcurrencyUtilization` -For more information, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. \ No newline at end of file +For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. \ No newline at end of file diff --git a/doc_source/invocation-sync.md b/doc_source/invocation-sync.md old mode 100644 new mode 100755 diff --git a/doc_source/java-context.md b/doc_source/java-context.md old mode 100644 new mode 100755 diff --git a/doc_source/java-exceptions.md b/doc_source/java-exceptions.md old mode 100644 new mode 100755 index 0c6a36c8..58fb0f89 --- a/doc_source/java-exceptions.md +++ b/doc_source/java-exceptions.md @@ -131,7 +131,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -164,7 +164,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/java-handler.md b/doc_source/java-handler.md old mode 100644 new mode 100755 diff --git a/doc_source/java-image.md b/doc_source/java-image.md old mode 100644 new mode 100755 index c0a7aa29..0e5bc56e --- a/doc_source/java-image.md +++ b/doc_source/java-image.md @@ -5,7 +5,7 @@ You can deploy your Lambda function code as a [container image](images-create.md These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. diff --git a/doc_source/java-logging.md b/doc_source/java-logging.md old mode 100644 new mode 100755 index 2297df33..e9ebaa81 --- a/doc_source/java-logging.md +++ b/doc_source/java-logging.md @@ -150,7 +150,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash @@ -219,6 +219,11 @@ Log groups aren't deleted automatically when you delete a function\. To avoid st ## Advanced logging with Log4j 2 and SLF4J +**Note** + AWS Lambda does not include Log4j2 in its managed runtimes or base container images\. These are therefore not affected by the issues described in CVE\-2021\-44228, CVE\-2021\-45046, and CVE\-2021\-45105\. + For cases where a customer function includes an impacted Log4j2 version, we have applied a change to the Lambda Java [managed runtimes](lambda-runtimes.md) and [base container images](java-image.md) that helps to mitigate the issues in CVE\-2021\-44228, CVE\-2021\-45046, and CVE\-2021\-45105\. As a result of this change, customers using Log4J2 may see an additional log entry, similar to "`Transforming org/apache/logging/log4j/core/lookup/JndiLookup (java.net.URLClassLoader@...)`"\. Any log strings that reference the jndi mapper in the Log4J2 output will be replaced with "`Patched JndiLookup::lookup()`"\. + Independent of this change, we strongly encourage all customers whose functions include Log4j2 to update to the latest version\. Specifically, customers using the aws\-lambda\-java\-log4j2 library in their functions should update to version 1\.5\.0 \(or later\), and redeploy their functions\. This version updates the underlying Log4j2 utility dependencies to version 2\.17\.0 \(or later\)\. The updated aws\-lambda\-java\-log4j2 binary is available at the [Maven repository](https://repo1.maven.org/maven2/com/amazonaws/aws-lambda-java-log4j2/) and its source code is available in [Github](https://github.com/aws/aws-lambda-java-libs/tree/master/aws-lambda-java-log4j2)\. + To customize log output, support logging during unit tests, and log AWS SDK calls, use Apache Log4j 2 with SLF4J\. Log4j is a logging library for Java programs that enables you to configure log levels and use appender libraries\. SLF4J is a facade library that lets you change which library you use without changing your function code\. To add the request ID to your function's logs, use the appender in the [aws\-lambda\-java\-log4j2](java-package.md) library\. The following example shows a Log4j 2 configuration file that adds a timestamp and request ID to all logs\. @@ -308,12 +313,12 @@ dependencies { implementation 'com.amazonaws:aws-xray-recorder-sdk-aws-sdk-v2' implementation 'com.amazonaws:aws-xray-recorder-sdk-aws-sdk-v2-instrumentor' implementation 'com.amazonaws:aws-lambda-java-core:1.2.1' - implementation 'com.amazonaws:aws-lambda-java-events:3.1.0' + implementation 'com.amazonaws:aws-lambda-java-events:3.11.0' implementation 'com.google.code.gson:gson:2.8.6' - implementation 'org.apache.logging.log4j:log4j-api:[2.17.1,)' - implementation 'org.apache.logging.log4j:log4j-core:[2.17.1,)' - runtimeOnly 'org.apache.logging.log4j:log4j-slf4j18-impl:[2.17.1,)' - runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.5.0' + implementation 'org.apache.logging.log4j:log4j-api:2.17.0' + implementation 'org.apache.logging.log4j:log4j-core:2.17.0' + runtimeOnly 'org.apache.logging.log4j:log4j-slf4j18-impl:2.17.0' + runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.5.1' testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } diff --git a/doc_source/java-package-eclipse.md b/doc_source/java-package-eclipse.md old mode 100644 new mode 100755 diff --git a/doc_source/java-package.md b/doc_source/java-package.md old mode 100644 new mode 100755 index 5c43578a..7f3c20f0 --- a/doc_source/java-package.md +++ b/doc_source/java-package.md @@ -30,8 +30,8 @@ These libraries are available through [Maven Central Repository](https://search. ``` dependencies { implementation 'com.amazonaws:aws-lambda-java-core:1.2.1' - implementation 'com.amazonaws:aws-lambda-java-events:3.1.0' - runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.2.0' + implementation 'com.amazonaws:aws-lambda-java-events:3.11.0' + runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.5.1' } ``` @@ -48,12 +48,12 @@ dependencies { com.amazonaws aws-lambda-java-events - 3.1.0 + 3.11.0 com.amazonaws aws-lambda-java-log4j2 - 1.2.0 + 1.5.1 ``` @@ -69,7 +69,7 @@ You can upload your deployment package by using the Lambda console, the Lambda A **To upload a deployment package with the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -110,12 +110,12 @@ dependencies { implementation platform('software.amazon.awssdk:bom:2.10.73') implementation 'software.amazon.awssdk:lambda' implementation 'com.amazonaws:aws-lambda-java-core:1.2.1' - implementation 'com.amazonaws:aws-lambda-java-events:3.1.0' + implementation 'com.amazonaws:aws-lambda-java-events:3.11.0' implementation 'com.google.code.gson:gson:2.8.6' - implementation 'org.apache.logging.log4j:log4j-api:[2.17.1,)' - implementation 'org.apache.logging.log4j:log4j-core:[2.17.1,)' - runtimeOnly 'org.apache.logging.log4j:log4j-slf4j18-impl:[2.17.1,)' - runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.5.0' + implementation 'org.apache.logging.log4j:log4j-api:2.13.0' + implementation 'org.apache.logging.log4j:log4j-core:2.13.0' + runtimeOnly 'org.apache.logging.log4j:log4j-slf4j18-impl:2.13.0' + runtimeOnly 'com.amazonaws:aws-lambda-java-log4j2:1.5.1' testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } @@ -169,7 +169,7 @@ To build the deployment package, use the `mvn package` command\. [INFO] [INFO] --- maven-shade-plugin:3.2.2:shade (default) @ java-maven --- [INFO] Including com.amazonaws:aws-lambda-java-core:jar:1.2.1 in the shaded jar. -[INFO] Including com.amazonaws:aws-lambda-java-events:jar:3.1.0 in the shaded jar. +[INFO] Including com.amazonaws:aws-lambda-java-events:jar:3.11.0 in the shaded jar. [INFO] Including joda-time:joda-time:jar:2.6 in the shaded jar. [INFO] Including com.google.code.gson:gson:jar:2.8.6 in the shaded jar. [INFO] Replacing original artifact with shaded artifact. @@ -214,7 +214,7 @@ If you use the appender library \(`aws-lambda-java-log4j2`\), you must also conf com.github.edwgiz maven-shade-plugin.log4j2-cachefile-transformer - [2.17.1,) + 2.13.0 diff --git a/doc_source/java-samples.md b/doc_source/java-samples.md old mode 100644 new mode 100755 diff --git a/doc_source/java-tracing.md b/doc_source/java-tracing.md old mode 100644 new mode 100755 index db2726ad..1087a16c --- a/doc_source/java-tracing.md +++ b/doc_source/java-tracing.md @@ -10,7 +10,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/kinesis-tutorial-spec.md b/doc_source/kinesis-tutorial-spec.md old mode 100644 new mode 100755 index 7c16045e..250afe05 --- a/doc_source/kinesis-tutorial-spec.md +++ b/doc_source/kinesis-tutorial-spec.md @@ -1,6 +1,6 @@ # AWS SAM template for a DynamoDB application -You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [ AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. +You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. Below is a sample AWS SAM template for the [tutorial application](with-ddb-example.md)\. Copy the text below to a \.yaml file and save it next to the ZIP package you created previously\. Note that the `Handler` and `Runtime` parameter values should match the ones you used when you created the function in the previous section\. diff --git a/doc_source/lambda-api-permissions-ref.md b/doc_source/lambda-api-permissions-ref.md old mode 100644 new mode 100755 index 456ac147..5b7f022f --- a/doc_source/lambda-api-permissions-ref.md +++ b/doc_source/lambda-api-permissions-ref.md @@ -76,108 +76,72 @@ For more information on resources and conditions for Lambda and other AWS servic ## Function resource names -You reference a Lambda function in a policy statement using an Amazon Resource Names \(ARN\)\. The format of a function ARN depends on whether you are referencing the whole function, a function [version](configuration-versions.md), or an [alias](configuration-aliases.md)\. +You reference a Lambda function in a policy statement using an Amazon Resource Name \(ARN\)\. The format of a function ARN depends on whether you are referencing the whole function \(unqualified\) or a function [version](configuration-versions.md) or [alias](configuration-aliases.md) \(qualified\)\. -When making Lambda API calls, users can specify a version or alias by passing a version ARN or alias ARN in the [GetFunction](API_GetFunction.md) `FunctionName` parameter, or by setting a value in the [GetFunction](API_GetFunction.md) `Qualifier` parameter\. Lambda makes authorization decisions by comparing the resource element in the IAM policy with the `FunctionName` passed in the API calls\. +When making Lambda API calls, users can specify a version or alias by passing a version ARN or alias ARN in the [GetFunction](API_GetFunction.md) `FunctionName` parameter, or by setting a value in the [GetFunction](API_GetFunction.md) `Qualifier` parameter\. Lambda makes authorization decisions by comparing the resource element in the IAM policy with both the `FunctionName` and `Qualifier` passed in API calls\. If there is a misamtch, Lambda denies the request\. -You must use the correct function ARN types in your policies to achieve the results that you expect, especially in policies that deny access\. We recommend that you follow the best practices for using Deny statements with functions\. +Whether you are allowing or denying an action on your function, you must use the correct function ARN types in your policy statement to achieve the results that you expect\. For example, if your policy references the unqualified ARN, Lambda accepts requests that reference the unqualified ARN but denies requests that reference a qualified ARN\. - - -### Best practices for using Deny statements with functions - -The following table summarizes the resources to use in Deny effects\. In the **Resource** column, `MyFunction` is the name of the function, `:1` refers to version 1 of the function, and `MyAlias` is the name of a function alias\. - - -**Resource best practices** - -| Policy objective | Resource | -| --- | --- | -| Deny access to all versions of a function | `MyFunction*` | -| Deny access to a specific alias | `MyFunction:MyAlias` and `MyFunction` | -| Deny access to a specific version of a function | `MyFunction:1` and `MyFunction` | - -The following sections provide example policy statements for each of the policy objectives\. - -**Note** -You can use only identity\-based policies to deny specific function resources\. Currently, Lambda does not support the `Deny` effect in resource\-based policies\. - -For the action list in a policy statement, you can add any of the [ actions defined by Lambda](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html) that act on a function resource\. - -#### Deny access to all function versions - -The following identity\-based policy statement denies access to the `lambda:GetFunctionConfiguration` action for all versions of the `my-function` function\. The wildcard character at the end of the function ARN ensures that this policy applies to all version and alias ARNs\. - -**Example identity\-based policy** +**Example allowing invocation of an unqualified arn** ``` { "Version": "2012-10-17", "Statement": [ { - "Effect": "Deny", - "Action": [ - "lambda:GetFunctionConfiguration" - ], - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function*" - } + "Effect": "Allow", + "Action": "lambda:InvokeFunction", + "Resource": "arn:aws:lambda:us-west-2:123456789012:myFunction" ] } ``` -#### Deny access to a specific function alias - -To deny access to a specific alias, you must specify both the alias ARN and the unqualified function ARN in the policy\. This prevents users from accessing the specific alias by passing the unqualified ARN as the `FunctionName` and the alias as the `Qualifier`\. - -**Note** -If you create this type of policy, API calls need to refer to the unpublished version of the function by specifying a qualified ARN with the $LATEST suffix in the `FunctionName` parameter\. +If your policy references a specific qualified ARN, Lambda accepts requests that reference that ARN but denies requests that reference the unqualified ARN or a different qualified ARN, for example, `myFunction:2`\. -The following identity\-based policy statement denies access to the `lambda:InvokeFunction` action in the `my-alias` alias of the `my-function` function\. - -**Example identity\-based policy** +**Example allowing invocation of a specific qualified arn** ``` { "Version": "2012-10-17", "Statement": [ { - "Sid": "DenySpecificAlias", - "Effect": "Deny", + "Effect": "Allow", "Action": "lambda:InvokeFunction", - "Resource": [ - "arn:aws:lambda:us-west-2:123456789012:function:my-function:my-alias", - "arn:aws:lambda:us-west-2:123456789012:function:my-function" - ] + "Resource": "arn:aws:lambda:us-west-2:123456789012:myFunction:1" } ] } ``` -#### Deny access to a specific function version +If your policy references any qualified ARN using `:*`, Lambda accepts any qualified ARN but denies requests that reference the unqualified ARN\. -To deny access to a specific version, you must specify both the qualified ARN and the unqualified ARN in the policy\. This prevents users from accessing the specific version by passing the unqualified ARN as the `FunctionName` and the version as the `Qualifier`\. +**Example allowing invocation of any qualified arn** -**Note** -If you create this type of policy, API calls need to refer to the unpublished version of the function by specifying a qualified ARN with the $LATEST suffix in the `FunctionName` parameter\. +``` +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": "lambda:InvokeFunction", + "Resource": "arn:aws:lambda:us-west-2:123456789012:myFunction:*" + } + ] +} +``` -The following identity\-based policy statement denies access to the invoke action in version 1 of the `my-function` function\. +If your policy references any ARN using `*`, Lambda accepts any qualified or unqualified ARN\. -**Example identity\-based policy** +**Example allowing invocation of any qualified or unqualified arn** ``` { "Version": "2012-10-17", "Statement": [ { - "Sid": "DenySpecificFunctionVersion", - "Effect": "Deny", - "Action": [ - "lambda:InvokeFunction" - ], - "Resource": [ - "arn:aws:lambda:us-west-2:123456789012:function:my-function:1", - "arn:aws:lambda:us-west-2:123456789012:function:my-function" - ] + "Effect": "Allow", + "Action": "lambda:InvokeFunction", + "Resource": "arn:aws:lambda:us-west-2:123456789012:myFunction*" } ] } diff --git a/doc_source/lambda-csharp.md b/doc_source/lambda-csharp.md old mode 100644 new mode 100755 index 3bbe3c5b..fae83b69 --- a/doc_source/lambda-csharp.md +++ b/doc_source/lambda-csharp.md @@ -23,6 +23,7 @@ These packages are available at [Nuget packages](https://www.nuget.org/packages/ | Name | Identifier | Operating system | Architectures | | --- | --- | --- | --- | +| \.NET 6 | `dotnet6` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 3\.1 | `dotnetcore3.1` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 2\.1 | `dotnetcore2.1` | Amazon Linux | x86\_64 | @@ -36,10 +37,10 @@ To get started with application development in your local environment, deploy on + [ec2\-spot](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/ec2-spot) – A function that manages spot instance requests in Amazon EC2\. **Topics** -+ [AWS Lambda function handler in C\#](csharp-handler.md) ++ [Lambda function handler in C\#](csharp-handler.md) + [Deploy C\# Lambda functions with \.zip file archives](csharp-package.md) + [Deploy \.NET Lambda functions with container images](csharp-image.md) + [AWS Lambda context object in C\#](csharp-context.md) -+ [AWS Lambda function logging in C\#](csharp-logging.md) ++ [Lambda function logging in C\#](csharp-logging.md) + [AWS Lambda function errors in C\#](csharp-exceptions.md) + [Instrumenting C\# code in AWS Lambda](csharp-tracing.md) \ No newline at end of file diff --git a/doc_source/lambda-edge.md b/doc_source/lambda-edge.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-foundation.md b/doc_source/lambda-foundation.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-functions.md b/doc_source/lambda-functions.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-golang.md b/doc_source/lambda-golang.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-images.md b/doc_source/lambda-images.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-intro-execution-role.md b/doc_source/lambda-intro-execution-role.md old mode 100644 new mode 100755 index 81eac920..6871fb4d --- a/doc_source/lambda-intro-execution-role.md +++ b/doc_source/lambda-intro-execution-role.md @@ -4,7 +4,7 @@ A Lambda function's execution role is an AWS Identity and Access Management \(IA **To view a function's execution role** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -125,17 +125,20 @@ aws iam attach-role-policy --role-name lambda-ex --policy-arn arn:aws:iam::aws:p ## AWS managed policies for Lambda features -The following AWS managed policies provide permissions that are required to use Lambda features: -+ **AWSLambdaBasicExecutionRole** – Permission to upload logs to CloudWatch\. -+ **AWSLambdaDynamoDBExecutionRole** – Permission to read records from an Amazon DynamoDB stream\. -+ **AWSLambdaKinesisExecutionRole** – Permission to read events from an Amazon Kinesis data stream or consumer\. -+ **AWSLambdaMQExecutionRole** – Permission to read records from an Amazon MQ broker\. -+ **AWSLambdaMSKExecutionRole** – Permission to read records from an Amazon Managed Streaming for Apache Kafka \(Amazon MSK\) cluster\. -+ **AWSLambdaSQSQueueExecutionRole** – Permission to read a message from an Amazon Simple Queue Service \(Amazon SQS\) queue\. -+ **AWSLambdaVPCAccessExecutionRole** – Permission to manage elastic network interfaces to connect your function to a virtual private cloud \(VPC\)\. -+ **AWSXRayDaemonWriteAccess** – Permission to upload trace data to X\-Ray\. -+ **CloudWatchLambdaInsightsExecutionRolePolicy** – Permission to write runtime metrics to CloudWatch Lambda Insights\. -+ **AmazonS3ObjectLambdaExecutionRolePolicy** – Permission to interact with Amazon S3 Object Lambda\. +The following AWS managed policies provide permissions that are required to use Lambda features\. + + +| Change | Description | Date | +| --- | --- | --- | +| **[ AWSLambdaBasicExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaBasicExecutionRole` grants permissions to upload logs to CloudWatch\. | February 14, 2022 | +| **[ AWSLambdaDynamoDBExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaDynamoDBExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaDynamoDBExecutionRole` grants permissions to read records from an Amazon DynamoDB stream and write to CloudWatch Logs\. | February 14, 2022 | +| **[ AWSLambdaKinesisExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaKinesisExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaKinesisExecutionRole` grants permissions to read events from an Amazon Kinesis data stream and write to CloudWatch Logs\. | February 14, 2022 | +| **[ AWSLambdaMSKExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaMSKExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaMSKExecutionRole` grants permissions to read and access records from an Amazon Managed Streaming for Apache Kafka \(Amazon MSK\) cluster, manage elastic network interfaces \(ENIs\), and write to CloudWatch Logs\. | February 14, 2022 | +| **[ AWSLambdaSQSQueueExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaSQSQueueExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaSQSQueueExecutionRole` grants permissions to read a message from an Amazon Simple Queue Service \(Amazon SQS\) queue and write to CloudWatch Logs\. | February 14, 2022 | +| **[ AWSLambdaVPCAccessExecutionRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole)** – Lambda started tracking changes to this policy\. | `AWSLambdaVPCAccessExecutionRole` grants permissions to manage ENIs within an Amazon VPC and write to CloudWatch Logs\. | February 14, 2022 | +| **[ AWSXRayDaemonWriteAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSXRayDaemonWriteAccess)** – Lambda started tracking changes to this policy\. | `AWSXRayDaemonWriteAccess` grants permissions to upload trace data to X\-Ray\. | February 14, 2022 | +| **[ CloudWatchLambdaInsightsExecutionRolePolicy](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy)** – Lambda started tracking changes to this policy\. | `CloudWatchLambdaInsightsExecutionRolePolicy` grants permissions to write runtime metrics to CloudWatch Lambda Insights\. | February 14, 2022 | +| **[ AmazonS3ObjectLambdaExecutionRolePolicy](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AmazonS3ObjectLambdaExecutionRolePolicy)** – Lambda started tracking changes to this policy\. | `AmazonS3ObjectLambdaExecutionRolePolicy` grants permissions to interact with Amazon S3 Object Lambda and write to CloudWatch Logs\. | February 14, 2022 | For some features, the Lambda console attempts to add missing permissions to your execution role in a customer managed policy\. These policies can become numerous\. To avoid creating extra policies, add the relevant AWS managed policies to your execution role before enabling features\. @@ -145,8 +148,8 @@ When you use an [event source mapping](invocation-eventsourcemapping.md) to invo + [Amazon DynamoDB](with-ddb.md) + [Amazon Kinesis](with-kinesis.md) + [Amazon MQ](with-mq.md) -+ [Amazon Managed Streaming for Apache Kafka](with-msk.md) -+ [self\-managed Apache Kafka](with-kafka.md) -+ [Amazon Simple Queue Service](with-sqs.md) ++ [Amazon Managed Streaming for Apache Kafka \(Amazon MSK\)](with-msk.md) ++ [Self\-managed Apache Kafka](with-kafka.md) ++ [Amazon Simple Queue Service \(Amazon SQS\)](with-sqs.md) In addition to the AWS managed policies, the Lambda console provides templates for creating a custom policy with permissions for additional use cases\. When you create a function in the Lambda console, you can choose to create a new execution role with permissions from one or more templates\. These templates are also applied automatically when you create a function from a blueprint, or when you configure options that require access to other services\. Example templates are available in this guide's [GitHub repository](https://github.com/awsdocs/aws-lambda-developer-guide/tree/master/iam-policies)\. \ No newline at end of file diff --git a/doc_source/lambda-invocation.md b/doc_source/lambda-invocation.md old mode 100644 new mode 100755 index 9ec12a32..d545ac54 --- a/doc_source/lambda-invocation.md +++ b/doc_source/lambda-invocation.md @@ -1,21 +1,22 @@ -# Invoking AWS Lambda functions +# Invoking Lambda functions -You can invoke Lambda functions directly [with the Lambda console](getting-started-create-function.md#get-started-invoke-manually), the Lambda API, the AWS SDK, the AWS CLI, and AWS toolkits\. You can also configure other AWS services to invoke your function, or you can configure Lambda to read from a stream or queue and invoke your function\. +You can invoke Lambda functions directly [using the Lambda console](getting-started-create-function.md#get-started-invoke-manually), the Lambda API, an AWS SDK, the AWS Command Line Interface \(AWS CLI\), and AWS toolkits\. You can also configure other AWS services to invoke your function, or you can configure Lambda to read from a stream or queue and invoke your function\. When you invoke a function, you can choose to invoke it synchronously or asynchronously\. With [synchronous invocation](invocation-sync.md), you wait for the function to process the event and return a response\. With [asynchronous](invocation-async.md) invocation, Lambda queues the event for processing and returns a response immediately\. For asynchronous invocation, Lambda handles retries and can send invocation records to a [destination](invocation-async.md#invocation-async-destinations)\. -To use your function to process data automatically, add one or more triggers\. A trigger is a Lambda resource or a resource in another service that you configure to invoke your function in response to lifecycle events, external requests, or on a schedule\. Your function can have multiple triggers\. Each trigger acts as a client invoking your function independently\. Each event that Lambda passes to your function only has data from one client or trigger\. +To use your function to process data automatically, add one or more triggers\. A trigger is a Lambda resource or a resource in another service that you configure to invoke your function in response to lifecycle events, external requests, or on a schedule\. Your function can have multiple triggers\. Each trigger acts as a client invoking your function independently\. Each event that Lambda passes to your function has data from only one client or trigger\. -To process items from a stream or queue, you can create an [event source mapping](invocation-eventsourcemapping.md)\. An event source mapping is a resource in Lambda that reads items from an Amazon SQS queue, an Amazon Kinesis stream, or an Amazon DynamoDB stream, and sends them to your function in batches\. Each event that your function processes can contain hundreds or thousands of items\. +To process items from a stream or queue, you can create an [event source mapping](invocation-eventsourcemapping.md)\. An event source mapping is a resource in Lambda that reads items from an Amazon Simple Queue Service \(Amazon SQS\) queue, an Amazon Kinesis stream, or an Amazon DynamoDB stream, and sends them to your function in batches\. Each event that your function processes can contain hundreds or thousands of items\. -Other AWS services and resources invoke your function directly\. For example, you can configure EventBridge \(CloudWatch Events\) to invoke your function on a timer, or you can configure Amazon S3 to invoke your function when an object is created\. Each service varies in the method it uses to invoke your function, the structure of the event, and how you configure it\. For more information, see [Using AWS Lambda with other services](lambda-services.md)\. +Other AWS services and resources invoke your function directly\. For example, you can configure Amazon EventBridge \(CloudWatch Events\) to invoke your function on a timer, or you can configure Amazon Simple Storage Service \(Amazon S3\) to invoke your function when an object is created\. Each service varies in the method that it uses to invoke your function, the structure of the event, and how you configure it\. For more information, see [Using AWS Lambda with other services](lambda-services.md)\. -Depending on who invokes your function and how it's invoked, scaling behavior and the types of errors that occur can vary\. When you invoke a function synchronously, you receive errors in the response and can retry\. When you invoke asynchronously, use an event source mapping, or configure another service to invoke your function, the retry requirements and the way that your function scales to handle large numbers of events can vary\. For details, see [Lambda function scaling](invocation-scaling.md) and [Error handling and automatic retries in AWS Lambda](invocation-retries.md)\. +Depending on who invokes your function and how it's invoked, scaling behavior and the types of errors that occur can vary\. When you invoke a function synchronously, you receive errors in the response and can retry\. When you invoke asynchronously, use an event source mapping, or configure another service to invoke your function, the retry requirements and the way that your function scales to handle large numbers of events can vary\. For more information, see [Lambda function scaling](invocation-scaling.md) and [Error handling and automatic retries in AWS Lambda](invocation-retries.md)\. **Topics** + [Synchronous invocation](invocation-sync.md) + [Asynchronous invocation](invocation-async.md) -+ [AWS Lambda event source mappings](invocation-eventsourcemapping.md) ++ [Lambda event source mappings](invocation-eventsourcemapping.md) ++ [Lambda event filtering](invocation-eventfiltering.md) + [Lambda function states](functions-states.md) + [Error handling and automatic retries in AWS Lambda](invocation-retries.md) + [Using Lambda extensions](using-extensions.md) diff --git a/doc_source/lambda-java.md b/doc_source/lambda-java.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-managing.md b/doc_source/lambda-managing.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-monitoring.md b/doc_source/lambda-monitoring.md old mode 100644 new mode 100755 index e2f9ba06..94bdeada --- a/doc_source/lambda-monitoring.md +++ b/doc_source/lambda-monitoring.md @@ -7,9 +7,9 @@ You can use other AWS services to troubleshoot your Lambda functions\. This sect For more information about monitoring Lambda applications, see [Monitoring and observability](https://docs.aws.amazon.com/lambda/latest/operatorguide/monitoring-observability.html) in the *Lambda operator guide*\. **Topics** -+ [Monitoring functions in the AWS Lambda console](monitoring-functions-access-metrics.md) ++ [Monitoring functions on the Lambda console](monitoring-functions-access-metrics.md) + [Using Lambda Insights in Amazon CloudWatch](monitoring-insights.md) -+ [Working with AWS Lambda function metrics](monitoring-metrics.md) ++ [Working with Lambda function metrics](monitoring-metrics.md) + [Accessing Amazon CloudWatch logs for AWS Lambda](monitoring-cloudwatchlogs.md) + [Using CodeGuru Profiler with your Lambda function](monitoring-code-profiler.md) + [Example workflows using other AWS services](monitoring-servicemap.md) \ No newline at end of file diff --git a/doc_source/lambda-nodejs.md b/doc_source/lambda-nodejs.md old mode 100644 new mode 100755 index 096ad77c..2c167189 --- a/doc_source/lambda-nodejs.md +++ b/doc_source/lambda-nodejs.md @@ -77,7 +77,22 @@ The function runtime passes a context object to the handler, in addition to the Your Lambda function comes with a CloudWatch Logs log group\. The function runtime sends details about each invocation to CloudWatch Logs\. It relays any [logs that your function outputs](nodejs-logging.md) during invocation\. If your function [returns an error](nodejs-exceptions.md), Lambda formats the error and returns it to the invoker\. +## Node\.js initialization + +Node\.js has a unique event loop model that causes its initialization behavior to be different from other runtimes\. Specifically, Node\.js uses a non\-blocking I/O model that supports asynchronous operations\. This model allows Node\.js to perform efficiently for most workloads\. For example, if a Node\.js function makes a network call, that request may be designated as an asynchronous operation and placed into a callback queue\. The function may continue to process other operations within the main call stack without getting blocked by waiting for the network call to return\. Once the network call is returned, its callback is executed and then removed from the callback queue\. + + Some initialization tasks may run asynchronously\. These asynchronous tasks are not guaranteed to complete execution prior to an invocation\. For example, code that makes a network call to fetch a parameter from AWS Parameter Store may not be complete by the time Lambda executes the handler function\. As a result, the variable may be null during an invocation\. To avoid this, ensure that variables and other asynchronous code are fully initialized before continuing with the rest of the function’s core business logic\. + +### Designating a function handler as an ES module + +Starting with Node 14, you can guarantee completion of asynchronous initialization code prior to handler invocations by designating your code as an ES module, and using top\-level await\. Packages are designated as CommonJS modules by default, meaning you must first designate your function code as an ES module to use top\-level await\. You can do this in two ways: specifying the `type` as `module` in the function's `package.json` file, or by using the \.mjs file name extension\. + +In the first scenario, your function code treats all \.js files as ES modules, while in the second scenario, only the file you specify with \.mjs is an ES module\. You can mix ES modules and CommonJS modules by naming them \.mjs and \.cjs respectively, as \.mjs files are always ES modules and \.cjs files are always CommonJS modules\. + +For more information and an example, see [Using Node\.js ES Modules and Top\-Level Await in AWS Lambda](https://aws.amazon.com/blogs/compute/using-node-js-es-modules-and-top-level-await-in-aws-lambda)\. + **Topics** ++ [Node\.js initialization](#nodejs-initialization) + [AWS Lambda function handler in Node\.js](nodejs-handler.md) + [Deploy Node\.js Lambda functions with \.zip file archives](nodejs-package.md) + [Deploy Node\.js Lambda functions with container images](nodejs-image.md) diff --git a/doc_source/lambda-permissions.md b/doc_source/lambda-permissions.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-powershell.md b/doc_source/lambda-powershell.md old mode 100644 new mode 100755 index 9ac3d29e..eee3dc93 --- a/doc_source/lambda-powershell.md +++ b/doc_source/lambda-powershell.md @@ -7,6 +7,7 @@ The following sections explain how common programming patterns and core concepts | Name | Identifier | Operating system | Architectures | | --- | --- | --- | --- | +| \.NET 6 | `dotnet6` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 3\.1 | `dotnetcore3.1` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 2\.1 | `dotnetcore2.1` | Amazon Linux | x86\_64 | diff --git a/doc_source/lambda-python.md b/doc_source/lambda-python.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-releases.md b/doc_source/lambda-releases.md old mode 100644 new mode 100755 index 7e9f089a..de0e7e9c --- a/doc_source/lambda-releases.md +++ b/doc_source/lambda-releases.md @@ -4,6 +4,7 @@ The following table describes the important changes to the *AWS Lambda Developer | Change | Description | Date | | --- |--- |--- | +| [mTLS authentication for Amazon MSK and self\-managed Apache Kafka event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html?icmpid=docs_lambda_rss) | Lambda now supports mTLS authentication for Amazon MSK and self\-managed Apache Kafka event sources\. For details, see [Using Lambda with Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html?icmpid=docs_lambda_rss)\. | November 19, 2021 | | [Lambda on Graviton2](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html?icmpid=docs_lambda_rss) | Lambda now supports Graviton2 for functions using arm64 architecture\. For details, see [Lambda instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html?icmpid=docs_lambda_rss)\. | September 29, 2021 | | [Python 3\.9 runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html?icmpid=docs_lambda_rss) | Lambda now supports a new runtime for Python 3\.9\. For details, see [Lambda runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html?icmpid=docs_lambda_rss)\. | August 16, 2021 | | [New runtime versions for Node\.js, Python, and Java](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html?icmpid=docs_lambda_rss) | New runtime versions are available for Node\.js, Python, and Java\. For details, see [Lambda runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html?icmpid=docs_lambda_rss)\. | July 21, 2021 | @@ -56,7 +57,7 @@ The following table describes the important changes to the *AWS Lambda Developer | [Python 3\.7](https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html?icmpid=docs_lambda_rss) | AWS Lambda now supports Python 3\.7 with a new runtime\. For more information, see [Building Lambda functions with Python](https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html?icmpid=docs_lambda_rss)\. | November 19, 2018 | | [Payload limit increase for asynchronous function invocation](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html?icmpid=docs_lambda_rss) | The maximum payload size for asynchronous invocations increased from 128 KB to 256 KB, which matches the maximum message size from an Amazon SNS trigger\. For details, see [Lambda quotas](https://docs.aws.amazon.com/lambda/latest/dg/limits.html?icmpid=docs_lambda_rss)\. | November 16, 2018 | | [AWS GovCloud \(US\-East\) Region](https://docs.aws.amazon.com/lambda/latest/dg/lambda-releases.html?icmpid=docs_lambda_rss) | AWS Lambda is now available in the AWS GovCloud \(US\-East\) Region\. | November 12, 2018 | -| [Moved AWS SAM topics to a separate Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/?icmpid=docs_lambda_rss) | A number of topics were focused on building serverless applications using the AWS Serverless Application Model \(AWS SAM\)\. These topics have been moved to [ AWS Serverless Application Model developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. | October 25, 2018 | +| [Moved AWS SAM topics to a separate Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/?icmpid=docs_lambda_rss) | A number of topics were focused on building serverless applications using the AWS Serverless Application Model \(AWS SAM\)\. These topics have been moved to [AWS Serverless Application Model developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. | October 25, 2018 | | [View Lambda applications in the console](https://docs.aws.amazon.com/lambda/latest/dg/applications-console.html?icmpid=docs_lambda_rss) | You can view the status of your Lambda applications on the [Applications](https://docs.aws.amazon.com/lambda/latest/dg/applications-console.html?icmpid=docs_lambda_rss) page in the Lambda console\. This page shows the status of the AWS CloudFormation stack\. It includes links to pages where you can view more information about the resources in the stack\. You can also view aggregate metrics for the application and create custom monitoring dashboards\. | October 11, 2018 | | [Function execution timeout limit](https://docs.aws.amazon.com/lambda/latest/dg/limits.html?icmpid=docs_lambda_rss) | To allow for long\-running functions, the maximum configurable execution timeout increased from 5 minutes to 15 minutes\. For details, see [Lambda limits](https://docs.aws.amazon.com/lambda/latest/dg/limits.html?icmpid=docs_lambda_rss)\. | October 10, 2018 | | [Support for PowerShell Core language in AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/powershell-programming-model.html?icmpid=docs_lambda_rss) | AWS Lambda now supports the PowerShell Core language\. For more information, see [Programming model for authoring Lambda functions in PowerShell](https://docs.aws.amazon.com/lambda/latest/dg/powershell-programming-model.html?icmpid=docs_lambda_rss)\. | September 11, 2018 | diff --git a/doc_source/lambda-rolling-deployments.md b/doc_source/lambda-rolling-deployments.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-ruby.md b/doc_source/lambda-ruby.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-runtimes.md b/doc_source/lambda-runtimes.md old mode 100644 new mode 100755 index ad4c92be..2b7980e6 --- a/doc_source/lambda-runtimes.md +++ b/doc_source/lambda-runtimes.md @@ -77,6 +77,7 @@ Runtimes that use the Amazon Linux operating system, such as Go 1\.x, do not sup | Name | Identifier | Operating system | Architectures | | --- | --- | --- | --- | +| \.NET 6 | `dotnet6` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 3\.1 | `dotnetcore3.1` | Amazon Linux 2 | x86\_64, arm64 | | \.NET Core 2\.1 | `dotnetcore2.1` | Amazon Linux | x86\_64 | diff --git a/doc_source/lambda-samples.md b/doc_source/lambda-samples.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-security.md b/doc_source/lambda-security.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-services.md b/doc_source/lambda-services.md old mode 100644 new mode 100755 index 1b101428..a69e0a4b --- a/doc_source/lambda-services.md +++ b/doc_source/lambda-services.md @@ -3,7 +3,7 @@ AWS Lambda integrates with other AWS services to invoke functions or take other actions\. These are some common use cases: + Invoke a function in response to resource lifecycle events, such as with Amazon Simple Storage Service \(Amazon S3\)\. For more information, see [Using AWS Lambda with Amazon S3](with-s3.md)\. + Respond to incoming HTTP requests\. For more information, see [Tutorial: Using Lambda with API Gateway](services-apigateway-tutorial.md)\. -+ Consume events from a queue\. For more information, see [Using AWS Lambda with Amazon SQS](with-sqs.md)\. ++ Consume events from a queue\. For more information, see [Using Lambda with Amazon SQS](with-sqs.md)\. + Run a function on a schedule\. For more information, see [Using AWS Lambda with Amazon EventBridge \(CloudWatch Events\)](services-cloudwatchevents.md)\. Depending on which service you're using with Lambda, the invocation generally works in one of two ways\. An event drives the invocation or Lambda polls a queue or data stream and invokes the function in response to activity in the queue or data stream\. Lambda integrates with Amazon Elastic File System and AWS X\-Ray in a way that doesn't involve invoking functions\. diff --git a/doc_source/lambda-settingup.md b/doc_source/lambda-settingup.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-stepfunctions.md b/doc_source/lambda-stepfunctions.md old mode 100644 new mode 100755 diff --git a/doc_source/lambda-troubleshooting.md b/doc_source/lambda-troubleshooting.md old mode 100644 new mode 100755 diff --git a/doc_source/logging-using-cloudtrail.md b/doc_source/logging-using-cloudtrail.md old mode 100644 new mode 100755 index 4a104587..526ce6c7 --- a/doc_source/logging-using-cloudtrail.md +++ b/doc_source/logging-using-cloudtrail.md @@ -1,14 +1,14 @@ -# Logging AWS Lambda API calls with AWS CloudTrail +# Logging Lambda API calls with CloudTrail -AWS Lambda is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in AWS Lambda\. CloudTrail captures API calls for AWS Lambda as events\. The calls captured include calls from the AWS Lambda console and code calls to the AWS Lambda API operations\. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for AWS Lambda\. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. Using the information collected by CloudTrail, you can determine the request that was made to AWS Lambda, the IP address from which the request was made, who made the request, when it was made, and additional details\. +Lambda is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Lambda\. CloudTrail captures API calls for Lambda as events\. The calls captured include calls from the Lambda console and code calls to the Lambda API operations\. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service \(Amazon S3\) bucket, including events for Lambda\. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. Using the information collected by CloudTrail, you can determine the request that was made to Lambda, the IP address from which the request was made, who made the request, when it was made, and additional details\. -To learn more about CloudTrail, including how to configure and enable it, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. +For more information about CloudTrail, including how to configure and enable it, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. -## AWS Lambda information in CloudTrail +## Lambda information in CloudTrail -CloudTrail is enabled on your AWS account when you create the account\. When supported event activity occurs in AWS Lambda, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**\. You can view, search, and download recent events in your AWS account\. For more information, see [Viewing events with CloudTrail event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*\. +CloudTrail is enabled on your AWS account when you create the account\. When supported event activity occurs in Lambda, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**\. You can view, search, and download recent events in your AWS account\. For more information, see [Viewing events with CloudTrail event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*\. -For an ongoing record of events in your AWS account, including events for AWS Lambda, you create a trail\. A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket\. By default, when you create a trail in the console, the trail applies to all AWS Regions\. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify\. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. +For an ongoing record of events in your AWS account, including events for Lambda, you create a *trail*\. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket\. By default, when you create a trail in the console, the trail applies to all AWS Regions\. The trail logs events from all Regions in the AWS partition and delivers the log files to the S3 bucket that you specify\. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. For more information, see the following topics in the *AWS CloudTrail User Guide*: + [Overview for creating a trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) @@ -16,13 +16,13 @@ For more information, see the following topics in the *AWS CloudTrail User Guide + [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html) + [Receiving CloudTrail log files from multiple regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail log files from multiple accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html) -Every log entry contains information about who generated the request\. The user identity information in the log helps you determine whether the request was made with root or IAM user credentials, with temporary security credentials for a role or federated user, or by another AWS service\. For more information, see the **userIdentity** field in the [CloudTrail event reference](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference.html)\. +Every log entry contains information about who generated the request\. The user identity information in the log helps you determine whether the request was made with root or AWS Identity and Access Management \(IAM\) user credentials, with temporary security credentials for a role or federated user, or by another AWS service\. For more information, see the **userIdentity** field in the [CloudTrail event reference](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference.html)\. You can store your log files in your bucket for as long as you want, but you can also define Amazon S3 lifecycle rules to archive or delete log files automatically\. By default, your log files are encrypted by using Amazon S3 server\-side encryption \(SSE\)\. -You can choose to have CloudTrail publish Amazon SNS notifications when new log files are delivered if you want to take quick action upon log file delivery\. For more information, see [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/configure-sns-notifications-for-cloudtrail.html)\. +You can choose to have CloudTrail publish Amazon Simple Notification Service \(Amazon SNS\) notifications when new log files are delivered if you want to take quick action upon log file delivery\. For more information, see [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/configure-sns-notifications-for-cloudtrail.html)\. -You can also aggregate AWS Lambda log files from multiple AWS regions and multiple AWS accounts into a single S3 bucket\. For more information, see [Working with CloudTrail log files](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-working-with-log-files.html)\. +You can also aggregate Lambda log files from multiple Regions and multiple AWS accounts into a single S3 bucket\. For more information, see [Working with CloudTrail log files](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-working-with-log-files.html)\. ### List of supported Lambda API actions @@ -52,7 +52,7 @@ In the CloudTrail log file, the `eventName` might include date and version infor \(The `ZipFile` parameter is omitted from the CloudTrail logs for `UpdateFunctionCode`\.\) + [UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md) -## Understanding AWS Lambda log file entries +## Understanding Lambda log file entries CloudTrail log files contain one or more log entries where each entry is made up of multiple JSON\-formatted events\. A log entry represents a single request from any source and includes information about the requested action, any parameters, the date and time of the action, and so on\. The log entries are not guaranteed to be in any particular order\. That is, they are not an ordered stack trace of the public API calls\. @@ -120,7 +120,7 @@ The `eventName` might include date and version information, such as `"GetFunctio ## Using CloudTrail to track function invocations -CloudTrail also logs data events\. You can turn on data event logging so that you log an event every time Lambda functions are invoked\. This helps you understand what identities are invoking the functions and the frequency of their invocations\. For more information on this option, see [ Logging data events for trails](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html)\. +CloudTrail also logs data events\. You can turn on data event logging so that you log an event every time Lambda functions are invoked\. This helps you understand what identities are invoking the functions and the frequency of their invocations\. For more information on this option, see [Logging data events for trails](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html)\. **Note** CloudTrail logs only authenticated and authorized requests\. CloudTrail does not log requests that fail authentication \(credentials are missing or the provided credentials are not valid\) or requests with credentials that are not authorized to invoke the function\. diff --git a/doc_source/monitoring-cloudwatchlogs.md b/doc_source/monitoring-cloudwatchlogs.md old mode 100644 new mode 100755 index 7134c54a..df53ca0f --- a/doc_source/monitoring-cloudwatchlogs.md +++ b/doc_source/monitoring-cloudwatchlogs.md @@ -32,18 +32,13 @@ There is no additional charge for using Lambda logs; however, standard CloudWatc ## Using the Lambda console -The following section describes how to view logs for your function on the Lambda console\. - **To view logs using the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. -1. Choose **Monitor**\. -![\[Events\]](http://docs.aws.amazon.com/lambda/latest/dg/images/metrics-functions-list.png)![\[Events\]](http://docs.aws.amazon.com/lambda/latest/dg/)![\[Events\]](http://docs.aws.amazon.com/lambda/latest/dg/) - - A graphical representation of the metrics for the Lambda function are shown\. +1. Choose **Monitor**\. 1. Choose **View logs in CloudWatch**\. @@ -55,7 +50,7 @@ To debug and validate that your code is working as expected, you can output logs + [AWS Lambda function logging in Ruby](ruby-logging.md) + [AWS Lambda function logging in Java](java-logging.md) + [AWS Lambda function logging in Go](golang-logging.md) -+ [AWS Lambda function logging in C\#](csharp-logging.md) ++ [Lambda function logging in C\#](csharp-logging.md) + [AWS Lambda function logging in PowerShell](powershell-logging.md) ## What's next? diff --git a/doc_source/monitoring-code-profiler.md b/doc_source/monitoring-code-profiler.md old mode 100644 new mode 100755 index fe2f6951..e0409175 --- a/doc_source/monitoring-code-profiler.md +++ b/doc_source/monitoring-code-profiler.md @@ -10,7 +10,7 @@ You can use Amazon CodeGuru Profiler to gain insights into runtime performance o ## Supported runtimes -You can activate CodeGuru Profiler from the Lambda console if your function's runtime is Python 3\.8, Java 8 with Amazon Linux 2, or Java 11\. For additional runtime versions, you can activate CodeGuru Profiler manually\. +You can activate CodeGuru Profiler from the Lambda console if your function's runtime is Python3\.8, Python3\.9, Java 8 with Amazon Linux 2, or Java 11\. For additional runtime versions, you can activate CodeGuru Profiler manually\. + For Java runtimes, see [ Profiling your Java applications that run on AWS Lambda](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html)\. + For Python runtimes, see [ Profiling your Python applications that run on AWS Lambda](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/python-lambda.html)\. @@ -20,7 +20,7 @@ This section describes how to activate CodeGuru Profiler from the Lambda console **To activate CodeGuru Profiler from the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose your function\. diff --git a/doc_source/monitoring-functions-access-metrics.md b/doc_source/monitoring-functions-access-metrics.md old mode 100644 new mode 100755 index 015532fb..69ecea60 --- a/doc_source/monitoring-functions-access-metrics.md +++ b/doc_source/monitoring-functions-access-metrics.md @@ -1,6 +1,6 @@ -# Monitoring functions in the AWS Lambda console +# Monitoring functions on the Lambda console -AWS Lambda monitors functions on your behalf and sends metrics to Amazon CloudWatch\. The Lambda console creates monitoring graphs for these metrics and shows them on the **Monitoring** page for each Lambda function\. +Lambda monitors functions on your behalf and sends metrics to Amazon CloudWatch\. The Lambda console creates monitoring graphs for these metrics and shows them on the **Monitoring** page for each Lambda function\. This page describes the basics of using the Lambda console to view function metrics, including total requests, duration, and error rates\. @@ -10,15 +10,15 @@ CloudWatch has a perpetual free tier\. Beyond the free tier threshold, CloudWatc ## Using the Lambda console -You can use the Lambda console's monitoring dashboard to monitor your Lambda functions and applications\. +You can monitor your Lambda functions and applications on the Lambda console\. **To monitor a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. -1. Choose **Monitoring**\. +1. Choose the **Monitor** tab\. ## Types of monitoring graphs @@ -26,9 +26,9 @@ The following section describes the monitoring graphs on the Lambda console\. **Lambda monitoring graphs** + **Invocations** – The number of times that the function was invoked\. -+ **Duration** – The average, minimum, and maximum execution times\. -+ **Error count and success rate \(%\)** – The number of errors and the percentage of executions that completed without error\. -+ **Throttles** – The number of times that execution failed due to concurrency limits\. ++ **Duration** – The average, minimum, and maximum amount of time your function code spends processing an event\. ++ **Error count and success rate \(%\)** – The number of errors and the percentage of invocations that completed without error\. ++ **Throttles** – The number of times that an invocation failed due to concurrency limits\. + **IteratorAge** – For stream event sources, the age of the last item in the batch when Lambda received it and invoked the function\. + **Async delivery failures** – The number of errors that occurred when Lambda attempted to write to a destination or dead\-letter queue\. + **Concurrent executions** – The number of function instances that are processing events\. @@ -39,29 +39,29 @@ The following section describes how to view CloudWatch monitoring graphs on the **To view monitoring graphs for a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. -1. Choose **Monitoring**\. +1. Choose the **Monitor** tab\. -1. Choose from the predefined time ranges, or choose a custom time range\. +1. On the **Metrics**, **Logs**, or **Traces** tab, choose from the predefined time ranges, or choose a custom time range\. -1. To see the definition of a graph in CloudWatch, choose the three vertical dots, and then choose **View in metrics** to open the **Metrics** dashboard in CloudWatch\. +1. To see the definition of a graph in CloudWatch, choose the three vertical dots \(**Widget actions**\), and then choose **View in metrics** to open the **Metrics** dashboard on the CloudWatch console\. ![\[An example monitoring definition on the Lambda console.\]](http://docs.aws.amazon.com/lambda/latest/dg/images/console-monitoring-definition.png) -## Viewing queries in the CloudWatch Logs console +## Viewing queries on the CloudWatch Logs console The following section describes how to view and add reports from CloudWatch Logs Insights to a custom dashboard on the CloudWatch Logs console\. **To view reports for a function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. -1. Choose **Monitoring**\. +1. Choose the **Monitor** tab\. 1. Choose **View logs in CloudWatch**\. @@ -76,5 +76,5 @@ The following section describes how to view and add reports from CloudWatch Logs ![\[The CloudWatch Logs Insights reports on the CloudWatch dashboard.\]](http://docs.aws.amazon.com/lambda/latest/dg/images/console-monitoring-insights.png) ## What's next? -+ Learn about the metrics that Lambda records and sends to CloudWatch in [Working with AWS Lambda function metrics](monitoring-metrics.md)\. -+ Learn how to use Lambda Insights to collect and aggregate Lambda function runtime performance metrics and logs in [Using Lambda Insights in Amazon CloudWatch](monitoring-insights.md)\. \ No newline at end of file ++ Learn about the metrics that Lambda records and sends to CloudWatch in [Working with Lambda function metrics](monitoring-metrics.md)\. ++ Learn how to use CloudWatch Lambda Insights to collect and aggregate Lambda function runtime performance metrics and logs in [Using Lambda Insights in Amazon CloudWatch](monitoring-insights.md)\. \ No newline at end of file diff --git a/doc_source/monitoring-insights.md b/doc_source/monitoring-insights.md old mode 100644 new mode 100755 index 250d5255..ee06278c --- a/doc_source/monitoring-insights.md +++ b/doc_source/monitoring-insights.md @@ -35,7 +35,7 @@ You can enable Lambda Insights enhanced monitoring on new and existing Lambda fu **To enable Lambda Insights in the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose your function\. diff --git a/doc_source/monitoring-metrics.md b/doc_source/monitoring-metrics.md old mode 100644 new mode 100755 index d0d94b1a..9a953755 --- a/doc_source/monitoring-metrics.md +++ b/doc_source/monitoring-metrics.md @@ -1,20 +1,20 @@ -# Working with AWS Lambda function metrics +# Working with Lambda function metrics -When your function finishes processing an event, Lambda sends metrics about the invocation to Amazon CloudWatch\. You can build graphs and dashboards with these metrics in the CloudWatch console, and set alarms to respond to changes in utilization, performance, or error rates\. Lambda sends metric data to CloudWatch in 1\-minute intervals\. +When your Lambda function finishes processing an event, Lambda sends metrics about the invocation to Amazon CloudWatch\. You can build graphs and dashboards with these metrics on the CloudWatch console, and set alarms to respond to changes in utilization, performance, or error rates\. Lambda sends metric data to CloudWatch in 1\-minute intervals\. This page describes the Lambda function invocation, performance, and concurrency metrics available on the CloudWatch console\. **Topics** -+ [Viewing metrics in the CloudWatch console](#monitoring-metrics-console) ++ [Viewing metrics on the CloudWatch console](#monitoring-metrics-console) + [Types of metrics](#monitoring-metrics-types) -## Viewing metrics in the CloudWatch console +## Viewing metrics on the CloudWatch console You can use the CloudWatch console to filter and sort function metrics by function name, alias, or version\. -**To view metrics in the CloudWatch console** +**To view metrics on the CloudWatch console** -1. Open the [Metrics page](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#metricsV2:graph=~();namespace=~'AWS*2fLambda) \(`AWS/Lambda` namespace\) on the CloudWatch console\. +1. Open the [Metrics page](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#metricsV2:graph=~();namespace=~'AWS*2fLambda) \(`AWS/Lambda` namespace\) of the CloudWatch console\. 1. Choose a dimension\. + **By Function Name** \(`FunctionName`\) – View aggregate metrics for all versions and aliases of a function\. @@ -27,28 +27,28 @@ You can use the CloudWatch console to filter and sort function metrics by functi By default, graphs use the `Sum` statistic for all metrics\. To choose a different statistic and customize the graph, use the options on the **Graphed metrics** tab\. **Note** -The timestamp on a metric reflects when the function was invoked\. Depending on the duration of the execution, this can be several minutes before the metric is emitted\. If, for example, your function has a 10\-minute timeout, look more than 10 minutes in the past for accurate metrics\. +The timestamp on a metric reflects when the function was invoked\. Depending on the duration of the invocation, this can be several minutes before the metric is emitted\. For example, if your function has a 10\-minute timeout, look more than 10 minutes in the past for accurate metrics\. For more information about CloudWatch, see the [https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/)\. ## Types of metrics -The following section describes the type of metrics available on the CloudWatch console\. +The following section describes the types of metrics available on the CloudWatch console\. ### Using invocation metrics -Invocation metrics are binary indicators of the outcome of an invocation\. For example, if the function returns an error, Lambda sends the `Errors` metric with a value of 1\. To get a count of the number of function errors that occurred each minute, view the `Sum` of the `Errors` metric with a period of one minute\. +Invocation metrics are binary indicators of the outcome of an invocation\. For example, if the function returns an error, Lambda sends the `Errors` metric with a value of 1\. To get a count of the number of function errors that occurred each minute, view the `Sum` of the `Errors` metric with a period of 1 minute\. -You should view the following metrics with the `Sum` statistic\. +View the following metrics with the `Sum` statistic\. **Invocation metrics** -+ `Invocations` – The number of times your function code is executed, including successful executions and executions that result in a function error\. Invocations aren't recorded if the invocation request is throttled or otherwise resulted in an invocation error\. This equals the number of requests billed\. -+ `Errors` – The number of invocations that result in a function error\. Function errors include exceptions thrown by your code and exceptions thrown by the Lambda runtime\. The runtime returns errors for issues such as timeouts and configuration errors\. To calculate the error rate, divide the value of `Errors` by the value of `Invocations`\. Note that the timestamp on an error metric reflects when the function was invoked, not when the error occurred\. -+ `DeadLetterErrors` – For [asynchronous invocation](invocation-async.md), the number of times Lambda attempts to send an event to a dead\-letter queue but fails\. Dead\-letter errors can occur due to permissions errors, misconfigured resources, or size limits\. -+ `DestinationDeliveryFailures` – For asynchronous invocation, the number of times Lambda attempts to send an event to a [destination](gettingstarted-features.md#gettingstarted-features-destinations) but fails\. Delivery errors can occur due to permissions errors, misconfigured resources, or size limits\. -+ `Throttles` – The number of invocation requests that are throttled\. When all function instances are processing requests and no concurrency is available to scale up, Lambda rejects additional requests with `TooManyRequestsException`\. Throttled requests and other invocation errors don't count as `Invocations` or `Errors`\. -+ `ProvisionedConcurrencyInvocations` – The number of times your function code is executed on [provisioned concurrency](configuration-concurrency.md)\. -+ `ProvisionedConcurrencySpilloverInvocations` – The number of times your function code is executed on standard concurrency when all provisioned concurrency is in use\. ++ `Invocations` – The number of times that your function code is invoked, including successful invocations and invocations that result in a function error\. Invocations aren't recorded if the invocation request is throttled or otherwise results in an invocation error\. This equals the number of requests billed\. ++ `Errors` – The number of invocations that result in a function error\. Function errors include exceptions that your code throws and exceptions that the Lambda runtime throws\. The runtime returns errors for issues such as timeouts and configuration errors\. To calculate the error rate, divide the value of `Errors` by the value of `Invocations`\. Note that the timestamp on an error metric reflects when the function was invoked, not when the error occurred\. ++ `DeadLetterErrors` – For [asynchronous invocation](invocation-async.md), the number of times that Lambda attempts to send an event to a dead\-letter queue but fails\. Dead\-letter errors can occur due to permissions errors, misconfigured resources, or size limits\. ++ `DestinationDeliveryFailures` – For asynchronous invocation, the number of times that Lambda attempts to send an event to a [destination](gettingstarted-features.md#gettingstarted-features-destinations) but fails\. Delivery errors can occur due to permissions errors, misconfigured resources, or size limits\. ++ `Throttles` – The number of invocation requests that are throttled\. When all function instances are processing requests and no concurrency is available to scale up, Lambda rejects additional requests with a `TooManyRequestsException` error\. Throttled requests and other invocation errors don't count as `Invocations` or `Errors`\. ++ `ProvisionedConcurrencyInvocations` – The number of times that your function code is invoked on [provisioned concurrency](configuration-concurrency.md)\. ++ `ProvisionedConcurrencySpilloverInvocations` – The number of times that your function code is invoked on standard concurrency when all provisioned concurrency is in use\. ### Using performance metrics @@ -57,16 +57,17 @@ Performance metrics provide performance details about a single invocation\. For **Performance metrics** + `Duration` – The amount of time that your function code spends processing an event\. The billed duration for an invocation is the value of `Duration` rounded up to the nearest millisecond\. + `PostRuntimeExtensionsDuration` – The cumulative amount of time that the runtime spends running code for extensions after the function code has completed\. -+ `IteratorAge` – For [event source mappings](invocation-eventsourcemapping.md) that read from streams, the age of the last record in the event\. The age is the amount of time between when the stream receives the record and when the event source mapping sends the event to the function\. ++ `IteratorAge` – For [event source mappings](invocation-eventsourcemapping.md) that read from streams, the age of the last record in the event\. The age is the amount of time between when a stream receives the record and when the event source mapping sends the event to the function\. ++ `OffsetLag` – For self\-managed Apache Kafka and Amazon Managed Streaming for Apache Kafka \(Amazon MSK\) event sources, the difference in offset between the last record written to a topic and the last record that your Lambda function processed\. Though a Kafka topic can have multiple partitions, this metric measures the offset lag at the topic level\. -`Duration` also supports [percentile statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Percentiles)\. Use percentiles to exclude outlier values that skew average and maximum statistics\. For example, the P95 statistic shows the maximum duration of 95 percent of executions, excluding the slowest 5 percent\. +`Duration` also supports [percentile statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Percentiles)\. Use percentiles to exclude outlier values that skew average and maximum statistics\. For example, the p95 statistic shows the maximum duration of 95 percent of invocations, excluding the slowest 5 percent\. ### Using concurrency metrics Lambda reports concurrency metrics as an aggregate count of the number of instances processing events across a function, version, alias, or AWS Region\. To see how close you are to hitting concurrency limits, view these metrics with the `Max` statistic\. **Concurrency metrics** -+ `ConcurrentExecutions` – The number of function instances that are processing events\. If this number reaches your [concurrent executions quota](gettingstarted-limits.md) for the Region, or the [reserved concurrency limit](configuration-concurrency.md) that you configured on the function, additional invocation requests are throttled\. ++ `ConcurrentExecutions` – The number of function instances that are processing events\. If this number reaches your [concurrent executions quota](gettingstarted-limits.md) for the Region, or the [reserved concurrency limit](configuration-concurrency.md) that you configured on the function, Lambda throttles additional invocation requests\. + `ProvisionedConcurrentExecutions` – The number of function instances that are processing events on [provisioned concurrency](configuration-concurrency.md)\. For each invocation of an alias or version with provisioned concurrency, Lambda emits the current count\. + `ProvisionedConcurrencyUtilization` – For a version or alias, the value of `ProvisionedConcurrentExecutions` divided by the total amount of provisioned concurrency allocated\. For example, `.5` indicates that 50 percent of allocated provisioned concurrency is in use\. -+ `UnreservedConcurrentExecutions` – For an AWS Region, the number of events that are being processed by functions that don't have reserved concurrency\. \ No newline at end of file ++ `UnreservedConcurrentExecutions` – For a Region, the number of events that functions without reserved concurrency are processing\. \ No newline at end of file diff --git a/doc_source/monitoring-servicemap.md b/doc_source/monitoring-servicemap.md old mode 100644 new mode 100755 index efa356d5..a757edae --- a/doc_source/monitoring-servicemap.md +++ b/doc_source/monitoring-servicemap.md @@ -20,7 +20,7 @@ AWS X\-Ray needs to be enabled on the Lambda console to complete the AWS X\-Ray **To enable AWS X\-Ray on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose your function\. @@ -52,7 +52,7 @@ You can choose a node to see detailed insights about the correlated metrics, log **To view service map and traces using the CloudWatch console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/nodejs-context.md b/doc_source/nodejs-context.md old mode 100644 new mode 100755 diff --git a/doc_source/nodejs-exceptions.md b/doc_source/nodejs-exceptions.md old mode 100644 new mode 100755 index 3a33a915..e1545e48 --- a/doc_source/nodejs-exceptions.md +++ b/doc_source/nodejs-exceptions.md @@ -64,7 +64,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -97,7 +97,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/nodejs-handler.md b/doc_source/nodejs-handler.md old mode 100644 new mode 100755 index 541044fd..24bba014 --- a/doc_source/nodejs-handler.md +++ b/doc_source/nodejs-handler.md @@ -62,6 +62,14 @@ exports.handler = async function(event) { } ``` +### Using Node\.js modules and top\-level await + +You can designate your function code as an ES module, allowing you to use `await` at the top level of the file, outside the scope of your function handler\. This guarantees completion of asynchronous initialization code prior to handler invocations, maximizing the effectiveness of [provisioned concurrency](provisioned-concurrency.md) in reducing cold start latency\. You can do this in two ways: specifying the `type` as `module` in the function's `package.json` file, or by using the \.mjs file name extension\. + +In the first scenario, your function code treats all \.js files as ES modules, while in the second scenario, only the file you specify with \.mjs is an ES module\. You can mix ES modules and CommonJS modules by naming them \.mjs and \.cjs respectively, as \.mjs files are always ES modules and \.cjs files are always CommonJS modules\. + +For more information and an example, see [Using Node\.js ES Modules and Top\-Level Await in AWS Lambda](https://aws.amazon.com/blogs/compute/using-node-js-es-modules-and-top-level-await-in-aws-lambda)\. + ## Non\-async handlers The following example function checks a URL and returns the status code to the invoker\. diff --git a/doc_source/nodejs-image.md b/doc_source/nodejs-image.md old mode 100644 new mode 100755 index f6ed4c67..48ce65af --- a/doc_source/nodejs-image.md +++ b/doc_source/nodejs-image.md @@ -5,7 +5,7 @@ You can deploy your Lambda function code as a [container image](images-create.md These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. @@ -36,6 +36,7 @@ AWS provides the following base images for Node\.js: | --- | --- | --- | --- | | 14 | NodeJS 14\.x | Amazon Linux 2 | [Dockerfile for Node\.js 14\.x on GitHub](https://github.com/aws/aws-lambda-base-images/blob/nodejs14.x/Dockerfile.nodejs14.x) | | 12 | NodeJS 12\.x | Amazon Linux 2 | [Dockerfile for Node\.js 12\.x on GitHub](https://github.com/aws/aws-lambda-base-images/blob/nodejs12.x/Dockerfile.nodejs12.x) | +| 10 | NodeJS 10\.x | Amazon Linux 2 | [Dockerfile for Node\.js 10\.x on GitHub](https://github.com/aws/aws-lambda-base-images/blob/nodejs10.x/Dockerfile.nodejs10.x) | Docker Hub repository: amazon/aws\-lambda\-nodejs @@ -61,4 +62,4 @@ You can also download the [Node\.js runtime interface client](https://github.com ## Deploy the container image -For a new function, you deploy the Node\.js image when you [create the function](configuration-images.md#configuration-images-create)\. For an existing function, if you rebuild the container image, you need to redeploy the image by [updating the function code](configuration-images.md#configuration-images-update)\. +For a new function, you deploy the Node\.js image when you [create the function](configuration-images.md#configuration-images-create)\. For an existing function, if you rebuild the container image, you need to redeploy the image by [updating the function code](configuration-images.md#configuration-images-update)\. \ No newline at end of file diff --git a/doc_source/nodejs-logging.md b/doc_source/nodejs-logging.md old mode 100644 new mode 100755 index d3e16881..41bb4637 --- a/doc_source/nodejs-logging.md +++ b/doc_source/nodejs-logging.md @@ -129,7 +129,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/nodejs-package.md b/doc_source/nodejs-package.md old mode 100644 new mode 100755 diff --git a/doc_source/nodejs-tracing.md b/doc_source/nodejs-tracing.md old mode 100644 new mode 100755 index 5ee8eef0..65896465 --- a/doc_source/nodejs-tracing.md +++ b/doc_source/nodejs-tracing.md @@ -10,7 +10,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/permissions-boundary.md b/doc_source/permissions-boundary.md old mode 100644 new mode 100755 diff --git a/doc_source/powershell-context.md b/doc_source/powershell-context.md old mode 100644 new mode 100755 diff --git a/doc_source/powershell-devenv.md b/doc_source/powershell-devenv.md old mode 100644 new mode 100755 diff --git a/doc_source/powershell-exceptions.md b/doc_source/powershell-exceptions.md old mode 100644 new mode 100755 index 09ee08eb..00fb56d4 --- a/doc_source/powershell-exceptions.md +++ b/doc_source/powershell-exceptions.md @@ -88,7 +88,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -121,7 +121,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/powershell-handler.md b/doc_source/powershell-handler.md old mode 100644 new mode 100755 index 8b640b5a..819a900c --- a/doc_source/powershell-handler.md +++ b/doc_source/powershell-handler.md @@ -17,7 +17,7 @@ This script returns the FunctionName property that's obtained from the $LambdaCo **Note** You're required to use the `#Requires` statement within your PowerShell scripts to indicate the modules that your scripts depend on\. This statement performs two important tasks\. 1\) It communicates to other developers which modules the script uses, and 2\) it identifies the dependent modules that AWS PowerShell tools need to package with the script, as part of the deployment\. For more information about the `#Requires` statement in PowerShell, see [ About requires](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_requires?view=powershell-6)\. For more information about PowerShell deployment packages, see [Deploy PowerShell Lambda functions with \.zip file archives](powershell-package.md)\. -When your PowerShell Lambda function uses the AWS PowerShell cmdlets, be sure to set a `#Requires` statement that references the `AWSPowerShell.NetCore` module, which supports PowerShell Core—and not the `AWSPowerShell` module, which only supports Windows PowerShell\. Also, be sure to use version 3\.3\.270\.0 or newer of `AWSPowerShell.NetCore` which optimizes the cmdlet import process\. If you use an older version, you'll experience longer cold starts\. For more information, see [ AWS Tools for PowerShell](http://aws.amazon.com/powershell/?track=sdk)\. +When your PowerShell Lambda function uses the AWS PowerShell cmdlets, be sure to set a `#Requires` statement that references the `AWSPowerShell.NetCore` module, which supports PowerShell Core—and not the `AWSPowerShell` module, which only supports Windows PowerShell\. Also, be sure to use version 3\.3\.270\.0 or newer of `AWSPowerShell.NetCore` which optimizes the cmdlet import process\. If you use an older version, you'll experience longer cold starts\. For more information, see [AWS Tools for PowerShell](http://aws.amazon.com/powershell/?track=sdk)\. ## Returning data diff --git a/doc_source/powershell-logging.md b/doc_source/powershell-logging.md old mode 100644 new mode 100755 index 9043989d..f2bb52f6 --- a/doc_source/powershell-logging.md +++ b/doc_source/powershell-logging.md @@ -139,7 +139,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/powershell-package.md b/doc_source/powershell-package.md old mode 100644 new mode 100755 diff --git a/doc_source/provisioned-concurrency.md b/doc_source/provisioned-concurrency.md old mode 100644 new mode 100755 index 280429ed..da53abaf --- a/doc_source/provisioned-concurrency.md +++ b/doc_source/provisioned-concurrency.md @@ -33,7 +33,7 @@ To manage provisioned concurrency settings for a version or alias, use the Lambd **To allocate provisioned concurrency for an alias or version** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -105,7 +105,7 @@ Lambda emits the following metrics for provisioned concurrency: + `ProvisionedConcurrencySpilloverInvocations` – The number of times your function code is executed on standard concurrency when all provisioned concurrency is in use\. + `ProvisionedConcurrencyUtilization` – For a version or alias, the value of `ProvisionedConcurrentExecutions` divided by the total amount of provisioned concurrency allocated\. For example, \.5 indicates that 50 percent of allocated provisioned concurrency is in use\. -For more details, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. +For more details, see [Working with Lambda function metrics](monitoring-metrics.md)\. ## Optimizing latency with provisioned concurrency diff --git a/doc_source/python-context.md b/doc_source/python-context.md old mode 100644 new mode 100755 diff --git a/doc_source/python-exceptions.md b/doc_source/python-exceptions.md old mode 100644 new mode 100755 index 883eff54..7793b3eb --- a/doc_source/python-exceptions.md +++ b/doc_source/python-exceptions.md @@ -43,7 +43,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -76,7 +76,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/python-handler.md b/doc_source/python-handler.md old mode 100644 new mode 100755 index f566411b..a8a3bc70 --- a/doc_source/python-handler.md +++ b/doc_source/python-handler.md @@ -114,7 +114,7 @@ The function in this example depends on a successful response \(in `200`\) from ### Returning a calculation -The following example [Lambda Python function code on GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/python/example_code/lambda/boto_client_examples/lambda_handler_basic.py) shows a function called `lambda_handler` that uses the `python3.6` [Lambda runtime](lambda-runtimes.md)\. The function accepts user input and returns a calculation to the user\. +The following example [Lambda Python function code on GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/python/example_code/lambda/lambda_handler_basic.py) shows a function called `lambda_handler` that uses the `python3.6` [Lambda runtime](lambda-runtimes.md)\. The function accepts user input and returns a calculation to the user\. You can use the following event data to [invoke the function](https://docs.aws.amazon.com/lambda/latest/dg/getting-started-create-function.html#get-started-invoke-manually): diff --git a/doc_source/python-image.md b/doc_source/python-image.md old mode 100644 new mode 100755 index 55bfb071..6709b05d --- a/doc_source/python-image.md +++ b/doc_source/python-image.md @@ -8,7 +8,7 @@ You can deploy your Lambda function code as a [container image](images-create.md These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. diff --git a/doc_source/python-logging.md b/doc_source/python-logging.md old mode 100644 new mode 100755 index fdf6f8c0..5fba3a46 --- a/doc_source/python-logging.md +++ b/doc_source/python-logging.md @@ -121,7 +121,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/python-package.md b/doc_source/python-package.md old mode 100644 new mode 100755 index 513209a5..cd9c70dd --- a/doc_source/python-package.md +++ b/doc_source/python-package.md @@ -60,7 +60,7 @@ Create the \.zip file for your deployment package\. cd my-math-function ``` -1. Copy the contents of the [sample Python code from GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/python/example_code/lambda/boto_client_examples/lambda_handler_basic.py) and save it in a new file named `lambda_function.py`\. Your directory structure should look like this: +1. Copy the contents of the [sample Python code from GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/python/example_code/lambda/lambda_handler_basic.py) and save it in a new file named `lambda_function.py`\. Your directory structure should look like this: ``` my-math-function$ @@ -101,12 +101,10 @@ Create the \.zip file for your deployment package\. ``` import requests - def main(event, context): + def lambda_handler(event, context): response = requests.get("https://www.test.com/") print(response.text) return response.text - if __name__ == "__main__": - main('', '') ``` Your directory structure should look like this: diff --git a/doc_source/python-tracing.md b/doc_source/python-tracing.md old mode 100644 new mode 100755 index d83fb5a0..7b1a6c85 --- a/doc_source/python-tracing.md +++ b/doc_source/python-tracing.md @@ -13,7 +13,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/ruby-context.md b/doc_source/ruby-context.md old mode 100644 new mode 100755 diff --git a/doc_source/ruby-exceptions.md b/doc_source/ruby-exceptions.md old mode 100644 new mode 100755 index b17df846..345344ea --- a/doc_source/ruby-exceptions.md +++ b/doc_source/ruby-exceptions.md @@ -65,7 +65,7 @@ You can invoke your function on the Lambda console by configuring a test event a **To invoke a function on the Lambda console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the function to test, and choose **Test**\. @@ -98,7 +98,7 @@ aws lambda invoke \ --payload '{"key1": "value1", "key2": "value2", "key3": "value3"}' output.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. You should see the AWS CLI response in your command prompt: diff --git a/doc_source/ruby-handler.md b/doc_source/ruby-handler.md old mode 100644 new mode 100755 diff --git a/doc_source/ruby-image.md b/doc_source/ruby-image.md old mode 100644 new mode 100755 index b205730c..d42ca1e3 --- a/doc_source/ruby-image.md +++ b/doc_source/ruby-image.md @@ -5,7 +5,7 @@ You can deploy your Lambda function code as a [container image](images-create.md These base images are preloaded with a language runtime and other components that are required to run the image on Lambda\. AWS provides a Dockerfile for each of the base images to help with building your container image\. - For runtimes that use the Amazon Linux 2 operating system, AWS provides base images for x86\_64 architecture and arm64 architecture\. + AWS provides base images for the x86\_64 architecture for all supported \.NET runtimes, and for the arm64 architecture for the \.NET Core 3\.1 and \.NET 6\.0 runtimes\. + Open\-source runtime interface clients \(RIC\) If you use a community or private enterprise base image, you must add a [Runtime interface client](runtimes-images.md#runtimes-api-client) to the base image to make it compatible with Lambda\. diff --git a/doc_source/ruby-logging.md b/doc_source/ruby-logging.md old mode 100644 new mode 100755 index 9a31503b..9a57855a --- a/doc_source/ruby-logging.md +++ b/doc_source/ruby-logging.md @@ -151,7 +151,7 @@ The `base64` utility is available on Linux, macOS, and [Ubuntu on Windows](https **Example get\-logs\.sh script** In the same command prompt, use the following script to download the last five log events\. The script uses `sed` to remove quotes from the output file, and sleeps for 15 seconds to allow time for the logs to become available\. The output includes the response from Lambda and the output from the `get-log-events` command\. Copy the contents of the following code sample and save in your Lambda project directory as `get-logs.sh`\. -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ``` #!/bin/bash diff --git a/doc_source/ruby-package.md b/doc_source/ruby-package.md old mode 100644 new mode 100755 diff --git a/doc_source/ruby-tracing.md b/doc_source/ruby-tracing.md old mode 100644 new mode 100755 index e1da11a2..0ea13d40 --- a/doc_source/ruby-tracing.md +++ b/doc_source/ruby-tracing.md @@ -10,7 +10,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/runtime-support-policy.md b/doc_source/runtime-support-policy.md old mode 100644 new mode 100755 index 7fe3e7f4..201e3cf2 --- a/doc_source/runtime-support-policy.md +++ b/doc_source/runtime-support-policy.md @@ -18,10 +18,10 @@ In the table below, each of the phases starts at midnight \(Pacific time zone\) | Name | Identifier | Operating system | End of support phase 1 start | End of support phase 2 start | | --- | --- | --- | --- | --- | -| \.NET Core 2\.1 | `dotnetcore2.1` | Amazon Linux | Oct 26, 2021 | Nov 30, 2021 | -| Python 2\.7 | `python2.7` | Amazon Linux | July 15, 2021 | Nov 22, 2021 | -| Ruby 2\.5 | `ruby2.5` | Amazon Linux | July 30, 2021 | Nov 30, 2021 | -| Node\.js 10\.x | `nodejs10.x` | Amazon Linux 2 | July 30, 2021 | Nov 30, 2021 | +| \.NET Core 2\.1 | `dotnetcore2.1` | Amazon Linux | Jan 5, 2022 | Feb 14, 2022 | +| Python 2\.7 | `python2.7` | Amazon Linux | July 15, 2021 | Feb 14, 2022 | +| Ruby 2\.5 | `ruby2.5` | Amazon Linux | July 30, 2021 | Feb 14, 2022 | +| Node\.js 10\.x | `nodejs10.x` | Amazon Linux 2 | July 30, 2021 | Feb 14, 2022 | | Node\.js 8\.10 | `nodejs8.10` | Amazon Linux | | March 6, 2020 | | Node\.js 6\.10 | `nodejs6.10` | Amazon Linux | | August 12, 2019 | | Node\.js 4\.3 edge | `nodejs4.3-edge` | Amazon Linux | | April 30, 2019 | diff --git a/doc_source/runtimes-api.md b/doc_source/runtimes-api.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-avx2.md b/doc_source/runtimes-avx2.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-context.md b/doc_source/runtimes-context.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-custom.md b/doc_source/runtimes-custom.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-extensions-api.md b/doc_source/runtimes-extensions-api.md old mode 100644 new mode 100755 index 21057e3d..94d26b24 --- a/doc_source/runtimes-extensions-api.md +++ b/doc_source/runtimes-extensions-api.md @@ -110,7 +110,7 @@ Here is an example payload: **Note** Lambda allocates CPU power in proportion to the function's memory setting\. You might see increased execution and initialization duration at lower memory settings because the function and extension processes are competing for the same CPU resources\. To reduce the execution and initialization duration, try increasing the memory setting\. -To help identify the performance impact introduced by extensions on the `Invoke` phase, Lambda outputs the `PostRuntimeExtensionsDuration` metric\. This metric measures the cumulative time spent between the runtime `Next` API request and the last extension `Next` API request\. To measure the increase in memory used, use the `MaxMemoryUsed` metric\. For more information about function metrics, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. +To help identify the performance impact introduced by extensions on the `Invoke` phase, Lambda outputs the `PostRuntimeExtensionsDuration` metric\. This metric measures the cumulative time spent between the runtime `Next` API request and the last extension `Next` API request\. To measure the increase in memory used, use the `MaxMemoryUsed` metric\. For more information about function metrics, see [Working with Lambda function metrics](monitoring-metrics.md)\. Function developers can run different versions of their functions side by side to understand the impact of a specific extension\. We recommend that extension authors publish expected resource consumption to make it easier for function developers to choose a suitable extension\. diff --git a/doc_source/runtimes-images.md b/doc_source/runtimes-images.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-logs-api.md b/doc_source/runtimes-logs-api.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-modify.md b/doc_source/runtimes-modify.md old mode 100644 new mode 100755 diff --git a/doc_source/runtimes-walkthrough.md b/doc_source/runtimes-walkthrough.md old mode 100644 new mode 100755 index c49f6e76..843fb4fc --- a/doc_source/runtimes-walkthrough.md +++ b/doc_source/runtimes-walkthrough.md @@ -218,7 +218,7 @@ runtime-tutorial$ aws lambda update-function-code --function-name bash-runtime - Invoke the function to verify that it works with the runtime layer\. ``` -runtime-tutorial$ aws lambda invoke --function-name bash-runtime --payload '{"text":"Hello"}' response.txt +runtime-tutorial$ aws lambda invoke --function-name bash-runtime --payload '{"text":"Hello"}' response.txt --cli-binary-format raw-in-base64-out { "StatusCode": 200, "ExecutedVersion": "$LATEST" diff --git a/doc_source/samples-blank.md b/doc_source/samples-blank.md old mode 100644 new mode 100755 index 792a6905..62588858 --- a/doc_source/samples-blank.md +++ b/doc_source/samples-blank.md @@ -64,7 +64,7 @@ var serialize = function(object) { The input/output types for the handler and support for asynchronous programming vary per runtime\. In this example, the handler method is `async`, so in Node\.js this means that it must return a promise back to the runtime\. The Lambda runtime waits for the promise to be resolved and returns the response to the invoker\. If the function code or AWS SDK client return an error, the runtime formats the error into a JSON document and returns that\. -The sample application doesn't include an Amazon SQS queue to send events, but uses an event from Amazon SQS \([event\.json](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/blank-nodejs/event.json)\) to illustrate how events are processed\. To add an Amazon SQS queue to your application, see [Using AWS Lambda with Amazon SQS](with-sqs.md)\. +The sample application doesn't include an Amazon SQS queue to send events, but uses an event from Amazon SQS \([event\.json](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/blank-nodejs/event.json)\) to illustrate how events are processed\. To add an Amazon SQS queue to your application, see [Using Lambda with Amazon SQS](with-sqs.md)\. ## Deployment automation with AWS CloudFormation and the AWS CLI diff --git a/doc_source/samples-errorprocessor.md b/doc_source/samples-errorprocessor.md old mode 100644 new mode 100755 diff --git a/doc_source/samples-listmanager.md b/doc_source/samples-listmanager.md old mode 100644 new mode 100755 diff --git a/doc_source/security-compliance.md b/doc_source/security-compliance.md old mode 100644 new mode 100755 diff --git a/doc_source/security-configuration.md b/doc_source/security-configuration.md old mode 100644 new mode 100755 diff --git a/doc_source/security-dataprotection.md b/doc_source/security-dataprotection.md old mode 100644 new mode 100755 diff --git a/doc_source/security-iam.md b/doc_source/security-iam.md old mode 100644 new mode 100755 diff --git a/doc_source/security-infrastructure.md b/doc_source/security-infrastructure.md old mode 100644 new mode 100755 diff --git a/doc_source/security-resilience.md b/doc_source/security-resilience.md old mode 100644 new mode 100755 diff --git a/doc_source/security_iam_id-based-policy-examples.md b/doc_source/security_iam_id-based-policy-examples.md old mode 100644 new mode 100755 diff --git a/doc_source/security_iam_service-with-iam.md b/doc_source/security_iam_service-with-iam.md old mode 100644 new mode 100755 diff --git a/doc_source/security_iam_troubleshoot.md b/doc_source/security_iam_troubleshoot.md old mode 100644 new mode 100755 diff --git a/doc_source/services-alb.md b/doc_source/services-alb.md old mode 100644 new mode 100755 diff --git a/doc_source/services-alexa.md b/doc_source/services-alexa.md old mode 100644 new mode 100755 diff --git a/doc_source/services-apigateway-blueprint.md b/doc_source/services-apigateway-blueprint.md old mode 100644 new mode 100755 diff --git a/doc_source/services-apigateway-code.md b/doc_source/services-apigateway-code.md old mode 100644 new mode 100755 diff --git a/doc_source/services-apigateway-template.md b/doc_source/services-apigateway-template.md old mode 100644 new mode 100755 diff --git a/doc_source/services-apigateway-tutorial.md b/doc_source/services-apigateway-tutorial.md old mode 100644 new mode 100755 index 6a4cf921..feb395a0 --- a/doc_source/services-apigateway-tutorial.md +++ b/doc_source/services-apigateway-tutorial.md @@ -348,7 +348,7 @@ Test the Lambda function manually using the following sample event data\. You ca --payload file://input.txt outputfile.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. 1. Verify the output in the file `outputfile.txt`\. diff --git a/doc_source/services-apigateway.md b/doc_source/services-apigateway.md old mode 100644 new mode 100755 index 3222c7a8..df218f34 --- a/doc_source/services-apigateway.md +++ b/doc_source/services-apigateway.md @@ -22,7 +22,7 @@ Resources in your API define one or more methods, such as GET or POST\. Methods **To add a public endpoint to your Lambda function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/services-cloudformation.md b/doc_source/services-cloudformation.md old mode 100644 new mode 100755 diff --git a/doc_source/services-cloudwatchevents-expressions.md b/doc_source/services-cloudwatchevents-expressions.md old mode 100644 new mode 100755 diff --git a/doc_source/services-cloudwatchevents-tutorial.md b/doc_source/services-cloudwatchevents-tutorial.md old mode 100644 new mode 100755 index 7cbe0277..27d178da --- a/doc_source/services-cloudwatchevents-tutorial.md +++ b/doc_source/services-cloudwatchevents-tutorial.md @@ -43,7 +43,7 @@ EventBridge \(CloudWatch Events\) emits an event every minute, based on the sche Test the function with a sample event provided by the Lambda console\. -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the **lambda\-canary** function\. @@ -113,7 +113,7 @@ Update the function configuration to cause the function to return an error, whic **To trigger an alarm** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the **lambda\-canary** function\. diff --git a/doc_source/services-cloudwatchevents.md b/doc_source/services-cloudwatchevents.md old mode 100644 new mode 100755 index a59998ed..85e0862f --- a/doc_source/services-cloudwatchevents.md +++ b/doc_source/services-cloudwatchevents.md @@ -58,7 +58,7 @@ You can also create a Lambda function and direct AWS Lambda to invoke it on a re **To configure EventBridge \(CloudWatch Events\) to invoke your function** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function @@ -76,5 +76,4 @@ Each AWS account can have up to 100 unique event sources of the **EventBridge \( **Topics** + [Tutorial: Using AWS Lambda with scheduled events](services-cloudwatchevents-tutorial.md) -+ [AWS SAM template for a EventBridge \(CloudWatch Events\) application](with-scheduledevents-example-use-app-spec.md) + [Schedule expressions using rate or cron](services-cloudwatchevents-expressions.md) \ No newline at end of file diff --git a/doc_source/services-cloudwatchlogs.md b/doc_source/services-cloudwatchlogs.md old mode 100644 new mode 100755 diff --git a/doc_source/services-codecommit.md b/doc_source/services-codecommit.md old mode 100644 new mode 100755 diff --git a/doc_source/services-codepipeline.md b/doc_source/services-codepipeline.md old mode 100644 new mode 100755 diff --git a/doc_source/services-cognito.md b/doc_source/services-cognito.md old mode 100644 new mode 100755 diff --git a/doc_source/services-config.md b/doc_source/services-config.md old mode 100644 new mode 100755 diff --git a/doc_source/services-connect.md b/doc_source/services-connect.md old mode 100644 new mode 100755 diff --git a/doc_source/services-ec2-tutorial.md b/doc_source/services-ec2-tutorial.md old mode 100644 new mode 100755 diff --git a/doc_source/services-ec2.md b/doc_source/services-ec2.md old mode 100644 new mode 100755 diff --git a/doc_source/services-efs.md b/doc_source/services-efs.md old mode 100644 new mode 100755 diff --git a/doc_source/services-elasticache-tutorial.md b/doc_source/services-elasticache-tutorial.md old mode 100644 new mode 100755 diff --git a/doc_source/services-iot.md b/doc_source/services-iot.md old mode 100644 new mode 100755 diff --git a/doc_source/services-iotevents.md b/doc_source/services-iotevents.md old mode 100644 new mode 100755 diff --git a/doc_source/services-kinesisfirehose.md b/doc_source/services-kinesisfirehose.md old mode 100644 new mode 100755 diff --git a/doc_source/services-lex.md b/doc_source/services-lex.md old mode 100644 new mode 100755 diff --git a/doc_source/services-rds-tutorial.md b/doc_source/services-rds-tutorial.md old mode 100644 new mode 100755 diff --git a/doc_source/services-rds.md b/doc_source/services-rds.md old mode 100644 new mode 100755 diff --git a/doc_source/services-s3-batch.md b/doc_source/services-s3-batch.md old mode 100644 new mode 100755 index 848b668a..c579ed57 --- a/doc_source/services-s3-batch.md +++ b/doc_source/services-s3-batch.md @@ -55,7 +55,7 @@ Note that you can't reuse an existing Amazon S3 event\-based function for batch In the [resource\-based policy](access-control-resource-based.md) that you create for the Amazon S3 batch job, ensure that you set permission for the job to invoke your Lambda function\. -In the [execution role](lambda-intro-execution-role.md) for the function, set a trust policy for Amazon S3 to assume the role when it runs your function\. +In the execution role for the function, set a [trust policy for Amazon S3 to assume the role when it runs your function](https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html)\. If your function uses the AWS SDK to manage Amazon S3 resources, you need to add Amazon S3 permissions in the execution role\. diff --git a/doc_source/services-s3-object-lambda.md b/doc_source/services-s3-object-lambda.md old mode 100644 new mode 100755 diff --git a/doc_source/services-ses.md b/doc_source/services-ses.md old mode 100644 new mode 100755 diff --git a/doc_source/services-stepfunctions.md b/doc_source/services-stepfunctions.md old mode 100644 new mode 100755 diff --git a/doc_source/services-xray.md b/doc_source/services-xray.md old mode 100644 new mode 100755 index 210cff81..71fe5a4a --- a/doc_source/services-xray.md +++ b/doc_source/services-xray.md @@ -8,7 +8,7 @@ To trace requests that don't have a tracing header, enable active tracing in you **To enable active tracing** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/stepfunctions-lc.md b/doc_source/stepfunctions-lc.md old mode 100644 new mode 100755 diff --git a/doc_source/stepfunctions-patterns.md b/doc_source/stepfunctions-patterns.md old mode 100644 new mode 100755 diff --git a/doc_source/troubleshooting-deployment.md b/doc_source/troubleshooting-deployment.md old mode 100644 new mode 100755 diff --git a/doc_source/troubleshooting-execution.md b/doc_source/troubleshooting-execution.md old mode 100644 new mode 100755 diff --git a/doc_source/troubleshooting-images.md b/doc_source/troubleshooting-images.md old mode 100644 new mode 100755 diff --git a/doc_source/troubleshooting-invocation.md b/doc_source/troubleshooting-invocation.md old mode 100644 new mode 100755 diff --git a/doc_source/troubleshooting-networking.md b/doc_source/troubleshooting-networking.md old mode 100644 new mode 100755 index b5bf14db..8ae59be7 --- a/doc_source/troubleshooting-networking.md +++ b/doc_source/troubleshooting-networking.md @@ -1,27 +1,31 @@ # Troubleshoot networking issues in Lambda -By default, Lambda runs your functions in an internal virtual private cloud \(VPC\) with connectivity to AWS services and the internet\. To access local network resources, you can [configure your function to connect to a VPC in your account](configuration-vpc.md)\. When you use this feature, you manage the function's internet access and network connectivity with VPC resources\. +By default, Lambda runs your functions in an internal virtual private cloud \(VPC\) with connectivity to AWS services and the internet\. To access local network resources, you can [configure your function to connect to a VPC in your account](configuration-vpc.md)\. When you use this feature, you manage the function's internet access and network connectivity with Amazon Virtual Private Cloud \(Amazon VPC\) resources\. -Network connectivity errors can result from issues in routing configuration, security group rules, role permissions, network address translation, or the availability of resources such as IP addresses or network interfaces\. They may result in a specific error or, if a request can't reach its destination, a timeout\. +Network connectivity errors can result from issues with your VPC's routing configuration, security group rules, AWS Identity and Access Management \(IAM\) role permissions, or network address translation \(NAT\), or from the availability of resources such as IP addresses or network interfaces\. Depending on the issue, you might see a specific error or timeout if a request can't reach its destination\. ## VPC: Function loses internet access or times out -**Issue:** *Function loses internet access after connecting to a VPC* +**Issue:** *Your Lambda function loses internet access after connecting to a VPC\.* **Error:** *Error: connect ETIMEDOUT 176\.32\.98\.189:443* **Error:** *Error: Task timed out after 10\.00 seconds* -When you connect a function to a VPC, all outbound requests go through your VPC\. To connect to the internet, configure your VPC to send outbound traffic from the function's subnet to a NAT gateway in a public subnet\. For more information and sample VPC configurations, see [Internet and service access for VPC\-connected functions](configuration-vpc.md#vpc-internet)\. +**Error:** *ReadTimeoutError: Read timed out\. \(read timeout=15\)* + +When you connect a function to a VPC, all outbound requests go through the VPC\. To connect to the internet, configure your VPC to send outbound traffic from the function's subnet to a NAT gateway in a public subnet\. For more information and sample VPC configurations, see [Internet and service access for VPC\-connected functions](configuration-vpc.md#vpc-internet)\. + +If some of your TCP connections are timing out, this may be due to packet fragmentation\. Lambda functions cannot handle incoming fragmented TCP requests, since Lambda does not support IP fragmentation for TCP or ICMP\. ## VPC: Function needs access to AWS services without using the internet -**Issue:** *Function needs access to AWS services without using the internet* +**Issue:** *Your Lambda function needs access to AWS services without using the internet\.* -To connect to AWS services from a private subnet with no internet access, use VPC endpoints\. For a sample template with VPC endpoints for DynamoDB and Amazon S3, see [Sample VPC configurations](configuration-vpc.md#vpc-samples)\. +To connect a function to AWS services from a private subnet with no internet access, use VPC endpoints\. For a sample AWS CloudFormation template with VPC endpoints for Amazon Simple Storage Service \(Amazon S3\) and Amazon DynamoDB \(DynamoDB\), see [Sample VPC configurations](configuration-vpc.md#vpc-samples)\. -## VPC: Limit was reached for the function's VPC +## VPC: Elastic network interface limit reached **Error:** *ENILimitReachedException: The elastic network interface limit was reached for the function's VPC\.* -When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of subnet and security group attached to the function\. These network interfaces are limited to 250 per VPC, but this limit can be increased\. To request an increase, use the [Support Center console](https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase)\. \ No newline at end of file +When you connect a Lambda function to a VPC, Lambda creates an elastic network interface for each combination of subnet and security group attached to the function\. The default service quota is 250 network interfaces per VPC\. To request a quota increase, use the [Service Quotas console](https://console.aws.amazon.com/servicequotas/home/services/lambda/quotas/L-9FEE3D26)\. \ No newline at end of file diff --git a/doc_source/using-extensions.md b/doc_source/using-extensions.md old mode 100644 new mode 100755 index 845a69f2..a19746ec --- a/doc_source/using-extensions.md +++ b/doc_source/using-extensions.md @@ -72,7 +72,7 @@ You add the extension to your function using the same method as you would for an **Add an extension to your function \(console\)** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. diff --git a/doc_source/welcome.md b/doc_source/welcome.md old mode 100644 new mode 100755 index a6b1bedb..2071ad2b --- a/doc_source/welcome.md +++ b/doc_source/welcome.md @@ -24,7 +24,7 @@ Lambda is a highly available service\. For more information, see the [AWS Lambda ## When should I use Lambda? -Lambda is an ideal compute service for many application scenarios, as long as you can run your application code using the Lambda [standard runtime environment](runtimes-context.md) and within the resources that Lambda provides\. +Lambda is an ideal compute service for many application scenarios, as long as you can run your application code using the Lambda [standard runtime environment](runtimes-context.md) and within the resources that Lambda provides\. Lambda is best suited for shorter, event\-driven workloads, since Lambda functions run for up to 15 minutes per invocation\. When using Lambda, you are responsible only for your code\. Lambda manages the compute fleet that offers a balance of memory, CPU, network, and other resources to run your code\. Because Lambda manages these resources, you cannot log in to compute instances or customize the operating system on [provided runtimes](lambda-runtimes.md)\. Lambda performs operational and administrative activities on your behalf, including managing capacity, monitoring, and logging your Lambda functions\. diff --git a/doc_source/with-android-create-package.md b/doc_source/with-android-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-android-example.md b/doc_source/with-android-example.md old mode 100644 new mode 100755 index d8b66f15..205569ac --- a/doc_source/with-android-example.md +++ b/doc_source/with-android-example.md @@ -97,7 +97,7 @@ Invoke the function manually using the sample event data\. --payload file://file-path/input.txt outputfile.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. ## Create an Amazon Cognito identity pool diff --git a/doc_source/with-cloudtrail-create-package.md b/doc_source/with-cloudtrail-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-cloudtrail-example.md b/doc_source/with-cloudtrail-example.md old mode 100644 new mode 100755 diff --git a/doc_source/with-cloudtrail.md b/doc_source/with-cloudtrail.md old mode 100644 new mode 100755 index a3d20878..9f23f3e6 --- a/doc_source/with-cloudtrail.md +++ b/doc_source/with-cloudtrail.md @@ -80,6 +80,6 @@ In this scenario, CloudTrail writes access logs to your S3 bucket\. As for AWS L For detailed information about how to configure Amazon S3 as the event source, see [Using AWS Lambda with Amazon S3](with-s3.md)\. **Topics** -+ [Logging AWS Lambda API calls with AWS CloudTrail](logging-using-cloudtrail.md) ++ [Logging Lambda API calls with CloudTrail](logging-using-cloudtrail.md) + [Tutorial: Triggering a Lambda function with AWS CloudTrail events](with-cloudtrail-example.md) + [Sample function code](with-cloudtrail-create-package.md) \ No newline at end of file diff --git a/doc_source/with-ddb-create-package.md b/doc_source/with-ddb-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-ddb-example.md b/doc_source/with-ddb-example.md old mode 100644 new mode 100755 index 68549657..1ddadfdb --- a/doc_source/with-ddb-example.md +++ b/doc_source/with-ddb-example.md @@ -185,7 +185,7 @@ Run the following `invoke` command\. aws lambda invoke --function-name ProcessDynamoDBRecords --payload file://input.txt outputfile.txt ``` -The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. +The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. The function returns the string `message` in the response body\. @@ -215,10 +215,12 @@ Create an Amazon DynamoDB table with a stream enabled\. 1. Choose the **lambda\-dynamodb\-stream** table\. -1. Under **Overview**, choose **Manage stream**\. +1. Under **Exports and streams**, choose **DynamoDB stream details**\. 1. Choose **Enable**\. +1. Choose **Enable stream**\. + Write down the stream ARN\. You need this in the next step when you associate the stream with your Lambda function\. For more information on enabling streams, see [Capturing table activity with DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)\. ## Add an event source in AWS Lambda diff --git a/doc_source/with-ddb.md b/doc_source/with-ddb.md old mode 100644 new mode 100755 index 30a003a7..635f7a30 --- a/doc_source/with-ddb.md +++ b/doc_source/with-ddb.md @@ -32,7 +32,7 @@ Lambda reads records from the stream and invokes your function [synchronously](i }, "awsRegion": "us-west-2", "eventName": "INSERT", - "eventSourceARN": eventsourcearn, + "eventSourceARN": "arn:aws:dynamodb:us-east-1:111122223333:table/EventSourceTable", "eventSource": "aws:dynamodb" }, { @@ -66,20 +66,21 @@ Lambda reads records from the stream and invokes your function [synchronously](i }, "awsRegion": "us-west-2", "eventName": "MODIFY", - "eventSourceARN": sourcearn, + "eventSourceARN": "arn:aws:dynamodb:us-east-1:111122223333:table/EventSourceTable", "eventSource": "aws:dynamodb" } + ]} ``` Lambda polls shards in your DynamoDB stream for records at a base rate of 4 times per second\. When records are available, Lambda invokes your function and waits for the result\. If processing succeeds, Lambda resumes polling until it receives more records\. -By default, Lambda invokes your function as soon as records are available in the stream\. If the batch that Lambda reads from the stream only has one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to five minutes by configuring a *batch window*\. Before invoking the function, Lambda continues to read records from the stream until it has gathered a full batch, or until the batch window expires\. +By default, Lambda invokes your function as soon as records are available\. If the batch that Lambda reads from the event source has only one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to 5 minutes by configuring a *batching window*\. Before invoking the function, Lambda continues to read records from the event source until it has gathered a full batch, the batching window expires, or the batch reaches the payload limit of 6 MB\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. If your function returns an error, Lambda retries the batch until processing succeeds or the data expires\. To avoid stalled shards, you can configure the event source mapping to retry with a smaller batch size, limit the number of retries, or discard records that are too old\. To retain discarded events, you can configure the event source mapping to send details about failed batches to an SQS queue or SNS topic\. You can also increase concurrency by processing multiple batches from each shard in parallel\. Lambda can process up to 10 batches in each shard simultaneously\. If you increase the number of concurrent batches per shard, Lambda still ensures in\-order processing at the partition\-key level\. -Configure the `ParallelizationFactor` setting to process one shard of a Kinesis or DynamoDB data stream with more than one Lambda invocation simultaneously\. You can specify the number of concurrent batches that Lambda polls from a shard via a parallelization factor from 1 \(default\) to 10\. For example, when `ParallelizationFactor` is set to 2, you can have 200 concurrent Lambda invocations at maximum to process 100 Kinesis data shards\. This helps scale up the processing throughput when the data volume is volatile and the `IteratorAge` is high\. Note that parallelization factor will not work if you are using Kinesis aggregation\. For more information, see [New AWS Lambda scaling controls for Kinesis and DynamoDB event sources](http://aws.amazon.com/blogs/compute/new-aws-lambda-scaling-controls-for-kinesis-and-dynamodb-event-sources/)\. Also, see the [Serverless Data Processing on AWS](https://data-processing.serverlessworkshops.io/) workshop for complete tutorials\. +Configure the `ParallelizationFactor` setting to process one shard of a Kinesis or DynamoDB data stream with more than one Lambda invocation simultaneously\. You can specify the number of concurrent batches that Lambda polls from a shard via a parallelization factor from 1 \(default\) to 10\. For example, when you set `ParallelizationFactor` to 2, you can have 200 concurrent Lambda invocations at maximum to process 100 Kinesis data shards\. This helps scale up the processing throughput when the data volume is volatile and the `IteratorAge` is high\. Note that parallelization factor will not work if you are using Kinesis aggregation\. For more information, see [New AWS Lambda scaling controls for Kinesis and DynamoDB event sources](http://aws.amazon.com/blogs/compute/new-aws-lambda-scaling-controls-for-kinesis-and-dynamodb-event-sources/)\. Also, see the [Serverless Data Processing on AWS](https://data-processing.serverlessworkshops.io/) workshop for complete tutorials\. **Topics** + [Execution role permissions](#events-dynamodb-permissions) @@ -101,11 +102,10 @@ Lambda needs the following permissions to manage resources related to your Dynam + [dynamodb:GetRecords](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html) + [dynamodb:GetShardIterator](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) + [dynamodb:ListStreams](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_ListStreams.html) -+ [dynamodb:ListShards](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_ListShards.html) The `AWSLambdaDynamoDBExecutionRole` managed policy includes these permissions\. For more information, see [AWS Lambda execution role](lambda-intro-execution-role.md)\. -To send records of failed batches to a queue or topic, your function needs additional permissions\. Each destination service requires a different permission, as follows: +To send records of failed batches to an SQS queue or SNS topic, your function needs additional permissions\. Each destination service requires a different permission, as follows: + **Amazon SQS** – [sqs:SendMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) + **Amazon SNS** – [sns:Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) @@ -117,15 +117,15 @@ To configure your function to read from DynamoDB Streams in the Lambda console, **To create a trigger** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. -1. Choose a function\. +1. Choose the name of a function\. 1. Under **Function overview**, choose **Add trigger**\. 1. Choose a trigger type\. -1. Configure the required options and then choose **Add**\. +1. Configure the required options, and then choose **Add**\. Lambda supports the following options for DynamoDB event sources\. @@ -138,11 +138,11 @@ Lambda supports the following options for DynamoDB event sources\. + **Trim horizon** – Process all records in the stream\. After processing any existing records, the function is caught up and continues to process new records\. -+ **On\-failure destination** – An SQS queue or SNS topic for records that can't be processed\. When Lambda discards a batch of records because it's too old or has exhausted all retries, it sends details about the batch to the queue or topic\. ++ **On\-failure destination** – An SQS queue or SNS topic for records that can't be processed\. When Lambda discards a batch of records that's too old or has exhausted all retries, Lambda sends details about the batch to the queue or topic\. + **Retry attempts** – The maximum number of times that Lambda retries when the function returns an error\. This doesn't apply to service errors or throttles where the batch didn't reach the function\. + **Maximum age of record** – The maximum age of a record that Lambda sends to your function\. + **Split batch on error** – When the function returns an error, split the batch into two before retrying\. -+ **Concurrent batches per shard** – Process multiple batches from the same shard concurrently\. ++ **Concurrent batches per shard** – Concurrently process multiple batches from the same shard\. + **Enabled** – Set to true to enable the event source mapping\. Set to false to stop processing records\. Lambda keeps track of the last record processed and resumes processing from that point when the mapping is reenabled\. **Note** @@ -152,14 +152,14 @@ To manage the event source configuration later, choose the trigger in the design ## Event source mapping APIs -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) + [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) + [DeleteEventSourceMapping](API_DeleteEventSourceMapping.md) -The following example uses the AWS CLI to map a function named `my-function` to a DynamoDB stream that is specified by its Amazon Resource Name \(ARN\), with a batch size of 500\. +The following example uses the AWS CLI to map a function named `my-function` to a DynamoDB stream that its Amazon Resource Name \(ARN\) specifies, with a batch size of 500\. ``` aws lambda create-event-source-mapping --function-name my-function --batch-size 500 --starting-position LATEST \ @@ -256,7 +256,7 @@ aws lambda update-event-source-mapping --uuid 2b733gdc-8ac3-cdf5-af3a-1827b3b112 ## Error handling -The event source mapping that reads records from your DynamoDB stream invokes your function synchronously and retries on errors\. If the function is throttled or the Lambda service returns an error without invoking the function, Lambda retries until the records expire or exceed the maximum age that you configure on the event source mapping\. +The event source mapping that reads records from your DynamoDB stream, invokes your function synchronously, and retries on errors\. If Lambda throttles the function or returns an error without invoking the function, Lambda retries until the records expire or exceed the maximum age that you configure on the event source mapping\. If the function receives the records but returns an error, Lambda retries until the records in the batch expire, exceed the maximum age, or reach the configured retry quota\. For function errors, you can also configure the event source mapping to split a failed batch into two batches\. Retrying with smaller batches isolates bad records and works around timeout issues\. Splitting a batch does not count towards the retry quota\. @@ -266,7 +266,7 @@ To retain a record of discarded batches, configure a failed\-event destination\. **To configure a destination for failed\-event records** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -319,7 +319,7 @@ You can use this information to retrieve the affected records from the stream fo Lambda emits the `IteratorAge` metric when your function finishes processing a batch of records\. The metric indicates how old the last record in the batch was when processing finished\. If your function is processing new events, you can use the iterator age to estimate the latency between when a record is added and when the function processes it\. -An increasing trend in iterator age can indicate issues with your function\. For more information, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. +An increasing trend in iterator age can indicate issues with your function\. For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. ## Time windows @@ -613,7 +613,7 @@ All Lambda event source types share the same [CreateEventSourceMapping](API_Crea | Parameter | Required | Default | Notes | | --- | --- | --- | --- | -| BatchSize | N | 100 | Maximum: 10000 | +| BatchSize | N | 100 | Maximum: 1,000 | | BisectBatchOnFunctionError | N | false | | | DestinationConfig | N | | Amazon SQS queue or Amazon SNS topic destination for discarded records | | Enabled | N | true | | diff --git a/doc_source/with-kafka.md b/doc_source/with-kafka.md old mode 100644 new mode 100755 index 3d26a22c..8a6a4dc6 --- a/doc_source/with-kafka.md +++ b/doc_source/with-kafka.md @@ -8,9 +8,9 @@ This topic describes how to use Lambda with a self\-managed Kafka cluster\. In A Apache Kafka as an event source operates similarly to using Amazon Simple Queue Service \(Amazon SQS\) or Amazon Kinesis\. Lambda internally polls for new messages from the event source and then synchronously invokes the target Lambda function\. Lambda reads the messages in batches and provides these to your function as an event payload\. The maximum batch size is configurable\. \(The default is 100 messages\.\) -For an example of how to use self\-managed Kafka as an event source, see [Using self\-hosted Apache Kafka as an event source for AWS Lambda](http://aws.amazon.com/blogs/compute/using-self-hosted-apache-kafka-as-an-event-source-for-aws-lambda/) on the AWS Compute Blog\. - +For Kafka\-based event sources, Lambda supports processing control parameters, such as batching windows and batch size\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. +For an example of how to use self\-managed Kafka as an event source, see [Using self\-hosted Apache Kafka as an event source for AWS Lambda](http://aws.amazon.com/blogs/compute/using-self-hosted-apache-kafka-as-an-event-source-for-aws-lambda/) on the AWS Compute Blog\. Lambda sends the batch of messages in the event parameter when it invokes your Lambda function\. The event payload contains an array of messages\. Each array item contains details of the Kafka topic and Kafka partition identifier, together with a timestamp and a base64\-encoded message\. @@ -51,43 +51,146 @@ Lambda sends the batch of messages in the event parameter when it invokes your L ``` **Topics** -+ [Managing access and permissions](#smaa-permissions) -+ [Kafka authentication](#smaa-authentication) -+ [Network configuration](#services-msk-vpc-config) ++ [Kafka cluster authentication](#smaa-authentication) ++ [Managing API access and permissions](#smaa-permissions) ++ [Authentication and authorization errors](#kafka-permissions-errors) ++ [Network configuration](#services-kafka-vpc-config) + [Adding a Kafka cluster as an event source](#services-smaa-topic-add) + [Using a Kafka cluster as an event source](#kafka-using-cluster) + [Auto scaling of the Kafka event source](#services-kafka-scaling) + [Event source API operations](#kafka-hosting-api-operations) + [Event source mapping errors](#services-event-errors) ++ [Amazon CloudWatch metrics](#services-kafka-metrics) + [Self\-managed Apache Kafka configuration parameters](#services-kafka-parms) -## Managing access and permissions +## Kafka cluster authentication + +Lambda supports several methods to authenticate with your self\-managed Apache Kafka cluster\. Make sure that you configure the Kafka cluster to use one of these supported authentication methods\. For more information about Kafka security, see the [Security](http://kafka.apache.org/documentation.html#security) section of the Kafka documentation\. + +### VPC access + +If only Kafka users within your VPC access your Kafka brokers, you must configure the Kafka event source for Amazon Virtual Private Cloud \(Amazon VPC\) access\. + +### SASL/SCRAM authentication + +Lambda supports Simple Authentication and Security Layer/Salted Challenge Response Authentication Mechanism \(SASL/SCRAM\) authentication with Transport Layer Security \(TLS\) encryption\. Lambda sends the encrypted credentials to authenticate with the cluster\. For more information about SASL/SCRAM authentication, see [RFC 5802](https://tools.ietf.org/html/rfc5802)\. + +Lambda supports SASL/PLAIN authentication with TLS encryption\. With SASL/PLAIN authentication, Lambda sends credentials as clear text \(unencrypted\) to the server\. -For Lambda to poll your Apache Kafka topic and update other cluster resources, your Lambda function—as well as your AWS Identity and Access Management \(IAM\) users and roles—must have the following permissions\. +For SASL authentication, you store the user name and password as a secret in AWS Secrets Manager\. For more information about using Secrets Manager, see [Tutorial: Create and retrieve a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html) in the *AWS Secrets Manager User Guide*\. + +### Mutual TLS authentication + +Mutual TLS \(mTLS\) provides two\-way authentication between the client and server\. The client sends a certificate to the server for the server to verify the client, and the server sends a certificate to the client for the client to verify the server\. + +In self\-managed Apache Kafka, Lambda acts as the client\. You configure a client certificate \(as a secret in Secrets Manager\) to authenticate Lambda with your Kafka brokers\. The client certificate must be signed by a CA in the server's trust store\. + +The Kafka cluster sends a server certificate to Lambda to authenticate the Kafka brokers with Lambda\. The server certificate can be a public CA certificate or a private CA/self\-signed certificate\. The public CA certificate must be signed by a certificate authority \(CA\) that's in the Lambda trust store\. For a private CA/self\-signed certificate, you configure the server root CA certificate \(as a secret in Secrets Manager\)\. Lambda uses the root certificate to verify the Kafka brokers\. + +For more information about mTLS, see [ Introducing mutual TLS authentication for Amazon MSK as an event source](http://aws.amazon.com/blogs/compute/introducing-mutual-tls-authentication-for-amazon-msk-as-an-event-source)\. + +### Configuring the client certificate secret + +The CLIENT\_CERTIFICATE\_TLS\_AUTH secret requires a certificate field and a private key field\. For an encrypted private key, the secret requires a private key password\. Both the certificate and private key must be in PEM format\. + +**Note** +Lambda supports the [PBES1](https://datatracker.ietf.org/doc/html/rfc2898/#section-6.1) \(but not PBES2\) private key encryption algorithms\. + +The certificate field must contain a list of certificates, beginning with the client certificate, followed by any intermediate certificates, and ending with the root certificate\. Each certificate must start on a new line with the following structure: + +``` +-----BEGIN CERTIFICATE----- + +-----END CERTIFICATE----- +``` + +Secrets Manager supports secrets up to 65,536 bytes, which is enough space for long certificate chains\. + +The private key must be in [PKCS \#8](https://datatracker.ietf.org/doc/html/rfc5208) format, with the following structure: + +``` +-----BEGIN PRIVATE KEY----- + +-----END PRIVATE KEY----- +``` + +For an encrypted private key, use the following structure: + +``` +-----BEGIN ENCRYPTED PRIVATE KEY----- + +-----END ENCRYPTED PRIVATE KEY----- +``` + +The following example shows the contents of a secret for mTLS authentication using an encrypted private key\. For an encrypted private key, include the private key password in the secret\. + +``` +{ + "privateKeyPassword": "testpassword", + "certificate": "-----BEGIN CERTIFICATE----- +MIIE5DCCAsygAwIBAgIRAPJdwaFaNRrytHBto0j5BA0wDQYJKoZIhvcNAQELBQAw +... +j0Lh4/+1HfgyE2KlmII36dg4IMzNjAFEBZiCRoPimO40s1cRqtFHXoal0QQbIlxk +cmUuiAii9R0= +-----END CERTIFICATE----- +-----BEGIN CERTIFICATE----- +MIIFgjCCA2qgAwIBAgIQdjNZd6uFf9hbNC5RdfmHrzANBgkqhkiG9w0BAQsFADBb +... +rQoiowbbk5wXCheYSANQIfTZ6weQTgiCHCCbuuMKNVS95FkXm0vqVD/YpXKwA/no +c8PH3PSoAaRwMMgOSA2ALJvbRz8mpg== +-----END CERTIFICATE-----", + "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFKzBVBgkqhkiG9w0BBQ0wSDAnBgkqhkiG9w0BBQwwGgQUiAFcK5hT/X7Kjmgp +... +QrSekqF+kWzmB6nAfSzgO9IaoAaytLvNgGTckWeUkWn/V0Ck+LdGUXzAC4RxZnoQ +zp2mwJn2NYB7AZ7+imp0azDZb+8YG2aUCiyqb6PnnA== +-----END ENCRYPTED PRIVATE KEY-----" +} +``` + +### Configuring the server root CA certificate secret + +You create this secret if your Kafka brokers use TLS encryption with certificates signed by a private CA\. You can use TLS encryption for VPC, SASL/SCRAM, SASL/PLAIN, or mTLS authentication\. + +The server root CA certificate secret requires a field that contains the Kafka broker's root CA certificate in PEM format\. The following example shows the structure of the secret\. + +``` +{ + "certificate": "-----BEGIN CERTIFICATE----- + MIID7zCCAtegAwIBAgIBADANBgkqhkiG9w0BAQsFADCBmDELMAkGA1UEBhMCVVMx + EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxJTAjBgNVBAoT + HFN0YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xOzA5BgNVBAMTMlN0YXJmaWVs + ZCBTZXJ2aWNlcyBSb290IENlcnRpZmljYXRlIEF1dG... + -----END CERTIFICATE-----" +``` + +## Managing API access and permissions + +In addition to accessing your self\-managed Kafka cluster, your Lambda function needs permissions to perform various API actions\. You add these permissions to the function's [execution role](lambda-intro-execution-role.md)\. If your users need access to any API actions, add the required permissions to the identity policy for the AWS Identity and Access Management \(IAM\) user or role\. ### Required Lambda function permissions -To create and store logs to a log group in Amazon CloudWatch Logs, your Lambda function must have the following permissions in its [execution role](lambda-intro-execution-role.md): +To create and store logs in a log group in Amazon CloudWatch Logs, your Lambda function must have the following permissions in its execution role: + [logs:CreateLogGroup](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html) + [logs:CreateLogStream](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogStream.html) + [logs:PutLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) ### Optional Lambda function permissions -Your Lambda function might need these permissions: -+ Describe your AWS Secrets Manager secret -+ Access your AWS Key Management Service \(AWS KMS\) customer managed key -+ Access your Amazon Virtual Private Cloud \(Amazon VPC\) +Your Lambda function might also need permissions to: ++ Describe your Secrets Manager secret\. ++ Access your AWS Key Management Service \(AWS KMS\) customer managed key\. ++ Access your Amazon VPC\. -#### Secrets Manager and AWS KMS permissions +#### Secrets Manager and AWS KMS permissions -If your Apache Kafka users access your Kafka brokers over the internet, you must specify a Secrets Manager secret\. Your Lambda function might need permission to describe your Secrets Manager secret or to decrypt your AWS KMS customer managed key\. To access these resources, your function's [execution role](lambda-intro-execution-role.md) must have the following permissions: +Depending on the type of access control that you're configuring for your Kafka brokers, your Lambda function might need permission to access your Secrets Manager secret or to decrypt your AWS KMS customer managed key\. To access these resources, your function's execution role must have the following permissions: + [secretsmanager:GetSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) + [kms:Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) #### VPC permissions -If only users within a VPC can access your self\-managed Apache Kafka cluster, your Lambda function must have permission to access your Amazon Virtual Private Cloud \(Amazon VPC\) resources\. These resources include your VPC, subnets, security groups, and network interfaces\. To access these resources, your function's [execution role](lambda-intro-execution-role.md) must have the following permissions: +If only users within a VPC can access your self\-managed Apache Kafka cluster, your Lambda function must have permission to access your Amazon VPC resources\. These resources include your VPC, subnets, security groups, and network interfaces\. To access these resources, your function's execution role must have the following permissions: + [ec2:CreateNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) + [ec2:DescribeNetworkInterfaces](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) + [ec2:DescribeVpcs](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html) @@ -97,40 +200,92 @@ If only users within a VPC can access your self\-managed Apache Kafka cluster, y ### Adding permissions to your execution role -To access other AWS services that your self\-managed Apache Kafka cluster uses, Lambda uses the permissions policies that you define in your Lambda function's execution role\. +To access other AWS services that your self\-managed Apache Kafka cluster uses, Lambda uses the permissions policies that you define in your Lambda function's [execution role](lambda-intro-execution-role.md)\. + +By default, Lambda is not permitted to perform the required or optional actions for a self\-managed Apache Kafka cluster\. You must create and define these actions in an [IAM trust policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#term_trust-policy), and then attach the policy to your execution role\. This example shows how you might create a policy that allows Lambda to access your Amazon VPC resources\. + +``` +{ + "Version":"2012-10-17", + "Statement":[ + { + "Effect":"Allow", + "Action":[ + "ec2:CreateNetworkInterface", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVpcs", + "ec2:DeleteNetworkInterface", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ], + "Resource":"*" + } + ] + } +``` + +For information about creating a JSON policy document in the IAM console, see [Creating policies on the JSON tab](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html#access_policies_create-json-editor) in the *IAM User Guide*\. -By default, Lambda is not permitted to perform the required or optional actions for a self\-managed Apache Kafka cluster\. You must create and define these actions in an IAM trust policy, and then attach the policy to your execution role\. For more information, see [AWS Lambda execution role](lambda-intro-execution-role.md) +### Granting users access with an IAM policy -### Adding users to an IAM policy +By default, IAM users and roles don't have permission to perform [event source API operations](#kafka-hosting-api-operations)\. To grant access to users in your organization or account, you create or update an identity\-based policy\. For more information, see [Controlling access to AWS resources using policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_controlling.html) in the *IAM User Guide*\. -By default, IAM users and roles do not have permission to perform [event source API operations](#kafka-hosting-api-operations)\. To grant access to users in your organization or account, you might need to create an identity\-based policy\. For more information, see [Controlling access to AWS resources using policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_controlling.html) in the *IAM User Guide*\. +## Authentication and authorization errors -## Kafka authentication +If any of the permissions required to consume data from the Kafka cluster are missing, Lambda displays one of the following error messages in the event source mapping under **LastProcessingResult**\. -Lambda supports several methods to authenticate with your self\-managed Apache Kafka cluster\. Make sure that you configure the Kafka cluster to use one of the following authentication methods that Lambda supports: -+ VPC +**Topics** ++ [Cluster failed to authorize Lambda](#kafka-authorize-errors) ++ [SASL authentication failed](#kafka-sasl-errors) ++ [Server failed to authenticate Lambda](#kafka-mtls-errors-server) ++ [Lambda failed to authenticate server](#kafka-mtls-errors-lambda) ++ [Provided certificate or private key is invalid](#kafka-key-errors) + +### Cluster failed to authorize Lambda + +For SASL/SCRAM or mTLS, this error indicates that the provided user doesn't have all of the following required Kafka access control list \(ACL\) permissions: ++ DescribeConfigs Cluster ++ Describe Group ++ Read Group ++ Describe Topic ++ Read Topic + +When you create Kafka ACLs with the required `kafka-cluster` permissions, specify the topic and group as resources\. The topic name must match the topic in the event source mapping\. The group name must match the event source mapping's UUID\. + +After you add the required permissions to the execution role, it might take several minutes for the changes to take effect\. - If only Kafka users within your VPC access your Kafka brokers, you must configure the event source with VPC access\. -+ SASL/SCRAM +### SASL authentication failed - Lambda supports Simple Authentication and Security Layer/Salted Challenge Response Authentication Mechanism \(SASL/SCRAM\) authentication with TLS encryption\. Lambda sends the encrypted credentials to authenticate with the cluster\. Because the credentials are encrypted, the connection to the cluster does not need to be encrypted\. For more information about SASL/SCRAM authentication, see [RFC 5802](https://tools.ietf.org/html/rfc5802)\. -+ SASL/PLAIN +For SASL/SCRAM or SASL/PLAIN, this error indicates that the provided user name and password aren't valid\. - Lambda supports SASL/PLAIN authentication with TLS encryption\. With SASL/PLAIN authentication, credentials are sent as clear text \(unencrypted\) to the server\. Because the credentials are clear text, the connection to the server must use TLS encryption\. +### Server failed to authenticate Lambda -For SASL authentication, you must store the user name and password as a secret in Secrets Manager\. For more information, see [Tutorial: Creating and retrieving a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html) in the *AWS Secrets Manager User Guide*\. +This error indicates that the Kafka broker failed to authenticate Lambda\. This can occur for any of the following reasons: ++ You didn't provide a client certificate for mTLS authentication\. ++ You provided a client certificate, but the Kafka brokers aren't configured to use mTLS authentication\. ++ A client certificate isn't trusted by the Kafka brokers\. -## Network configuration +### Lambda failed to authenticate server -If you configure Amazon VPC access to your Kafka brokers, Lambda must have access to the Amazon VPC resources\. +This error indicates that Lambda failed to authenticate the Kafka broker\. This can occur for any of the following reasons: ++ The Kafka brokers use self\-signed certificates or a private CA, but didn't provide the server root CA certificate\. ++ The server root CA certificate doesn't match the root CA that signed the broker's certificate\. ++ Hostname validation failed because the broker's certificate doesn't contain the broker's DNS name or IP address as a subject alternative name\. -Lambda must have access to the Amazon Virtual Private Cloud \(Amazon VPC\) resources associated with your Kafka cluster\. We recommend that you deploy AWS PrivateLink [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-services-overview.html) for Lambda and AWS Security Token Service \(AWS STS\)\. If authentication is required, also deploy a VPC endpoint for Secrets Manager\. +### Provided certificate or private key is invalid + +This error indicates that the Kafka consumer couldn't use the provided certificate or private key\. Make sure that the certificate and key use PEM format, and that the private key encryption uses a PBES1 algorithm\. + +## Network configuration + +If you configure Amazon VPC access to your Kafka brokers, Lambda must have access to the Amazon VPC resources associated with your Kafka cluster\. We recommend that you deploy AWS PrivateLink [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-services-overview.html) for Lambda and AWS Security Token Service \(AWS STS\)\. If the broker uses authentication, also deploy a VPC endpoint for Secrets Manager\. Alternatively, ensure that the VPC associated with your Kafka cluster includes one NAT gateway per public subnet\. For more information, see [Internet and service access for VPC\-connected functions](configuration-vpc.md#vpc-internet)\. -You must configure your Amazon VPC security groups with the following rules \(at minimum\): -+ Inbound rules – Allow all traffic on all ports for the security group specified as your event source\. -+ Outbound rules – Allow all traffic on all ports for all destinations\. +Configure your Amazon VPC security groups with the following rules \(at minimum\): ++ Inbound rules – Allow all traffic on the Kafka broker port for the security groups specified for your event source\. Kafka uses port 9092 by default\. ++ Outbound rules – Allow all traffic on port 443 for all destinations\. Allow all traffic on the Kafka broker port for the security groups specified for your event source\. Kafka uses port 9092 by default\. ++ If you are using VPC endpoints instead of a NAT gateway, the security groups associated with the VPC endpoints must allow all inbound traffic on port 443 from the event source's security groups\. For more information about configuring the network, see [Setting up AWS Lambda with an Apache Kafka cluster within a VPC](http://aws.amazon.com/blogs/compute/setting-up-aws-lambda-with-an-apache-kafka-cluster-within-a-vpc/) on the AWS Compute Blog\. @@ -142,7 +297,7 @@ This section describes how to create an event source mapping using the Lambda co ### Prerequisites + A self\-managed Apache Kafka cluster\. Lambda supports Apache Kafka version 0\.10\.0\.0 and later\. -+ A Lambda execution role with permission to access the AWS resources that your self\-managed Kafka cluster uses\. ++ An [execution role](lambda-intro-execution-role.md) with permission to access the AWS resources that your self\-managed Kafka cluster uses\. ### Adding a self\-managed Kafka cluster \(console\) @@ -168,23 +323,36 @@ Follow these steps to add your self\-managed Apache Kafka cluster and a Kafka to 1. \(Optional\) For **Starting position**, choose **Latest** to start reading the stream from the latest record\. Or, choose **Trim horizon** to start at the earliest available record\. -1. Under **Authentication method**, choose the access or authentication protocol of the Kafka brokers in your cluster\. If only users within your VPC access your Kafka brokers, you must configure VPC access\. If users access your Kafka brokers over the internet, you must configure SASL authentication\. - + To configure VPC access, choose the **VPC** for your Kafka cluster, then choose **VPC subnets** and **VPC security groups**\. - + To configure SASL authentication, under **Secret key**, choose **Add**, then do the following: + 1. \(Optional\) For **VPC**, choose the Amazon VPC for your Kafka cluster\. Then, choose the **VPC subnets** and **VPC security groups**\. + + This setting is required if only users within your VPC access your brokers\. - 1. Choose the key type\. If your Kafka broker uses SASL plaintext, choose **BASIC\_AUTH**\. Otherwise, choose one of the **SASL\_SCRAM** options\. + - 1. Choose the name of the Secrets Manager secret key that contains the credentials for your Kafka cluster\. + 1. \(Optional\) For **Authentication**, choose **Add**, and then do the following: + + 1. Choose the access or authentication protocol of the Kafka brokers in your cluster\. + + If your Kafka broker uses SASL plaintext authentication, choose **BASIC\_AUTH**\. + + If your broker uses SASL/SCRAM authentication, choose one of the **SASL\_SCRAM** protocols\. + + If you're configuring mTLS authentication, choose the **CLIENT\_CERTIFICATE\_TLS\_AUTH** protocol\. + + 1. For SASL/SCRAM or mTLS authentication, choose the Secrets Manager secret key that contains the credentials for your Kafka cluster\. + + 1. \(Optional\) For **Encryption**, choose the Secrets Manager secret containing the root CA certificate that your Kafka brokers use for TLS encryption, if your Kafka brokers use certificates signed by a private CA\. + + This setting applies to TLS encryption for SASL/SCRAM or SASL/PLAIN, and to mTLS authentication\. + + 1. To create the trigger in a disabled state for testing \(recommended\), clear **Enable trigger**\. Or, to enable the trigger immediately, select **Enable trigger**\. 1. To create the trigger, choose **Add**\. -### Adding a self\-managed Kafka cluster \(AWS CLI\) +### Adding a self\-managed Kafka cluster \(AWS CLI\) Use the following example AWS CLI commands to create and view a self\-managed Apache Kafka trigger for your Lambda function\. -#### Using SASL/SCRAM +#### Using SASL/SCRAM -If Kafka users access your Kafka brokers over the internet, you must specify the Secrets Manager secret that you created for SASL/SCRAM authentication\. The following example uses the [https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html](https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html) AWS CLI command to map a Lambda function named `my-kafka-function` to a Kafka topic named `AWSKafkaTopic`\. +If Kafka users access your Kafka brokers over the internet, specify the Secrets Manager secret that you created for SASL/SCRAM authentication\. The following example uses the [https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html](https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html) AWS CLI command to map a Lambda function named `my-kafka-function` to a Kafka topic named `AWSKafkaTopic`\. ``` aws lambda create-event-source-mapping --topics AWSKafkaTopic @@ -195,7 +363,7 @@ aws lambda create-event-source-mapping --topics AWSKafkaTopic For more information, see the [CreateEventSourceMapping](API_CreateEventSourceMapping.md) API reference documentation\. -#### Using a VPC +#### Using a VPC If only Kafka users within your VPC access your Kafka brokers, you must specify your VPC, subnets, and VPC security group\. The following example uses the [https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html](https://docs.aws.amazon.com/cli/latest/reference/lambda/create-event-source-mapping.html) AWS CLI command to map a Lambda function named `my-kafka-function` to a Kafka topic named `AWSKafkaTopic`\. @@ -212,7 +380,7 @@ aws lambda create-event-source-mapping For more information, see the [CreateEventSourceMapping](API_CreateEventSourceMapping.md) API reference documentation\. -#### Viewing the status using the AWS CLI +#### Viewing the status using the AWS CLI The following example uses the [https://docs.aws.amazon.com/cli/latest/reference/lambda/get-event-source-mapping.html](https://docs.aws.amazon.com/cli/latest/reference/lambda/get-event-source-mapping.html) AWS CLI command to describe the status of the event source mapping that you created\. @@ -225,21 +393,21 @@ aws lambda get-event-source-mapping When you add your Apache Kafka cluster as a trigger for your Lambda function, the cluster is used as an [event source](invocation-eventsourcemapping.md)\. -Lambda reads event data from the Kafka topics that you specify in [CreateEventSourceMapping](API_CreateEventSourceMapping.md) `Topics` based on the starting position that you specify in [CreateEventSourceMapping](API_CreateEventSourceMapping.md) `StartingPosition`\. After successful processing, your Kafka topic is committed to your Kafka cluster\. +Lambda reads event data from the Kafka topics that you specify as `Topics` in a [CreateEventSourceMapping](API_CreateEventSourceMapping.md) request, based on the `StartingPosition` that you specify\. After successful processing, your Kafka topic is committed to your Kafka cluster\. -If you specify `LATEST` as the starting position, Lambda starts reading from the latest message in each partition belonging to the topic\. Because there can be some delay after trigger configuration before Lambda starts reading the messages, Lambda does not read any messages produced during this window\. +If you specify the `StartingPosition` as `LATEST`, Lambda starts reading from the latest message in each partition belonging to the topic\. Because there can be some delay after trigger configuration before Lambda starts reading the messages, Lambda doesn't read any messages produced during this window\. -Lambda processes records from one or more Kafka topic partitions that you specify and sends a JSON payload to your Lambda function\. When more records are available, Lambda continues processing records in batches, based on the value that you specify in [CreateEventSourceMapping](API_CreateEventSourceMapping.md) >`BatchSize`, until the function catches up with the topic\. +Lambda processes records from one or more Kafka topic partitions that you specify and sends a JSON payload to your function\. When more records are available, Lambda continues processing records in batches, based on the `BatchSize` value that you specify in a [CreateEventSourceMapping](API_CreateEventSourceMapping.md) request, until your function catches up with the topic\. -If your Lambda function returns an error for any of the messages in a batch, Lambda retries the whole batch of messages until processing succeeds or the messages expire\. +If your function returns an error for any of the messages in a batch, Lambda retries the whole batch of messages until processing succeeds or the messages expire\. -The maximum amount of time that Lambda lets a function run before stopping it is 14 minutes\. +Lambda can run your function for up to 14 minutes\. Configure your function timeout to be 14 minutes or less \(the default timeout value is 3 seconds\)\. Lambda may retry invocations that exceed 14 minutes\. ## Auto scaling of the Kafka event source -When you initially create an Apache Kafka [event source](invocation-eventsourcemapping.md), Lambda allocates one consumer to process all of the partitions in the Kafka topic\. Lambda automatically scales up or down the number of consumers, based on workload\. To preserve message ordering in each partition, the maximum number of consumers is one consumer per partition in the topic\. +When you initially create an an Apache Kafka [event source](invocation-eventsourcemapping.md), Lambda allocates one consumer to process all partitions in the Kafka topic\. Each consumer has multiple processors running in parallel to handle increased workloads\. Additionally, Lambda automatically scales up or down the number of consumers, based on workload\. To preserve message ordering in each partition, the maximum number of consumers is one consumer per partition in the topic\. -Every 15 minutes, Lambda evaluates the consumer offset lag of all the partitions in the topic\. If the lag is too high, the partition is receiving messages faster than Lambda can process them\. If necessary, Lambda adds or removes consumers from the topic\. +In one\-minute intervals, Lambda evaluates the consumer offset lag of all the partitions in the topic\. If the lag is too high, the partition is receiving messages faster than Lambda can process them\. If necessary, Lambda adds or removes consumers from the topic\. The scaling process of adding or removing consumers occurs within three minutes of evaluation\. If your target Lambda function is overloaded, Lambda reduces the number of consumers\. This action reduces the workload on the function by reducing the number of messages that consumers can retrieve and send to the function\. @@ -249,7 +417,7 @@ To monitor the throughput of your Kafka topic, you can view the Apache Kafka con When you add your Kafka cluster as an [event source](invocation-eventsourcemapping.md) for your Lambda function using the Lambda console, an AWS SDK, or the AWS CLI, Lambda uses APIs to process your request\. -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) @@ -263,20 +431,26 @@ When you add your Apache Kafka cluster as an [event source](invocation-eventsour To determine the cause of a stopped consumer, check the `StateTransitionReason` field in the response of `EventSourceMapping`\. The following list describes the event source errors that you can receive: **`ESM_CONFIG_NOT_VALID`** -The event source mapping configuration is not valid\. +The event source mapping configuration isn't valid\. **`EVENT_SOURCE_AUTHN_ERROR`** -Lambda could not authenticate the event source\. +Lambda couldn't authenticate the event source\. **`EVENT_SOURCE_AUTHZ_ERROR`** -Lambda does not have the required permissions to access the event source\. +Lambda doesn't have the required permissions to access the event source\. **`FUNCTION_CONFIG_NOT_VALID`** -The function configuration is not valid\. +The function configuration isn't valid\. **Note** If your Lambda event records exceed the allowed size limit of 6 MB, they can go unprocessed\. +## Amazon CloudWatch metrics + +Lambda emits the `OffsetLag` metric while your function processes records\. The value of this metric is the difference in offset between the last record written to the Kafka event source topic, and the last record that Lambda processed\. You can use `OffsetLag` to estimate the latency between when a record is added and when your function processes it\. + +An increasing trend in `OffsetLag` can indicate issues with your function\. For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. + ## Self\-managed Apache Kafka configuration parameters All Lambda event source types share the same [CreateEventSourceMapping](API_CreateEventSourceMapping.md) and [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) API operations\. However, only some of the parameters apply to Apache Kafka\. diff --git a/doc_source/with-kinesis-create-package.md b/doc_source/with-kinesis-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-kinesis-example-use-app-spec.md b/doc_source/with-kinesis-example-use-app-spec.md old mode 100644 new mode 100755 diff --git a/doc_source/with-kinesis-example.md b/doc_source/with-kinesis-example.md old mode 100644 new mode 100755 index 247b3ac0..269b3479 --- a/doc_source/with-kinesis-example.md +++ b/doc_source/with-kinesis-example.md @@ -122,7 +122,7 @@ Invoke your Lambda function manually using the `invoke` AWS Lambda CLI command a aws lambda invoke --function-name ProcessKinesisRecords --payload file://input.txt out.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. The response is saved to `out.txt`\. diff --git a/doc_source/with-kinesis.md b/doc_source/with-kinesis.md old mode 100644 new mode 100755 index d60e978d..139150a5 --- a/doc_source/with-kinesis.md +++ b/doc_source/with-kinesis.md @@ -53,13 +53,13 @@ Lambda reads records from the data stream and invokes your function [synchronous } ``` -By default, Lambda invokes your function as soon as records are available in the stream\. If the batch that Lambda reads from the stream only has one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to five minutes by configuring a *batch window*\. Before invoking the function, Lambda continues to read records from the stream until it has gathered a full batch, or until the batch window expires\. +By default, Lambda invokes your function as soon as records are available\. If the batch that Lambda reads from the event source has only one record in it, Lambda sends only one record to the function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to 5 minutes by configuring a *batching window*\. Before invoking the function, Lambda continues to read records from the event source until it has gathered a full batch, the batching window expires, or the batch reaches the payload limit of 6 MB\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. If your function returns an error, Lambda retries the batch until processing succeeds or the data expires\. To avoid stalled shards, you can configure the event source mapping to retry with a smaller batch size, limit the number of retries, or discard records that are too old\. To retain discarded events, you can configure the event source mapping to send details about failed batches to an SQS queue or SNS topic\. You can also increase concurrency by processing multiple batches from each shard in parallel\. Lambda can process up to 10 batches in each shard simultaneously\. If you increase the number of concurrent batches per shard, Lambda still ensures in\-order processing at the partition\-key level\. -Configure the `ParallelizationFactor` setting to process one shard of a Kinesis or DynamoDB data stream with more than one Lambda invocation simultaneously\. You can specify the number of concurrent batches that Lambda polls from a shard via a parallelization factor from 1 \(default\) to 10\. For example, when `ParallelizationFactor` is set to 2, you can have 200 concurrent Lambda invocations at maximum to process 100 Kinesis data shards\. This helps scale up the processing throughput when the data volume is volatile and the `IteratorAge` is high\. Note that parallelization factor will not work if you are using Kinesis aggregation\. For more information, see [New AWS Lambda scaling controls for Kinesis and DynamoDB event sources](http://aws.amazon.com/blogs/compute/new-aws-lambda-scaling-controls-for-kinesis-and-dynamodb-event-sources/)\. Also, see the [Serverless Data Processing on AWS](https://data-processing.serverlessworkshops.io/) workshop for complete tutorials\. +Configure the `ParallelizationFactor` setting to process one shard of a Kinesis or DynamoDB data stream with more than one Lambda invocation simultaneously\. You can specify the number of concurrent batches that Lambda polls from a shard via a parallelization factor from 1 \(default\) to 10\. For example, when you set `ParallelizationFactor` to 2, you can have 200 concurrent Lambda invocations at maximum to process 100 Kinesis data shards\. This helps scale up the processing throughput when the data volume is volatile and the `IteratorAge` is high\. Note that parallelization factor will not work if you are using Kinesis aggregation\. For more information, see [New AWS Lambda scaling controls for Kinesis and DynamoDB event sources](http://aws.amazon.com/blogs/compute/new-aws-lambda-scaling-controls-for-kinesis-and-dynamodb-event-sources/)\. Also, see the [Serverless Data Processing on AWS](https://data-processing.serverlessworkshops.io/) workshop for complete tutorials\. **Topics** + [Configuring your data stream and function](#services-kinesis-configure) @@ -118,7 +118,7 @@ Lambda needs the following permissions to manage resources that are related to y The `AWSLambdaKinesisExecutionRole` managed policy includes these permissions\. For more information, see [AWS Lambda execution role](lambda-intro-execution-role.md)\. -To send records of failed batches to a queue or topic, your function needs additional permissions\. Each destination service requires a different permission, as follows: +To send records of failed batches to an SQS queue or SNS topic, your function needs additional permissions\. Each destination service requires a different permission, as follows: + **Amazon SQS** – [sqs:SendMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) + **Amazon SNS** – [sns:Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) @@ -130,15 +130,15 @@ To configure your function to read from Kinesis in the Lambda console, create a **To create a trigger** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. -1. Choose a function\. +1. Choose the name of a function\. 1. Under **Function overview**, choose **Add trigger**\. 1. Choose a trigger type\. -1. Configure the required options and then choose **Add**\. +1. Configure the required options, and then choose **Add**\. Lambda supports the following options for Kinesis event sources\. @@ -153,11 +153,11 @@ Lambda supports the following options for Kinesis event sources\. + **At timestamp** – Process records starting from a specific time\. After processing any existing records, the function is caught up and continues to process new records\. -+ **On\-failure destination** – An SQS queue or SNS topic for records that can't be processed\. When Lambda discards a batch of records because it's too old or has exhausted all retries, it sends details about the batch to the queue or topic\. ++ **On\-failure destination** – An SQS queue or SNS topic for records that can't be processed\. When Lambda discards a batch of records that's too old or has exhausted all retries, Lambda sends details about the batch to the queue or topic\. + **Retry attempts** – The maximum number of times that Lambda retries when the function returns an error\. This doesn't apply to service errors or throttles where the batch didn't reach the function\. + **Maximum age of record** – The maximum age of a record that Lambda sends to your function\. + **Split batch on error** – When the function returns an error, split the batch into two before retrying\. -+ **Concurrent batches per shard** – Process multiple batches from the same shard concurrently\. ++ **Concurrent batches per shard** – Concurrently process multiple batches from the same shard\. + **Enabled** – Set to true to enable the event source mapping\. Set to false to stop processing records\. Lambda keeps track of the last record processed and resumes processing from that point when it's reenabled\. **Note** @@ -167,7 +167,7 @@ To manage the event source configuration later, choose the trigger in the design ## Event source mapping API -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) @@ -274,7 +274,7 @@ aws lambda update-event-source-mapping --uuid 2b733gdc-8ac3-cdf5-af3a-1827b3b112 ## Error handling -The event source mapping that reads records from your Kinesis stream invokes your function synchronously and retries on errors\. If the function is throttled or the Lambda service returns an error without invoking the function, Lambda retries until the records expire or exceed the maximum age that you configure on the event source mapping\. +The event source mapping that reads records from your Kinesis stream, invokes your function synchronously, and retries on errors\. If Lambda throttles the function or returns an error without invoking the function, Lambda retries until the records expire or exceed the maximum age that you configure on the event source mapping\. If the function receives the records but returns an error, Lambda retries until the records in the batch expire, exceed the maximum age, or reach the configured retry quota\. For function errors, you can also configure the event source mapping to split a failed batch into two batches\. Retrying with smaller batches isolates bad records and works around timeout issues\. Splitting a batch does not count towards the retry quota\. @@ -284,7 +284,7 @@ To retain a record of discarded batches, configure a failed\-event destination\. **To configure a destination for failed\-event records** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose a function\. @@ -302,7 +302,7 @@ To retain a record of discarded batches, configure a failed\-event destination\. The following example shows an invocation record for a Kinesis stream\. -**Example invocation Record** +**Example invocation record** ``` { @@ -337,7 +337,7 @@ You can use this information to retrieve the affected records from the stream fo Lambda emits the `IteratorAge` metric when your function finishes processing a batch of records\. The metric indicates how old the last record in the batch was when processing finished\. If your function is processing new events, you can use the iterator age to estimate the latency between when a record is added and when the function processes it\. -An increasing trend in iterator age can indicate issues with your function\. For more information, see [Working with AWS Lambda function metrics](monitoring-metrics.md)\. +An increasing trend in iterator age can indicate issues with your function\. For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. ## Time windows diff --git a/doc_source/with-mq.md b/doc_source/with-mq.md old mode 100644 new mode 100755 index d9414499..b3fa1075 --- a/doc_source/with-mq.md +++ b/doc_source/with-mq.md @@ -34,10 +34,12 @@ By default, Amazon MQ has a weekly maintenance window for brokers\. During that To interact with Amazon MQ, Lambda creates a consumer group which can read from your Amazon MQ brokers\. The consumer group is created with the same ID as the event source mapping UUID\. -Lambda will pull messages until it has processed a maximum of 6 MB, until timeout, or until the batch size is fulfilled\. When configured, batch size determines the maximum number of items to retrieve in a single batch\. Your batch is converted into a Lambda payload, and your target function is invoked\. Messages are neither persisted nor deserialized\. Instead, they are retrieved by the consumer group as a BLOB of bytes and are base64\-encoded for a JSON payload\. +For Amazon MQ event sources, Lambda batches records together and sends them to your function in a single payload\. To control behavior, you can configure the batching window and batch size\. Lambda pulls messages until it processes the payload size maximum of 6 MB, the batching window expires, or the number of records reaches the full batch size\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. + +Lambda converts your batch into a single payload, and then invokes your function\. Messages are neither persisted nor deserialized\. Instead, the consumer group retrieves them as a BLOB of bytes, and then base64\-encodes them into a JSON payload\. If your function returns an error for any of the messages in a batch, Lambda retries the whole batch of messages until processing succeeds or the messages expire\. **Note** -The maximum function invocation time is 14 minutes\. +Lambda can run your function for up to 14 minutes\. Configure your function timeout to be 14 minutes or less \(the default timeout value is 3 seconds\)\. Lambda may retry invocations that exceed 14 minutes\. You can monitor a given function's concurrency usage using the `ConcurrentExecutions` metric in Amazon CloudWatch\. For more information about concurrency, see [Managing Lambda reserved concurrency](configuration-concurrency.md)\. @@ -159,15 +161,15 @@ To configure your function to read from Amazon MQ, create an **MQ** trigger in t **To create a trigger** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. -1. Choose a function\. +1. Choose the name of a function\. 1. Under **Function overview**, choose **Add trigger**\. 1. Choose a trigger type\. -1. Configure the required options and then choose **Add**\. +1. Configure the required options, and then choose **Add**\. Lambda supports the following options for Amazon MQ event sources: + **MQ broker** – Select an Amazon MQ broker\. @@ -180,7 +182,7 @@ To enable or disable the trigger \(or delete it\), choose the **MQ** trigger in ## Event source mapping API -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) @@ -310,7 +312,7 @@ All Lambda event source types share the same [CreateEventSourceMapping](API_Crea | Parameter | Required | Default | Notes | | --- | --- | --- | --- | -| BatchSize | N | 100 | Maximum: 10000 | +| BatchSize | N | 100 | Maximum: 10,000 | | Enabled | N | true | | | FunctionName | Y | | | | Queues | N | | The name of the Amazon MQ broker destination queue to consume\. | diff --git a/doc_source/with-msk.md b/doc_source/with-msk.md old mode 100644 new mode 100755 index 21cbc233..e40d9def --- a/doc_source/with-msk.md +++ b/doc_source/with-msk.md @@ -1,14 +1,16 @@ # Using Lambda with Amazon MSK -[Amazon Managed Streaming for Apache Kafka \(Amazon MSK\)](https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html) is a fully managed service that you can use to build and run applications that use Apache Kafka to process streaming data\. Amazon MSK simplifies the setup, scaling, and management of clusters running Kafka\. Amazon MSK also makes it easier to configure your application for multiple Availability Zones and for security with AWS Identity and Access Management \(IAM\)\. Additionally, Amazon MSK supports multiple open\-source versions of Kafka\. +[Amazon Managed Streaming for Apache Kafka \(Amazon MSK\)](https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html) is a fully managed service that you can use to build and run applications that use Apache Kafka to process streaming data\. Amazon MSK simplifies the setup, scaling, and management of clusters running Kafka\. Amazon MSK also makes it easier to configure your application for multiple Availability Zones and for security with AWS Identity and Access Management \(IAM\)\. Amazon MSK supports multiple open\-source versions of Kafka\. Amazon MSK as an event source operates similarly to using Amazon Simple Queue Service \(Amazon SQS\) or Amazon Kinesis\. Lambda internally polls for new messages from the event source and then synchronously invokes the target Lambda function\. Lambda reads the messages in batches and provides these to your function as an event payload\. The maximum batch size is configurable\. \(The default is 100 messages\.\) -For an example of how to configure Amazon MSK as an event source, see [Using Amazon MSK as an event source for AWS Lambda](http://aws.amazon.com/blogs/compute/using-amazon-msk-as-an-event-source-for-aws-lambda/) on the AWS Compute Blog\. Also, see [ Amazon MSK Lambda Integration](https://amazonmsk-labs.workshop.aws/en/msklambda.html) in the Amazon MSK Labs for a complete tutorial\. +For an example of how to configure Amazon MSK as an event source, see [Using Amazon MSK as an event source for AWS Lambda](http://aws.amazon.com/blogs/compute/using-amazon-msk-as-an-event-source-for-aws-lambda/) on the AWS Compute Blog\. For a complete tutorial, see [ Amazon MSK Lambda Integration](https://amazonmsk-labs.workshop.aws/en/msklambda.html) in the Amazon MSK Labs\. -Lambda reads the messages sequentially for each partition\. After Lambda processes each batch, it commits the offsets of the messages in that batch\. If your function times out or returns an error for any of the messages in a batch, Lambda retries the whole batch of messages until processing succeeds or the messages expire\. +For Kafka\-based event sources, Lambda supports processing control parameters, such as batching windows and batch size\. For more information, see [Batching behavior](invocation-eventsourcemapping.md#invocation-eventsourcemapping-batching)\. -For Amazon MSK invocations, Lambda allows the function to run for up to 14 minutes\. Set your function timeout value to 14 minutes or less \(the default timeout value is 3 seconds\)\. +Lambda reads the messages sequentially for each partition\. After Lambda processes each batch, it commits the offsets of the messages in that batch\. If your function returns an error for any of the messages in a batch, Lambda retries the whole batch of messages until processing succeeds or the messages expire\. + +Lambda can run your function for up to 14 minutes\. Configure your function timeout to be 14 minutes or less \(the default timeout value is 3 seconds\)\. Lambda may retry invocations that exceed 14 minutes\. Lambda sends the batch of messages in the event parameter when it invokes your function\. The event payload contains an array of messages\. Each array item contains details of the Amazon MSK topic and partition identifier, together with a timestamp and a base64\-encoded message\. @@ -48,37 +50,46 @@ Lambda sends the batch of messages in the event parameter when it invokes your f } ``` +For an example of how to use Amazon MSK as an event source, see [Using Amazon MSK as an event source for AWS Lambda](http://aws.amazon.com/blogs/compute/using-amazon-msk-as-an-event-source-for-aws-lambda/) on the AWS Compute Blog\. For a complete tutorial, see [Amazon MSK Lambda Integration](https://amazonmsk-labs.workshop.aws/en/msklambda.html) in the Amazon MSK Labs\. + **Topics** -+ [Managing access and permissions](#msk-permissions) ++ [MSK cluster authentication](#msk-cluster-permissions) ++ [Managing API access and permissions](#msk-permissions) ++ [Authentication and authorization errors](#msk-permissions-errors) + [Network configuration](#services-msk-vpc-config) + [Adding Amazon MSK as an event source](#services-msk-topic-add) + [Auto scaling of the Amazon MSK event source](#services-msk-ops-scaling) ++ [Amazon CloudWatch metrics](#services-msk-metrics) + [Amazon MSK configuration parameters](#services-msk-parms) -## Managing access and permissions +## MSK cluster authentication -You can use IAM access control to handle both authentication and authorization for your Amazon MSK cluster\. This eliminates the need to use one mechanism for authentication and a different mechanism for authorization\. For example, when a client tries to write to your cluster, Amazon MSK uses IAM to check whether that client is an authenticated identity and also whether it is authorized to produce to your cluster\. +Lambda needs permission to access the Amazon MSK cluster, retrieve records, and perform other tasks\. Amazon MSK supports several options for controlling client access to the MSK cluster\. -As an alternative, you can use SASL/SCRAM to authenticate clients and [Apache Kafka ACLs](https://docs.aws.amazon.com/msk/latest/developerguide/msk-acls.html) to control access\. +**Topics** ++ [Unauthenticated access](#msk-permissions-none) ++ [SASL/SCRAM authentication](#msk-permissions-add-secret) ++ [IAM role\-based authentication](#msk-permissions-iam-policy) ++ [Mutual TLS authentication](#msk-permissions-mTLS) ++ [Configuring the mTLS secret](#smaa-auth-secret) -### Required Lambda function permissions +### Unauthenticated access -Your Lambda function's [execution role](lambda-intro-execution-role.md) must have permission to read records from your Amazon MSK cluster on your behalf\. You can either add the AWS managed policy `AWSLambdaMSKExecutionRole` to your execution role, or create a custom policy with permission to perform the following actions: -+ [kafka:DescribeCluster](https://docs.aws.amazon.com/msk/1.0/apireference/clusters-clusterarn.html#clusters-clusterarnget) -+ [kafka:GetBootstrapBrokers](https://docs.aws.amazon.com/msk/1.0/apireference/clusters-clusterarn-bootstrap-brokers.html#clusters-clusterarn-bootstrap-brokersget) -+ [ec2:CreateNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) -+ [ec2:DescribeNetworkInterfaces](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) -+ [ec2:DescribeVpcs](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html) -+ [ec2:DeleteNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteNetworkInterface.html) -+ [ec2:DescribeSubnets](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html) -+ [ec2:DescribeSecurityGroups](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) -+ [logs:CreateLogGroup](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html) -+ [logs:CreateLogStream](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogStream.html) -+ [logs:PutLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) +If no clients access the cluster over the internet, you can use unauthenticated access\. + +### SASL/SCRAM authentication -### Additional function permissions for IAM authorization +Amazon MSK supports Simple Authentication and Security Layer/Salted Challenge Response Authentication Mechanism \(SASL/SCRAM\) authentication with Transport Layer Security \(TLS\) encryption\. For Lambda to connect to the cluster, you store the authentication credentials \(user name and password\) in an AWS Secrets Manager secret\. -If you plan to use IAM authorization, you need to add the following additional permissions: +For more information about using Secrets Manager, see [User name and password authentication with AWS Secrets Manager](https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. + +Amazon MSK doesn't support SASL/PLAIN authentication\. + +### IAM role\-based authentication + +You can use IAM to authenticate the identity of clients that connect to the MSK cluster\. To create and deploy IAM user or role\-based policies, use the IAM console or API\. For more information, see [IAM access control](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. + +To allow Lambda to connect to the MSK cluster, read records, and perform other required actions, add the following permissions to your function's [execution role](lambda-intro-execution-role.md)\. ``` { @@ -95,18 +106,110 @@ If you plan to use IAM authorization, you need to add the following additional p "kafka-cluster:DescribeClusterDynamicConfiguration" ], "Resource": [ - "arn:aws:kafka:::cluster//", - "arn:aws:kafka:::topic///", - "arn:aws:kafka:::group///" + "arn:aws:kafka:region:account-id:cluster/cluster-name/cluster-uuid", + "arn:aws:kafka:region:account-id:topic/cluster-name/cluster-uuid/topic-name", + "arn:aws:kafka:region:account-id:group/cluster-name/cluster-uuid/group-name" ] } ] } ``` -You can scope these permissions to a specific cluster, topic and group\. See [Amazon MSK Kafka actions](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html#kafka-actions) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. The group name that Lambda uses is equivalent to the event source mapping’s UUID\. +You can scope these permissions to a specific cluster, topic, and group\. For more information, see the [Amazon MSK Kafka actions](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html#kafka-actions) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. The group name that IAM uses is equivalent to the event source mapping's UUID\. + +### Mutual TLS authentication + +Mutual TLS \(mTLS\) provides two\-way authentication between the client and server\. The client sends a certificate to the server for the server to verify the client, and the server sends a certificate to the client for the client to verify the server\. + +For Amazon MSK, Lambda acts as the client\. You configure a client certificate \(as a secret in Secrets Manager\) to authenticate Lambda with the brokers in your MSK cluster\. The client certificate must be signed by a CA in the server's trust store\. The MSK cluster sends a server certificate to Lambda to authenticate the brokers with Lambda\. The server certificate must be signed by a certificate authority \(CA\) that's in the AWS trust store\. + +For instructions on how to generate a client certificate, see [ Introducing mutual TLS authentication for Amazon MSK as an event source](http://aws.amazon.com/blogs/compute/introducing-mutual-tls-authentication-for-amazon-msk-as-an-event-source)\. + +Amazon MSK doesn't support self\-signed server certificates, because all brokers in Amazon MSK use [public certificates](https://docs.aws.amazon.com/msk/latest/developerguide/msk-encryption.html) signed by [Amazon Trust Services CAs](https://www.amazontrust.com/repository/), which Lambda trusts by default\. + + + +For more information about mTLS for Amazon MSK, see [Mutual TLS Authentication](https://docs.aws.amazon.com/msk/latest/developerguide/msk-authentication.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. + +### Configuring the mTLS secret + +The CLIENT\_CERTIFICATE\_TLS\_AUTH secret requires a certificate field and a private key field\. For an encrypted private key, the secret requires a private key password\. Both the certificate and private key must be in PEM format\. + +**Note** +Lambda supports the [PBES1](https://datatracker.ietf.org/doc/html/rfc2898/#section-6.1) \(but not PBES2\) private key encryption algorithms\. + +The certificate field must contain a list of certificates, beginning with the client certificate, followed by any intermediate certificates, and ending with the root certificate\. Each certificate must start on a new line with the following structure: + +``` +-----BEGIN CERTIFICATE----- + +-----END CERTIFICATE----- +``` + +Secrets Manager supports secrets up to 65,536 bytes, which is enough space for long certificate chains\. + +The private key must be in [PKCS \#8](https://datatracker.ietf.org/doc/html/rfc5208) format, with the following structure: + +``` +-----BEGIN PRIVATE KEY----- + +-----END PRIVATE KEY----- +``` -### Adding a policy to your execution role +For an encrypted private key, use the following structure: + +``` +-----BEGIN ENCRYPTED PRIVATE KEY----- + +-----END ENCRYPTED PRIVATE KEY----- +``` + +The following example shows the contents of a secret for mTLS authentication using an encrypted private key\. For an encrypted private key, you include the private key password in the secret\. + +``` +{ + "privateKeyPassword": "testpassword", + "certificate": "-----BEGIN CERTIFICATE----- +MIIE5DCCAsygAwIBAgIRAPJdwaFaNRrytHBto0j5BA0wDQYJKoZIhvcNAQELBQAw +... +j0Lh4/+1HfgyE2KlmII36dg4IMzNjAFEBZiCRoPimO40s1cRqtFHXoal0QQbIlxk +cmUuiAii9R0= +-----END CERTIFICATE----- +-----BEGIN CERTIFICATE----- +MIIFgjCCA2qgAwIBAgIQdjNZd6uFf9hbNC5RdfmHrzANBgkqhkiG9w0BAQsFADBb +... +rQoiowbbk5wXCheYSANQIfTZ6weQTgiCHCCbuuMKNVS95FkXm0vqVD/YpXKwA/no +c8PH3PSoAaRwMMgOSA2ALJvbRz8mpg== +-----END CERTIFICATE-----", + "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFKzBVBgkqhkiG9w0BBQ0wSDAnBgkqhkiG9w0BBQwwGgQUiAFcK5hT/X7Kjmgp +... +QrSekqF+kWzmB6nAfSzgO9IaoAaytLvNgGTckWeUkWn/V0Ck+LdGUXzAC4RxZnoQ +zp2mwJn2NYB7AZ7+imp0azDZb+8YG2aUCiyqb6PnnA== +-----END ENCRYPTED PRIVATE KEY-----" +} +``` + +## Managing API access and permissions + +In addition to accessing the Amazon MSK cluster, your function needs permissions to perform various Amazon MSK API actions\. You add these permissions to the function's execution role\. If your users need access to any of the Amazon MSK API actions, add the required permissions to the identity policy for the IAM user or role\. + +### Required Lambda function execution role permissions + +Your Lambda function's [execution role](lambda-intro-execution-role.md) must have the following permissions to access the MSK cluster on your behalf\. You can either add the AWS managed policy `AWSLambdaMSKExecutionRole` to your execution role, or create a custom policy with permission to perform the following actions: ++ [kafka:DescribeCluster](https://docs.aws.amazon.com/msk/1.0/apireference/clusters-clusterarn.html#clusters-clusterarnget) ++ [kafka:GetBootstrapBrokers](https://docs.aws.amazon.com/msk/1.0/apireference/clusters-clusterarn-bootstrap-brokers.html#clusters-clusterarn-bootstrap-brokersget) ++ [ec2:CreateNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) ++ [ec2:DescribeNetworkInterfaces](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) ++ [ec2:DescribeVpcs](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html) ++ [ec2:DeleteNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteNetworkInterface.html) ++ [ec2:DescribeSubnets](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html) ++ [ec2:DescribeSecurityGroups](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) ++ [logs:CreateLogGroup](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html) ++ [logs:CreateLogStream](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogStream.html) ++ [logs:PutLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) + +### Adding permissions to your execution role Follow these steps to add the AWS managed policy `AWSLambdaMSKExecutionRole` to your execution role using the IAM console\. @@ -120,9 +223,9 @@ Follow these steps to add the AWS managed policy `AWSLambdaMSKExecutionRole` to 1. On the **Attach policy** page, select your execution role from the list, and then choose **Attach policy**\. -### Granting users access with an IAM policy +### Granting users access with an IAM policy -By default, IAM users and roles do not have permission to perform Amazon MSK API operations\. To grant access to users in your organization or account, you might need an identity\-based policy\. For more information, see [Amazon MSK Identity\-Based Policy Examples](https://docs.aws.amazon.com/msk/latest/developerguide/security_iam_id-based-policy-examples.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. +By default, IAM users and roles don't have permission to perform Amazon MSK API operations\. To grant access to users in your organization or account, you can add or update an identity\-based policy\. For more information, see [Amazon MSK Identity\-Based Policy Examples](https://docs.aws.amazon.com/msk/latest/developerguide/security_iam_id-based-policy-examples.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. ### Using SASL/SCRAM authentication @@ -130,43 +233,63 @@ Amazon MSK supports Simple Authentication and Security Layer/Salted Challenge Re Note that Amazon MSK does not support SASL/PLAIN authentication\. -### Authentication and authorization Errors +## Authentication and authorization errors -If any of the required permissions to consume data from the Amazon MSK cluster are missing, Lambda displays an error message in the event source mapping under **LastProcessingResult**\. +If any of the permissions required to consume data from the Amazon MSK cluster are missing, Lambda displays one of the following error messages in the event source mapping under **LastProcessingResult**\. -The following error message results from authorization errors\. +**Topics** ++ [Cluster failed to authorize Lambda](#msk-authorize-errors) ++ [SASL authentication failed](#msk-sasl-errors) ++ [Server failed to authenticate Lambda](#msk-mtls-errors) ++ [Provided certificate or private key is invalid](#msk-key-errors) + +### Cluster failed to authorize Lambda -**Example Cluster failed to authorize Lambda** -For SASL/SCRAM, the provided user does not have all of the required Kafka ACL permissions: +For SASL/SCRAM or mTLS, this error indicates that the provided user doesn't have all of the following required Kafka access control list \(ACL\) permissions: + DescribeConfigs Cluster + Describe Group + Read Group + Describe Topic + Read Topic -For IAM access control, the execution role is missing one or more of the permissions required to access the group or topic\. To add the missing permissions to the role, see the example in [Additional function permissions for IAM authorization](#msk-permissions-iam-auth) -When you create either Kafka ACLs or an IAM policy with the required kafka\-cluster permissions listed previously, you must specify the topic and group as resources\. The topic name must match the topic in the event source mapping and the group name must match the event source mapping’s UUID\. -After you add the required permissions to the execution role, there might be a delay of several minutes before the changes take effect\. -The following error message results from authentication failures\. +For IAM access control, your function's execution role is missing one or more of the permissions required to access the group or topic\. Review the list of required permissions in [ IAM role\-based authentication](#msk-permissions-iam-policy)\. + +When you create either Kafka ACLs or an IAM policy with the required Kafka cluster permissions, specify the topic and group as resources\. The topic name must match the topic in the event source mapping\. The group name must match the event source mapping's UUID\. + +After you add the required permissions to the execution role, it might take several minutes for the changes to take effect\. + +### SASL authentication failed -**Example SASL authentication failed** -For SASL/SCRAM, this failure indicates that the provided username and password are invalid\. -For IAM access control, the execution role is missing `kafka-cluster:Connect` permissions for the cluster\. Add this permission to the role and specify the cluster ARN as a resource\. -You might see this error intermittently if the cluster rejects connections because it reached the TCP connection limit set by [Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/limits.html)\. Lambda backs off and retries until a connection is successful\. The last processing result will eventually change to “OK” after Lambda successfully connects to and polls from the cluster\. +For SASL/SCRAM, this error indicates that the provided user name and password aren't valid\. + +For IAM access control, the execution role is missing the `kafka-cluster:Connect` permission for the MSK cluster\. Add this permission to the role and specify the cluster's Amazon Resource Name \(ARN\) as a resource\. + +You might see this error occurring intermittently\. The cluster rejects connections after the number of TCP connections exceeds the [Amazon MSK service quota](https://docs.aws.amazon.com/msk/latest/developerguide/limits.html)\. Lambda backs off and retries until a connection is successful\. After Lambda connects to the cluster and polls for records, the last processing result changes to `OK`\. + +### Server failed to authenticate Lambda + +This error indicates that the Amazon MSK Kafka brokers failed to authenticate with Lambda\. This can occur for any of the following reasons: ++ You didn't provide a client certificate for mTLS authentication\. ++ You provided a client certificate, but the brokers aren't configured to use mTLS\. ++ A client certificate isn't trusted by the brokers\. + +### Provided certificate or private key is invalid + +This error indicates that the Amazon MSK consumer couldn't use the provided certificate or private key\. Make sure that the certificate and key use PEM format, and that the private key encryption uses a PBES1 algorithm\. ## Network configuration Lambda must have access to the Amazon Virtual Private Cloud \(Amazon VPC\) resources associated with your Amazon MSK cluster\. We recommend that you deploy AWS PrivateLink [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-services-overview.html) for Lambda and AWS Security Token Service \(AWS STS\)\. If authentication is required, also deploy a VPC endpoint for Secrets Manager\. -Alternatively, ensure that the VPC associated with your Amazon MSK cluster includes one NAT gateway per public subnet\. For more information, see [Internet and service access for VPC\-connected functions](configuration-vpc.md#vpc-internet)\. +Alternatively, ensure that the VPC associated with your MSK cluster includes one NAT gateway per public subnet\. For more information, see [Internet and service access for VPC\-connected functions](configuration-vpc.md#vpc-internet)\. -You must configure your Amazon VPC security groups with the following rules \(at minimum\): -+ Inbound rules – Allow all traffic on the MSK broker port \(9092 for plaintext, 9094 for TLS, 9096 for SASL, 9098 for IAM\) for the security groups specified for your event source\. -+ Outbound rules – Allow all traffic on port 443 for all destinations\. Allow all traffic on the MSK broker port \(9092 for plaintext, 9094 for TLS, 9096 for SASL, 9098 for IAM\) for the security groups specified for your event source\. -+ if you are using VPC endpoints instead of NAT Gateway, the security groups associated with the VPC endpoints must allow all inbound traffic on port 443 from the event source's security groups\. +Configure your Amazon VPC security groups with the following rules \(at minimum\): ++ Inbound rules – Allow all traffic on the Amazon MSK broker port \(9092 for plaintext, 9094 for TLS, 9096 for SASL, 9098 for IAM\) for the security groups specified for your event source\. ++ Outbound rules – Allow all traffic on port 443 for all destinations\. Allow all traffic on the Amazon MSK broker port \(9092 for plaintext, 9094 for TLS, 9096 for SASL, 9098 for IAM\) for the security groups specified for your event source\. ++ If you are using VPC endpoints instead of a NAT gateway, the security groups associated with the VPC endpoints must allow all inbound traffic on port 443 from the event source's security groups\. **Note** -Your Amazon VPC configuration is discoverable through the [Amazon MSK API](https://docs.aws.amazon.com/msk/1.0/apireference/resources.html), and does not need to be configured during setup using the create\-event\-source\-mapping command\. +Your Amazon VPC configuration is discoverable through the [Amazon MSK API](https://docs.aws.amazon.com/msk/1.0/apireference/resources.html)\. You don't need to configure it during setup using the create\-event\-source\-mapping command\. For more information about configuring the network, see [Setting up AWS Lambda with an Apache Kafka cluster within a VPC](http://aws.amazon.com/blogs/compute/setting-up-aws-lambda-with-an-apache-kafka-cluster-within-a-vpc/) on the AWS Compute Blog\. @@ -178,7 +301,7 @@ This section describes how to create an event source mapping using the Lambda co ### Prerequisites + An Amazon MSK cluster and a Kafka topic\. For more information, see [Getting Started Using Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/getting-started.html) in the *Amazon Managed Streaming for Apache Kafka Developer Guide*\. -+ A [Lambda execution role](lambda-intro-execution-role.md) with permission to access the AWS resources that your Amazon MSK cluster uses\. ++ An [execution role](lambda-intro-execution-role.md) with permission to access the AWS resources that your MSK cluster uses\. ### Adding an Amazon MSK trigger \(console\) @@ -204,7 +327,7 @@ Follow these steps to add your Amazon MSK cluster and a Kafka topic as a trigger 1. \(Optional\) For **Starting position**, choose **Latest** to start reading the stream from the latest record\. Or, choose **Trim horizon** to start at the earliest available record\. - 1. \(Optional\) For **Secret key**, choose the secret key for SASL/SCRAM authentication of the brokers in your Amazon MSK cluster\. If you are using IAM access control, do not choose a secret key\. + 1. \(Optional\) For **Authentication**, choose the secret key for authenticating with the brokers in your MSK cluster\. 1. To create the trigger in a disabled state for testing \(recommended\), clear **Enable trigger**\. Or, to enable the trigger immediately, select **Enable trigger**\. @@ -239,16 +362,22 @@ aws lambda get-event-source-mapping \ ## Auto scaling of the Amazon MSK event source -When you initially create an Amazon MSK event source, Lambda allocates one consumer to process all of the partitions in the Kafka topic\. Lambda automatically scales up or down the number of consumers, based on workload\. To preserve message ordering in each partition, the maximum number of consumers is one consumer per partition in the topic\. +When you initially create an Amazon MSK event source, Lambda allocates one consumer to process all partitions in the Kafka topic\. Each consumer has multiple processors running in parallel to handle increased workloads\. Additionally, Lambda automatically scales up or down the number of consumers, based on workload\. To preserve message ordering in each partition, the maximum number of consumers is one consumer per partition in the topic\. -Every 15 minutes, Lambda evaluates the consumer offset lag of all the partitions in the topic\. If the lag is too high, the partition is receiving messages faster than Lambda can process them\. If necessary, Lambda adds or removes consumers from the topic\. +In one\-minute intervals, Lambda evaluates the consumer offset lag of all the partitions in the topic\. If the lag is too high, the partition is receiving messages faster than Lambda can process them\. If necessary, Lambda adds or removes consumers from the topic\. The scaling process of adding or removing consumers occurs within three minutes of evaluation\. If your target Lambda function is overloaded, Lambda reduces the number of consumers\. This action reduces the workload on the function by reducing the number of messages that consumers can retrieve and send to the function\. -To monitor the throughput of your Kafka topic, you can view the [Amazon MSK consumer\-lag metrics](https://docs.aws.amazon.com/msk/latest/developerguide/consumer-lag.html)\. To help you find the metrics for this Lambda function, the value of the consumer group field in the logs is set to the event source UUID\. +To monitor the throughput of your Kafka topic, view the [Offset lag metric](#services-msk-metrics) Lambda emits while your function processes records\. To check how many function invocations occur in parallel, you can also monitor the [concurrency metrics](monitoring-metrics.md#monitoring-metrics-concurrency) for your function\. +## Amazon CloudWatch metrics + +Lambda emits the `OffsetLag` metric while your function processes records\. The value of this metric is the difference in offset between the last record written to the Kafka event source topic, and the last record that Lambda processed\. You can use `OffsetLag` to estimate the latency between when a record is added and when your function processes it\. + +An increasing trend in `OffsetLag` can indicate issues with your function\. For more information, see [Working with Lambda function metrics](monitoring-metrics.md)\. + ## Amazon MSK configuration parameters All Lambda event source types share the same [CreateEventSourceMapping](API_CreateEventSourceMapping.md) and [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) API operations\. However, only some of the parameters apply to Amazon MSK\. diff --git a/doc_source/with-on-demand-custom-android.md b/doc_source/with-on-demand-custom-android.md old mode 100644 new mode 100755 diff --git a/doc_source/with-s3-example-use-app-spec.md b/doc_source/with-s3-example-use-app-spec.md old mode 100644 new mode 100755 index 84dc7760..1195cf42 --- a/doc_source/with-s3-example-use-app-spec.md +++ b/doc_source/with-s3-example-use-app-spec.md @@ -1,6 +1,6 @@ # AWS SAM template for an Amazon S3 application -You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [ AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. +You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. Below is a sample AWS SAM template for the Lambda application from the [tutorial](with-s3-example.md)\. Copy the text below to a \.yaml file and save it next to the ZIP package you created previously\. Note that the `Handler` and `Runtime` parameter values should match the ones you used when you created the function in the previous section\. diff --git a/doc_source/with-s3-example.md b/doc_source/with-s3-example.md old mode 100644 new mode 100755 index b49efe60..6eb4fcf1 --- a/doc_source/with-s3-example.md +++ b/doc_source/with-s3-example.md @@ -46,7 +46,7 @@ Use a [function blueprint](gettingstarted-features.md#gettingstarted-features-bl **To create a Lambda function from a blueprint in the console** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose **Create function**\. @@ -238,14 +238,14 @@ Invoke your function when you upload a file to the Amazon S3 source bucket\. 1. On the **Upload** page, upload a few \.jpg or \.png image files to the bucket\. -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. 1. Choose the name of your function \(**my\-s3\-function**\)\. 1. To verify that the function ran once for each file that you uploaded, choose the **Monitor** tab\. This page shows graphs for the metrics that Lambda sends to CloudWatch\. The count in the **Invocations** graph should match the number of files that you uploaded to the Amazon S3 bucket\. ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/lambda/latest/dg/images/metrics-functions-list.png) - For more information on these graphs, see [Monitoring functions in the AWS Lambda console](monitoring-functions-access-metrics.md)\. + For more information on these graphs, see [Monitoring functions on the Lambda console](monitoring-functions-access-metrics.md)\. 1. \(Optional\) To view the logs in the CloudWatch console, choose **View logs in CloudWatch**\. Choose a log stream to view the logs output for one of the function invocations\. diff --git a/doc_source/with-s3-tutorial.md b/doc_source/with-s3-tutorial.md old mode 100644 new mode 100755 index 91b550fc..42c9c8bc --- a/doc_source/with-s3-tutorial.md +++ b/doc_source/with-s3-tutorial.md @@ -3,7 +3,7 @@ In this tutorial, you create a Lambda function and configure a trigger for Amazon Simple Storage Service \(Amazon S3\)\. Amazon S3 invokes the `CreateThumbnail` function for each image file that is uploaded to an S3 bucket\. The function reads the image object from the source S3 bucket and creates a thumbnail image to save in a target S3 bucket\. **Note** -This tutorial requires a moderate level of AWS and Lambda domain knowledge\. We recommend that you first try [Tutorial: Using an Amazon S3 trigger to invoke a Lambda function](with-s3-example.md)\. +This tutorial requires a moderate level of AWS and Lambda domain knowledge, Docker operations, and [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. We recommend that you first try [Tutorial: Using an Amazon S3 trigger to invoke a Lambda function](with-s3-example.md)\. In this tutorial, you use the AWS Command Line Interface \(AWS CLI\) to create the following AWS resources: @@ -488,7 +488,7 @@ The sample function must include the sharp module in the deployment package\. --role arn:aws:iam::123456789012:role/lambda-s3-role ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. The create\-function command specifies the function handler as `index.handler`\. This handler name reflects the function name as `handler`, and the name of the file where the handler code is stored as `index.js`\. For more information, see [AWS Lambda function handler in Node\.js](nodejs-handler.md)\. The command specifies a runtime of `nodejs12.x`\. For more information, see [Lambda runtimes](lambda-runtimes.md)\. @@ -502,7 +502,7 @@ The sample function must include the sharp module in the deployment package\. --role arn:aws:iam::123456789012:role/lambda-s3-role ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. The create\-function command specifies the function handler as `lambda_function.lambda_handler`\. This handler name reflects the function name as `lambda_handler`, and the name of the file where the handler code is stored as `lambda_function.py`\. For more information, see [Lambda function handler in Python](python-handler.md)\. The command specifies a runtime of `python3.8`\. For more information, see [Lambda runtimes](lambda-runtimes.md)\. @@ -516,7 +516,7 @@ The sample function must include the sharp module in the deployment package\. --role arn:aws:iam::123456789012:role/lambda-s3-role ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. The create\-function command specifies the function handler as `example.handler`\. The function can use the abbreviated handler format of `package.Class` because the function implements a handler interface\. For more information, see [AWS Lambda function handler in Java](java-handler.md)\. The command specifies a runtime of `java11`\. For more information, see [Lambda runtimes](lambda-runtimes.md)\. @@ -586,7 +586,7 @@ Invoke the Lambda function manually using sample Amazon S3 event data\. --payload file://inputFile.txt outputfile.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. 1. Verify that the thumbnail is created in the target S3 bucket\. diff --git a/doc_source/with-s3.md b/doc_source/with-s3.md old mode 100644 new mode 100755 index 29b23cba..0900fa4b --- a/doc_source/with-s3.md +++ b/doc_source/with-s3.md @@ -32,7 +32,7 @@ Amazon S3 invokes your function [asynchronously](invocation-async.md) with an ev "s3SchemaVersion": "1.0", "configurationId": "828aa6fc-f7b5-4305-8584-487c791949c1", "bucket": { - "name": "lambda-artifacts-deafc19498e3f2df", + "name": "DOC-EXAMPLE-BUCKET", "ownerIdentity": { "principalId": "A3I5XTEXAMAI3E" }, diff --git a/doc_source/with-scheduledevents-example-use-app-spec.md b/doc_source/with-scheduledevents-example-use-app-spec.md deleted file mode 100644 index 4cb7c422..00000000 --- a/doc_source/with-scheduledevents-example-use-app-spec.md +++ /dev/null @@ -1,52 +0,0 @@ -# AWS SAM template for a EventBridge \(CloudWatch Events\) application - -You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [ AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. - -Below is a sample AWS SAM template for the Lambda application from the [tutorial](services-cloudwatchevents-tutorial.md)\. Copy the text below to a \.yaml file and save it next to the ZIP package you created previously\. Note that the `Handler` and `Runtime` parameter values should match the ones you used when you created the function in the previous section\. - -**Example template\.yaml** - -``` -AWSTemplateFormatVersion: '2010-09-09' -Transform: AWS::Serverless-2016-10-31 -Parameters: - NotificationEmail: - Type: String -Resources: - CheckWebsitePeriodically: - Type: [AWS::Serverless::Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) - Properties: - Handler: LambdaFunctionOverHttps.handler - Runtime: runtime - Policies: AmazonDynamoDBFullAccess - Events: - CheckWebsiteScheduledEvent: - Type: Schedule - Properties: - Schedule: rate(1 minute) - - AlarmTopic: - Type: AWS::SNS::Topic - Properties: - Subscription: - - Protocol: email - Endpoint: !Ref NotificationEmail - - Alarm: - Type: AWS::CloudWatch::Alarm - Properties: - AlarmActions: - - !Ref AlarmTopic - ComparisonOperator: GreaterThanOrEqualToThreshold - Dimensions: - - Name: FunctionName - Value: !Ref CheckWebsitePeriodically - EvaluationPeriods: 1 - MetricName: Errors - Namespace: AWS/Lambda - Period: 60 - Statistic: Sum - Threshold: '1' -``` - -For information on how to package and deploy your serverless application using the package and deploy commands, see [Deploying serverless applications](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html) in the *AWS Serverless Application Model Developer Guide*\. \ No newline at end of file diff --git a/doc_source/with-secrets-manager.md b/doc_source/with-secrets-manager.md old mode 100644 new mode 100755 diff --git a/doc_source/with-sns-create-package.md b/doc_source/with-sns-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-sns-example.md b/doc_source/with-sns-example.md old mode 100644 new mode 100755 index b005ec46..e5f82e7b --- a/doc_source/with-sns-example.md +++ b/doc_source/with-sns-example.md @@ -24,19 +24,19 @@ On Linux and macOS, use your preferred shell and package manager\. On Windows 10 In the tutorial, you use two accounts\. The AWS CLI commands illustrate this by using two [named profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html), each configured for use with a different account\. If you use profiles with different names, or the default profile and one named profile, modify the commands as needed\. -## Create an Amazon SNS topic +## Create an Amazon SNS topic \(account A\) -From account A \(01234567891A\), create the source Amazon SNS topic\. +In **Account A**, create the source Amazon SNS topic\. ``` aws sns create-topic --name sns-topic-for-lambda --profile accountA ``` -Note the topic ARN that is returned by the command\. You will need it when you add permissions to the Lambda function to subscribe to the topic\. +After creating the topic, record its Amazon Resource Name \(ARN\)\. You need it later when you add permissions to the Lambda function to subscribe to the topic\. -## Create the execution role +## Create the execution role \(account B\) -From account B \(01234567891B\), create the [execution role](lambda-intro-execution-role.md) that gives your function permission to access AWS resources\. +In **Account B**, create the [execution role](lambda-intro-execution-role.md) that gives your function permission to access AWS resources\. **To create an execution role** @@ -51,9 +51,9 @@ From account B \(01234567891B\), create the [execution role](lambda-intro-execut The **AWSLambdaBasicExecutionRole** policy has the permissions that the function needs to write logs to CloudWatch Logs\. -## Create a Lambda function +## Create a Lambda function \(account B\) -From account B \(01234567891B\), create the function that processes events from Amazon SNS\. The following example code receives an Amazon SNS event input and processes the messages that it contains\. For illustration, the code writes some of the incoming event data to CloudWatch Logs\. +In **Account B**, create the function that processes events from Amazon SNS\. The following example code receives an Amazon SNS event input and processes the messages that it contains\. For illustration, the code writes some of the incoming event data to CloudWatch Logs\. **Note** For sample code in other languages, see [Sample function code](with-sns-create-package.md)\. @@ -87,27 +87,27 @@ exports.handler = function(event, context, callback) { ``` aws lambda create-function --function-name Function-With-SNS \ --zip-file fileb://function.zip --handler index.handler --runtime nodejs12.x \ - --role arn:aws:iam::01234567891B:role/service-role/lambda-sns-execution-role \ + --role arn:aws:iam:::role/service-role/lambda-sns-execution-role \ --timeout 60 --profile accountB ``` -Note the function ARN that is returned by the command\. You will need it when you add permissions to allow Amazon SNS to invoke your function\. +After creating the function, record its function ARN\. You need it later when you add permissions to allow Amazon SNS to invoke your function\. -## Set up cross\-account permissions +## Set up cross\-account permissions \(account A and B\) -From account A \(01234567891A\), grant permission to account B \(01234567891B\) to subscribe to the topic: +In **Account A**, grant permission to **Account B** to subscribe to the topic: ``` -aws sns add-permission --label lambda-access --aws-account-id 12345678901B \ ---topic-arn arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda \ +aws sns add-permission --label lambda-access --aws-account-id \ +--topic-arn arn:aws:sns:us-east-2::sns-topic-for-lambda \ --action-name Subscribe ListSubscriptionsByTopic --profile accountA ``` -From account B \(01234567891B\), add the Lambda permission to allow invocation from Amazon SNS\. +In **Account B**, add the Lambda permission to allow invocation from Amazon SNS\. ``` aws lambda add-permission --function-name Function-With-SNS \ ---source-arn arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda \ +--source-arn arn:aws:sns:us-east-2::sns-topic-for-lambda \ --statement-id function-with-sns --action "lambda:InvokeFunction" \ --principal sns.amazonaws.com --profile accountB ``` @@ -117,9 +117,9 @@ You should see the following output: ``` { "Statement": "{\"Condition\":{\"ArnLike\":{\"AWS:SourceArn\": - \"arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda\"}}, + \"arn:aws:sns:us-east-2::sns-topic-for-lambda\"}}, \"Action\":[\"lambda:InvokeFunction\"], - \"Resource\":\"arn:aws:lambda:us-east-2:01234567891B:function:Function-With-SNS\", + \"Resource\":\"arn:aws:lambda:us-east-2::function:Function-With-SNS\", \"Effect\":\"Allow\",\"Principal\":{\"Service\":\"sns.amazonaws.com\"}, \"Sid\":\"function-with-sns1\"}" } @@ -130,14 +130,14 @@ Do not use the `--source-account` parameter to add a source account to the Lambd **Note** If the account with the SNS topic is hosted in an opt\-in region, you need to specify the region in the principal\. For an example, see [Invoking Lambda functions using Amazon SNS notifications](https://docs.aws.amazon.com/sns/latest/dg/sns-lambda.html) in the *Amazon Simple Notification Service Developer Guide*\. -## Create a subscription +## Create a subscription \(account B\) -From account B, subscribe the Lambda function to the topic\. When a message is sent to the `sns-topic-for-lambda` topic in account A \(01234567891A\), Amazon SNS invokes the `Function-With-SNS` function in account B \(01234567891B\)\. +In **Account B**, subscribe the Lambda function to the topic\. When a message is sent to the `sns-topic-for-lambda` topic in **Account A**, Amazon SNS invokes the `Function-With-SNS` function in **Account B**\. ``` aws sns subscribe --protocol lambda \ ---topic-arn arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda \ ---notification-endpoint arn:aws:lambda:us-east-2:12345678901B:function:Function-With-SNS \ +--topic-arn arn:aws:sns:us-east-2::sns-topic-for-lambda \ +--notification-endpoint arn:aws:lambda:us-east-2::function:Function-With-SNS \ --profile accountB ``` @@ -145,19 +145,19 @@ You should see the following output: ``` { - "SubscriptionArn": "arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda:5d906xxxx-7c8x-45dx-a9dx-0484e31c98xx" + "SubscriptionArn": "arn:aws:sns:us-east-2::sns-topic-for-lambda:5d906xxxx-7c8x-45dx-a9dx-0484e31c98xx" } ``` The output contains the ARN of the topic subscription\. -## Test subscription +## Test subscription \(account A\) -From account A \(01234567891A\), test the subscription\. Type `Hello World` into a text file and save it as `message.txt`\. Then run the following command: +In **Account A**, test the subscription\. Type `Hello World` into a text file and save it as `message.txt`\. Then run the following command: ``` aws sns publish --message file://message.txt --subject Test \ ---topic-arn arn:aws:sns:us-east-2:12345678901A:sns-topic-for-lambda \ +--topic-arn arn:aws:sns:us-east-2::sns-topic-for-lambda \ --profile accountA ``` @@ -169,6 +169,8 @@ To learn more about Amazon SNS, see [What is Amazon Simple Notification Service] You can now delete the resources that you created for this tutorial, unless you want to retain them\. By deleting AWS resources that you're no longer using, you prevent unnecessary charges to your AWS account\. +In **Account A**, clean up your Amazon SNS topic\. + **To delete the Amazon SNS topic** 1. Open the [Topics page](https://console.aws.amazon.com/sns/home#topics:) of the Amazon SNS console\. @@ -181,6 +183,8 @@ You can now delete the resources that you created for this tutorial, unless you 1. Choose **Delete**\. +In **Account B**, clean up your execution role, Lambda function, and Amazon SNS subscription\. + **To delete the execution role** 1. Open the [Roles page](https://console.aws.amazon.com/iam/home#/roles) of the IAM console\. diff --git a/doc_source/with-sns.md b/doc_source/with-sns.md old mode 100644 new mode 100755 diff --git a/doc_source/with-sqs-create-package.md b/doc_source/with-sqs-create-package.md old mode 100644 new mode 100755 diff --git a/doc_source/with-sqs-cross-account-example.md b/doc_source/with-sqs-cross-account-example.md old mode 100644 new mode 100755 index f1112160..758947c6 --- a/doc_source/with-sqs-cross-account-example.md +++ b/doc_source/with-sqs-cross-account-example.md @@ -118,7 +118,7 @@ If the handler returns normally without exceptions, Lambda considers the message --payload file://input.txt outputfile.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. 1. Verify the output in the file `outputfile.txt`\. diff --git a/doc_source/with-sqs-example-use-app-spec.md b/doc_source/with-sqs-example-use-app-spec.md old mode 100644 new mode 100755 index 1749c182..93a3b751 --- a/doc_source/with-sqs-example-use-app-spec.md +++ b/doc_source/with-sqs-example-use-app-spec.md @@ -1,6 +1,6 @@ # AWS SAM template for an Amazon SQS application -You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [ AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. +You can build this application using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/)\. To learn more about creating AWS SAM templates, see [AWS SAM template basics](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-basics.html) in the *AWS Serverless Application Model Developer Guide*\. Below is a sample AWS SAM template for the Lambda application from the [tutorial](with-sqs-example.md)\. Copy the text below to a \.yaml file and save it next to the ZIP package you created previously\. Note that the `Handler` and `Runtime` parameter values should match the ones you used when you created the function in the previous section\. diff --git a/doc_source/with-sqs-example.md b/doc_source/with-sqs-example.md old mode 100644 new mode 100755 index 1ef0ff70..e610dccd --- a/doc_source/with-sqs-example.md +++ b/doc_source/with-sqs-example.md @@ -118,7 +118,7 @@ If the handler returns normally without exceptions, Lambda considers the message --payload file://input.txt outputfile.txt ``` - The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [ AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. + The cli\-binary\-format option is required if you are using AWS CLI version 2\. You can also configure this option in your [AWS CLI config file](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)\. 1. Verify the output in the file `outputfile.txt`\. diff --git a/doc_source/with-sqs.md b/doc_source/with-sqs.md old mode 100644 new mode 100755 index 50c5db97..31304416 --- a/doc_source/with-sqs.md +++ b/doc_source/with-sqs.md @@ -1,6 +1,6 @@ -# Using AWS Lambda with Amazon SQS +# Using Lambda with Amazon SQS -You can use an AWS Lambda function to process messages in an Amazon Simple Queue Service \(Amazon SQS\) queue\. Lambda [event source mappings](invocation-eventsourcemapping.md) support [standard queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) and [first\-in, first\-out \(FIFO\) queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html)\. With Amazon SQS, you can offload tasks from one component of your application by sending them to a queue and processing them asynchronously\. +You can use a Lambda function to process messages in an Amazon Simple Queue Service \(Amazon SQS\) queue\. Lambda [event source mappings](invocation-eventsourcemapping.md) support [standard queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) and [first\-in, first\-out \(FIFO\) queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html)\. With Amazon SQS, you can offload tasks from one component of your application by sending them to a queue and processing them asynchronously\. Lambda polls the queue and invokes your Lambda function [synchronously](invocation-sync.md) with an event that contains queue messages\. Lambda reads messages in batches and invokes your function once for each batch\. When your function successfully processes a batch, Lambda deletes its messages from the queue\. The following example shows an event for a batch of two messages\. @@ -45,7 +45,7 @@ Lambda polls the queue and invokes your Lambda function [synchronously](invocati } ``` -By default, Lambda polls up to 10 messages in your queue at once and sends that batch to your function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to five minutes by configuring a batch window\. Before invoking the function, Lambda continues to poll messages from the SQS standard queue until batch window expires, the [payload limit](gettingstarted-limits.md) is reached or full batch size is reached\. +By default, Lambda polls up to 10 messages in your queue at once and sends that batch to your function\. To avoid invoking the function with a small number of records, you can tell the event source to buffer records for up to 5 minutes by configuring a batch window\. Before invoking the function, Lambda continues to poll messages from the SQS standard queue until the batch window expires, the [invocation payload size quota](gettingstarted-limits.md) is reached, or the configured maximum batch size is reached\. **Note** If you're using a batch window and your SQS queue contains very low traffic, Lambda might wait for up to 20 seconds before invoking your function\. This is true even if you set a batch window lower than 20 seconds\. @@ -80,7 +80,7 @@ For FIFO queues, records contain additional attributes that are related to dedup } ``` -When Lambda reads a batch, the messages stay in the queue but become hidden for the length of the queue's [visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)\. If your function successfully processes the batch, Lambda deletes the messages from the queue\. If your function is [throttled](invocation-scaling.md), returns an error, or doesn't respond, the message becomes visible again\. All messages in a failed batch return to the queue, so your function code must be able to process the same message multiple times without side effects\. +When Lambda reads a batch, the messages stay in the queue but are hidden for the length of the queue's [visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)\. If your function successfully processes the batch, Lambda deletes the messages from the queue\. By default, if your function encounters an error while processing a batch, all messages in that batch become visible in the queue again\. For this reason, your function code must be able to process the same message multiple times without unintended side effects\. You can modify this reprocessing behavior by including batch item failures in your function response\. **Topics** + [Scaling and processing](#events-sqs-scaling) @@ -88,6 +88,7 @@ When Lambda reads a batch, the messages stay in the queue but become hidden for + [Execution role permissions](#events-sqs-permissions) + [Configuring a queue as an event source](#events-sqs-eventsource) + [Event source mapping APIs](#services-dynamodb-api) ++ [Reporting batch item failures](#services-sqs-batchfailurereporting) + [Amazon SQS configuration parameters](#services-sqs-params) + [Tutorial: Using Lambda with Amazon SQS](with-sqs-example.md) + [Tutorial: Using a cross\-account Amazon SQS queue as an event source](with-sqs-cross-account-example.md) @@ -96,19 +97,19 @@ When Lambda reads a batch, the messages stay in the queue but become hidden for ## Scaling and processing -For standard queues, Lambda uses [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) to poll a queue until it becomes active\. When messages are available, Lambda reads up to 5 batches and sends them to your function\. If messages are still available, Lambda increases the number of processes that are reading batches by up to 60 more instances per minute\. The maximum number of batches that can be processed simultaneously by an event source mapping is 1000\. +For standard queues, Lambda uses [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) to poll a queue until it becomes active\. When messages are available, Lambda reads up to five batches and sends them to your function\. If messages are still available, Lambda increases the number of processes that are reading batches by up to 60 more instances per minute\. The maximum number of batches that an event source mapping can process simultaneously is 1,000\. -For FIFO queues, Lambda sends messages to your function in the order that it receives them\. When you send a message to a FIFO queue, you specify a [message group ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html)\. Amazon SQS ensures that messages in the same group are delivered to Lambda in order\. Lambda sorts the messages into groups and sends only one batch at a time for a group\. If the function returns an error, all retries are attempted on the affected messages before Lambda receives additional messages from the same group\. +For FIFO queues, Lambda sends messages to your function in the order that it receives them\. When you send a message to a FIFO queue, you specify a [message group ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html)\. Amazon SQS ensures that messages in the same group are delivered to Lambda in order\. Lambda sorts the messages into groups and sends only one batch at a time for a group\. If your function returns an error, the function attempts all retries on the affected messages before Lambda receives additional messages from the same group\. -Your function can scale in concurrency to the number of active message groups\. For more information, see [SQS FIFO as an event source](https://aws.amazon.com/blogs/compute/new-for-aws-lambda-sqs-fifo-as-an-event-source/) on the AWS Compute Blog\. +Your function can scale in concurrency to the number of active message groups\. For more information, see [SQS FIFO as an event source](http://aws.amazon.com/blogs/compute/new-for-aws-lambda-sqs-fifo-as-an-event-source/) on the AWS Compute Blog\. ## Configuring a queue to use with Lambda -[Create an SQS queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/) to serve as an event source for your Lambda function\. Then configure the queue to allow time for your Lambda function to process each batch of events—and for Lambda to retry in response to throttling errors as it scales up\. +[Create an SQS queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-create-queue.html) to serve as an event source for your Lambda function\. Then configure the queue to allow time for your Lambda function to process each batch of events—and for Lambda to retry in response to throttling errors as it scales up\. -To allow your function time to process each batch of records, set the source queue's visibility timeout to at least 6 times the [ timeout](https://docs.aws.amazon.com/whitepapers/latest/serverless-architectures-lambda/timeout.html) that you configure on your function\. The extra time allows for Lambda to retry if your function execution is throttled while your function is processing a previous batch\. +To allow your function time to process each batch of records, set the source queue's visibility timeout to at least six times the [timeout that you configure](configuration-function-common.md#configuration-common-summary) on your function\. The extra time allows for Lambda to retry if your function is throttled while processing a previous batch\. -If a message fails to be processed multiple times, Amazon SQS can send it to a [dead\-letter queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)\. When your function returns an error, Lambda leaves it in the queue\. After the visibility timeout occurs, Lambda receives the message again\. To send messages to a second queue after a number of receives, configure a dead\-letter queue on your source queue\. +If your function fails to process a message multiple times, Amazon SQS can send it to a [dead\-letter queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)\. When your function returns an error, Lambda leaves it in the queue\. After the visibility timeout occurs, Lambda receives the message again\. To send messages to a second queue after a number of receives, configure a dead\-letter queue on your source queue\. **Note** Make sure that you configure the dead\-letter queue on the source queue, not on the Lambda function\. The dead\-letter queue that you configure on a function is used for the function's [asynchronous invocation queue](invocation-async.md), not for event source queues\. @@ -117,13 +118,11 @@ If your function returns an error, or can't be invoked because it's at maximum c ## Execution role permissions -Lambda needs the following permissions to manage messages in your Amazon SQS queue\. Add them to your function's execution role\. +Lambda needs the following permissions to manage messages in your Amazon SQS queue\. Add them to your function's [execution role](lambda-intro-execution-role.md)\. + [sqs:ReceiveMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html) + [sqs:DeleteMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessage.html) + [sqs:GetQueueAttributes](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) -For more information, see [AWS Lambda execution role](lambda-intro-execution-role.md)\. - ## Configuring a queue as an event source Create an event source mapping to tell Lambda to send items from your queue to a Lambda function\. You can create multiple event source mappings to process items from multiple queues with a single function\. When Lambda invokes the target function, the event can contain multiple items, up to a configurable maximum *batch size*\. @@ -132,42 +131,42 @@ To configure your function to read from Amazon SQS in the Lambda console, create **To create a trigger** -1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) on the Lambda console\. +1. Open the [Functions page](https://console.aws.amazon.com/lambda/home#/functions) of the Lambda console\. -1. Choose a function\. +1. Choose the name of a function\. 1. Under **Function overview**, choose **Add trigger**\. -1. Choose a trigger type\. +1. Choose the **SQS** trigger type\. -1. Configure the required options and then choose **Add**\. +1. Configure the required options, and then choose **Add**\. Lambda supports the following options for Amazon SQS event sources\. **Event source options** + **SQS queue** – The Amazon SQS queue to read records from\. -+ **Batch size** – The number of records to send to the function in each batch\. For a standard queue this can be up to 10,000 records\. For a FIFO queue the maximum is 10\. For a batch size over 10, you must also set the `MaximumBatchingWindowInSeconds` parameter to at least 1 second\. Lambda passes all of the records in the batch to the function in a single call, as long as the total size of the events doesn't exceed the [payload limit](gettingstarted-limits.md) for synchronous invocation \(6 MB\)\. ++ **Batch size** – The number of records to send to the function in each batch\. For a standard queue, this can be up to 10,000 records\. For a FIFO queue, the maximum is 10\. For a batch size over 10, you must also set the `MaximumBatchingWindowInSeconds` parameter to at least 1 second\. Lambda passes all of the records in the batch to the function in a single call, as long as the total size of the events doesn't exceed the [invocation payload size quota](gettingstarted-limits.md) for synchronous invocation \(6 MB\)\. - Metadata is generated by both Lambda and Amazon SQS for each record\. This additional metadata is counted towards the total payload size and may cause the total number of records sent in a batch to be lower than your configured batch size\. The metadata fields sent by Amazon SQS can be variable in length\. For more information about the Amazon SQS metadata fields, see the [ReceiveMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html) documentation in the *Amazon Simple Queue Service API Reference*\. -+ **Batch window ** – Specify the maximum amount of time to gather records before invoking the function, in seconds\. Only applicable to standard queues\. + Both Lambda and Amazon SQS generate metadata for each record\. This additional metadata is counted towards the total payload size and can cause the total number of records sent in a batch to be lower than your configured batch size\. The metadata fields that Amazon SQS sends can be variable in length\. For more information about the Amazon SQS metadata fields, see the [ReceiveMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html) API operation documentation in the *Amazon Simple Queue Service API Reference*\. ++ **Batch window ** – The maximum amount of time to gather records before invoking the function, in seconds\. This applies only to standard queues\. - If you are using a batch window greater than 0 seconds, you must account for the increased processing time in your queue visibility timeout\. We recommend setting your queue visibility timeout to 6 times your function timeout, plus the value of `MaximumBatchingWindowInSeconds`\. This allows time for your Lambda function to process each batch of events and to retry in the event of a throttling error\. + If you're using a batch window greater than 0 seconds, you must account for the increased processing time in your queue visibility timeout\. We recommend setting your queue visibility timeout to six times your function timeout, plus the value of `MaximumBatchingWindowInSeconds`\. This allows time for your Lambda function to process each batch of events and to retry in the event of a throttling error\. **Note** -If your batch window is greater than 0, and `(batch window) + (function timeout) > (queue visibility timeout)`, your effective queue visibility timeout will be `(batch window) + (function timeout) + 30s`\. +If your batch window is greater than 0, and `(batch window) + (function timeout) > (queue visibility timeout)`, then your effective queue visibility timeout is `(batch window) + (function timeout) + 30s`\. - Lambda processes up to 5 batches at a time\. This means there are a maximum of 5 workers available to batch and process messages in parallel at any one time\. Each worker will show a distinct Lambda invocation for its current batch of messages\. -+ **Enabled** – Set to true to enable the event source mapping\. Set to false to stop processing records\. + Lambda processes up to five batches at a time\. This means that there are a maximum of five workers available to batch and process messages in parallel at any one time\. Each worker shows a distinct Lambda invocation for its current batch of messages\. ++ **Enabled** – The status of the event source mapping\. Set to true to enable the event source mapping\. Set to false to stop processing records\. **Note** -Amazon SQS has a perpetual free tier for requests\. Beyond the free tier, Amazon SQS charges per million requests\. While your event source mapping is active, Lambda makes requests to the queue to get items\. For pricing details, see [Amazon Simple Queue Service pricing](https://aws.amazon.com/sqs/pricing)\. +Amazon SQS has a perpetual free tier for requests\. Beyond the free tier, Amazon SQS charges per million requests\. While your event source mapping is active, Lambda makes requests to the queue to get items\. For pricing details, see [Amazon SQS pricing](http://aws.amazon.com/sqs/pricing)\. -To manage the event source configuration later, choose the trigger in the designer\. +To manage the event source configuration later, in the Lambda console, choose the **SQS** trigger in the designer\. -Configure your function timeout to allow enough time to process an entire batch of items\. If items take a long time to process, choose a smaller batch size\. A large batch size can improve efficiency for workloads that are very fast or have a lot of overhead\. However, if your function returns an error, all items in the batch return to the queue\. If you configure [reserved concurrency](configuration-concurrency.md) on your function, set a minimum of 5 concurrent executions to reduce the chance of throttling errors when Lambda invokes your function\. To eliminate the chance of throttling errors, set the [reserved concurrency](configuration-concurrency.md) value to 1000, which is the maximum number of concurrent executions for an Amazon SQS event source\. +Configure your function timeout to allow enough time to process an entire batch of items\. If items take a long time to process, choose a smaller batch size\. A large batch size can improve efficiency for workloads that are very fast or have a lot of overhead\. However, if your function returns an error, all items in the batch return to the queue\. If you configure [reserved concurrency](configuration-concurrency.md) on your function, set a minimum of five concurrent executions to reduce the chance of throttling errors when Lambda invokes your function\. To eliminate the chance of throttling errors, set the reserved concurrency value to 1,000, which is the maximum number of concurrent executions for an Amazon SQS event source\. ## Event source mapping APIs -To manage an event source with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: +To manage an event source with the [AWS Command Line Interface \(AWS CLI\)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) or an [AWS SDK](http://aws.amazon.com/getting-started/tools-sdks/), you can use the following API operations: + [CreateEventSourceMapping](API_CreateEventSourceMapping.md) + [ListEventSourceMappings](API_ListEventSourceMappings.md) + [GetEventSourceMapping](API_GetEventSourceMapping.md) @@ -197,6 +196,86 @@ You should see the following output: } ``` +## Reporting batch item failures + +When your Lambda function encounters an error while processing a batch, all messages in that batch become visible in the queue again by default, including messages that Lambda processed successfully\. As a result, your function can end up processing the same message several times\. + +To avoid reprocessing all messages in a failed batch, you can configure your event source mapping to make only the failed messages visible again\. To do this, when configuring your event source mapping, include the value `ReportBatchItemFailures` in the `FunctionResponseTypes` list\. This lets your function return a partial success, which can help reduce the number of unnecessary retries on records\. + +### Report syntax + +After you include `ReportBatchItemFailures` in your event source mapping configuration, you can return a list of the failed message IDs in your function response\. For example, suppose you have a batch of five messages, with message IDs `id1`, `id2`, `id3`, `id4`, and `id5`\. Your function successfully processes `id1`, `id3`, and `id5`\. To make messages `id2` and `id4` visible again in your queue, your response syntax should look like the following: + +``` +{ + "batchItemFailures": [ + { + "itemIdentifier": "id2" + }, + { + "itemIdentifier": "id4" + } + ] +} +``` + +To return the list of failed message IDs in the batch, you can use a `SQSBatchResponse` class object or create your own custom class\. Here is an example of a response that uses the `SQSBatchResponse` object\. + +``` +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.RequestHandler; +import com.amazonaws.services.lambda.runtime.events.SQSEvent; +import com.amazonaws.services.lambda.runtime.events.SQSBatchResponse; + +import java.util.ArrayList; +import java.util.List; + +public class ProcessSQSMessageBatch implements RequestHandler { + @Override + public SQSBatchResponse handleRequest(SQSEvent sqsEvent, Context context) { + + List batchItemFailures = new ArrayList(); + String messageId = ""; + for (SQSEvent.SQSMessage message : sqsEvent.getRecords()) { + try { + //process your message + messageId = message.getMessageId(); + } catch (Exception e) { + //Add failed message identifier to the batchItemFailures list + batchItemFailures.add(new SQSBatchResponse.BatchItemFailure(messageId)); + } + } + return new SQSBatchResponse(batchItemFailures); + } +} +``` + +To use this feature, your function must gracefully handle errors\. Have your function logic catch all exceptions and report the messages that result in failure in `batchItemFailures` in your function response\. If your function throws an exception, the entire batch is considered a complete failure\. + +**Note** +If you're using this feature with a FIFO queue, your function should stop processing messages after the first failure and return all failed and unprocessed messages in `batchItemFailures`\. This helps preserve the ordering of messages in your queue\. + +### Success and failure conditions + +Lambda treats a batch as a complete success if your function returns any of the following: ++ An empty `batchItemFailures` list ++ A null `batchItemFailures` list ++ An empty `EventResponse` ++ A null `EventResponse` + +Lambda treats a batch as a complete failure if your function returns any of the following: ++ An invalid JSON response ++ An empty string `itemIdentifier` ++ A null `itemIdentifier` ++ An `itemIdentifier` with a bad key name ++ An `itemIdentifier` value with a message ID that doesn't exist + +### CloudWatch metrics + +To determine whether your function is correctly reporting batch item failures, you can monitor the `NumberOfMessagesDeleted` and `ApproximateAgeOfOldestMessage` Amazon SQS metrics in Amazon CloudWatch\. ++ `NumberOfMessagesDeleted` tracks the number of messages removed from your queue\. If this drops to 0, this is a sign that your function response is not correctly returning failed messages\. ++ `ApproximateAgeOfOldestMessage` tracks how long the oldest message has stayed in your queue\. A sharp increase in this metric can indicate that your function is not correctly returning failed messages\. + ## Amazon SQS configuration parameters All Lambda event source types share the same [CreateEventSourceMapping](API_CreateEventSourceMapping.md) and [UpdateEventSourceMapping](API_UpdateEventSourceMapping.md) API operations\. However, only some of the parameters apply to Amazon SQS\. @@ -206,8 +285,9 @@ All Lambda event source types share the same [CreateEventSourceMapping](API_Crea | Parameter | Required | Default | Notes | | --- | --- | --- | --- | -| BatchSize | N | 100 | Maximum: 10000 | +| BatchSize | N | 10 | For standard queues, the maximum is 10,000\. For FIFO queues, the maximum is 10\. | | Enabled | N | true | | -| EventSourceArn | Y | | ARN of the data stream or a stream consumer | +| EventSourceArn | Y | | The ARN of the data stream or a stream consumer | | FunctionName | Y | | | +| FunctionResponseTypes | N | | To let your function report specific failures in a batch, include the value `ReportBatchItemFailures` in `FunctionResponseTypes`\. For more information, see [Reporting batch item failures](#services-sqs-batchfailurereporting)\. | | MaximumBatchingWindowInSeconds | N | 0 | | \ No newline at end of file