Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 for Lambda.
If the function's package type is Image
, then you must specify the
code package in ImageUri
as the URI of a
container image
in the Amazon ECR registry.
If the function's package type is Zip
, then you must specify the
deployment package as a
.zip file archive.
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.
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.
Synopsis
- data UpdateFunctionCode = UpdateFunctionCode' {}
- newUpdateFunctionCode :: Text -> UpdateFunctionCode
- updateFunctionCode_architectures :: Lens' UpdateFunctionCode (Maybe (NonEmpty Architecture))
- updateFunctionCode_dryRun :: Lens' UpdateFunctionCode (Maybe Bool)
- updateFunctionCode_imageUri :: Lens' UpdateFunctionCode (Maybe Text)
- updateFunctionCode_publish :: Lens' UpdateFunctionCode (Maybe Bool)
- updateFunctionCode_revisionId :: Lens' UpdateFunctionCode (Maybe Text)
- updateFunctionCode_s3Bucket :: Lens' UpdateFunctionCode (Maybe Text)
- updateFunctionCode_s3Key :: Lens' UpdateFunctionCode (Maybe Text)
- updateFunctionCode_s3ObjectVersion :: Lens' UpdateFunctionCode (Maybe Text)
- updateFunctionCode_zipFile :: Lens' UpdateFunctionCode (Maybe ByteString)
- updateFunctionCode_functionName :: Lens' UpdateFunctionCode Text
- data FunctionConfiguration = FunctionConfiguration' {
- architectures :: Maybe (NonEmpty Architecture)
- codeSha256 :: Maybe Text
- codeSize :: Maybe Integer
- deadLetterConfig :: Maybe DeadLetterConfig
- description :: Maybe Text
- environment :: Maybe EnvironmentResponse
- ephemeralStorage :: Maybe EphemeralStorage
- fileSystemConfigs :: Maybe [FileSystemConfig]
- functionArn :: Maybe Text
- functionName :: Maybe Text
- handler :: Maybe Text
- imageConfigResponse :: Maybe ImageConfigResponse
- kmsKeyArn :: Maybe Text
- lastModified :: Maybe Text
- lastUpdateStatus :: Maybe LastUpdateStatus
- lastUpdateStatusReason :: Maybe Text
- lastUpdateStatusReasonCode :: Maybe LastUpdateStatusReasonCode
- layers :: Maybe [Layer]
- masterArn :: Maybe Text
- memorySize :: Maybe Natural
- packageType :: Maybe PackageType
- revisionId :: Maybe Text
- role' :: Maybe Text
- runtime :: Maybe Runtime
- signingJobArn :: Maybe Text
- signingProfileVersionArn :: Maybe Text
- snapStart :: Maybe SnapStartResponse
- state :: Maybe State
- stateReason :: Maybe Text
- stateReasonCode :: Maybe StateReasonCode
- timeout :: Maybe Natural
- tracingConfig :: Maybe TracingConfigResponse
- version :: Maybe Text
- vpcConfig :: Maybe VpcConfigResponse
- newFunctionConfiguration :: FunctionConfiguration
- functionConfiguration_architectures :: Lens' FunctionConfiguration (Maybe (NonEmpty Architecture))
- functionConfiguration_codeSha256 :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_codeSize :: Lens' FunctionConfiguration (Maybe Integer)
- functionConfiguration_deadLetterConfig :: Lens' FunctionConfiguration (Maybe DeadLetterConfig)
- functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_environment :: Lens' FunctionConfiguration (Maybe EnvironmentResponse)
- functionConfiguration_ephemeralStorage :: Lens' FunctionConfiguration (Maybe EphemeralStorage)
- functionConfiguration_fileSystemConfigs :: Lens' FunctionConfiguration (Maybe [FileSystemConfig])
- functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionName :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_handler :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_imageConfigResponse :: Lens' FunctionConfiguration (Maybe ImageConfigResponse)
- functionConfiguration_kmsKeyArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastModified :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastUpdateStatus :: Lens' FunctionConfiguration (Maybe LastUpdateStatus)
- functionConfiguration_lastUpdateStatusReason :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastUpdateStatusReasonCode :: Lens' FunctionConfiguration (Maybe LastUpdateStatusReasonCode)
- functionConfiguration_layers :: Lens' FunctionConfiguration (Maybe [Layer])
- functionConfiguration_masterArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_memorySize :: Lens' FunctionConfiguration (Maybe Natural)
- functionConfiguration_packageType :: Lens' FunctionConfiguration (Maybe PackageType)
- functionConfiguration_revisionId :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_role :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe Runtime)
- functionConfiguration_signingJobArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_signingProfileVersionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_snapStart :: Lens' FunctionConfiguration (Maybe SnapStartResponse)
- functionConfiguration_state :: Lens' FunctionConfiguration (Maybe State)
- functionConfiguration_stateReason :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_stateReasonCode :: Lens' FunctionConfiguration (Maybe StateReasonCode)
- functionConfiguration_timeout :: Lens' FunctionConfiguration (Maybe Natural)
- functionConfiguration_tracingConfig :: Lens' FunctionConfiguration (Maybe TracingConfigResponse)
- functionConfiguration_version :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_vpcConfig :: Lens' FunctionConfiguration (Maybe VpcConfigResponse)
Creating a Request
data UpdateFunctionCode Source #
See: newUpdateFunctionCode
smart constructor.
UpdateFunctionCode' | |
|
Instances
newUpdateFunctionCode Source #
Create a value of UpdateFunctionCode
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateFunctionCode
, updateFunctionCode_architectures
- 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
.
$sel:dryRun:UpdateFunctionCode'
, updateFunctionCode_dryRun
- Set to true to validate the request parameters and access permissions
without modifying the function code.
UpdateFunctionCode
, updateFunctionCode_imageUri
- URI of a container image in the Amazon ECR registry. Do not use for a
function defined with a .zip file archive.
$sel:publish:UpdateFunctionCode'
, updateFunctionCode_publish
- Set to true to publish a new version of the function after updating the
code. This has the same effect as calling PublishVersion separately.
UpdateFunctionCode
, updateFunctionCode_revisionId
- Update the function only 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.
UpdateFunctionCode
, updateFunctionCode_s3Bucket
- An Amazon S3 bucket in the same Amazon Web Services Region as your
function. The bucket can be in a different Amazon Web Services account.
Use only with a function defined with a .zip file archive deployment
package.
UpdateFunctionCode
, updateFunctionCode_s3Key
- The Amazon S3 key of the deployment package. Use only with a function
defined with a .zip file archive deployment package.
UpdateFunctionCode
, updateFunctionCode_s3ObjectVersion
- For versioned objects, the version of the deployment package object to
use.
UpdateFunctionCode
, updateFunctionCode_zipFile
- The base64-encoded contents of the deployment package. Amazon Web
Services SDK and CLI clients handle the encoding for you. Use only with
a function defined with a .zip file archive deployment package.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
UpdateFunctionCode
, updateFunctionCode_functionName
- The name of the Lambda function.
Name formats
- Function name –
my-function
. - Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function
. - Partial ARN –
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Request Lenses
updateFunctionCode_architectures :: Lens' UpdateFunctionCode (Maybe (NonEmpty Architecture)) Source #
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
.
updateFunctionCode_dryRun :: Lens' UpdateFunctionCode (Maybe Bool) Source #
Set to true to validate the request parameters and access permissions without modifying the function code.
updateFunctionCode_imageUri :: Lens' UpdateFunctionCode (Maybe Text) Source #
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
updateFunctionCode_publish :: Lens' UpdateFunctionCode (Maybe Bool) Source #
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
updateFunctionCode_revisionId :: Lens' UpdateFunctionCode (Maybe Text) Source #
Update the function only 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.
updateFunctionCode_s3Bucket :: Lens' UpdateFunctionCode (Maybe Text) Source #
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
updateFunctionCode_s3Key :: Lens' UpdateFunctionCode (Maybe Text) Source #
The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
updateFunctionCode_s3ObjectVersion :: Lens' UpdateFunctionCode (Maybe Text) Source #
For versioned objects, the version of the deployment package object to use.
updateFunctionCode_zipFile :: Lens' UpdateFunctionCode (Maybe ByteString) Source #
The base64-encoded contents of the deployment package. Amazon Web
Services SDK and CLI clients handle the encoding for you. Use only with
a function defined with a .zip file archive deployment package.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
updateFunctionCode_functionName :: Lens' UpdateFunctionCode Text Source #
The name of the Lambda function.
Name formats
- Function name –
my-function
. - Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:my-function
. - Partial ARN –
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Destructuring the Response
data FunctionConfiguration Source #
Details about a function's configuration.
See: newFunctionConfiguration
smart constructor.
FunctionConfiguration' | |
|
Instances
newFunctionConfiguration :: FunctionConfiguration Source #
Create a value of FunctionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:architectures:FunctionConfiguration'
, functionConfiguration_architectures
- 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
.
$sel:codeSha256:FunctionConfiguration'
, functionConfiguration_codeSha256
- The SHA256 hash of the function's deployment package.
FunctionConfiguration
, functionConfiguration_codeSize
- The size of the function's deployment package, in bytes.
$sel:deadLetterConfig:FunctionConfiguration'
, functionConfiguration_deadLetterConfig
- The function's dead letter queue.
$sel:description:FunctionConfiguration'
, functionConfiguration_description
- The function's description.
$sel:environment:FunctionConfiguration'
, functionConfiguration_environment
- The function's
environment variables.
Omitted from CloudTrail logs.
$sel:ephemeralStorage:FunctionConfiguration'
, functionConfiguration_ephemeralStorage
- The size of the function’s /tmp
directory in MB. The default value is
512, but it can be any whole number between 512 and 10,240 MB.
$sel:fileSystemConfigs:FunctionConfiguration'
, functionConfiguration_fileSystemConfigs
- Connection settings for an
Amazon EFS file system.
$sel:functionArn:FunctionConfiguration'
, functionConfiguration_functionArn
- The function's Amazon Resource Name (ARN).
$sel:functionName:FunctionConfiguration'
, functionConfiguration_functionName
- The name of the function.
$sel:handler:FunctionConfiguration'
, functionConfiguration_handler
- The function that Lambda calls to begin running your function.
$sel:imageConfigResponse:FunctionConfiguration'
, functionConfiguration_imageConfigResponse
- The function's image configuration values.
$sel:kmsKeyArn:FunctionConfiguration'
, functionConfiguration_kmsKeyArn
- The KMS key that's used to encrypt the function's environment
variables. This key is returned only if you've configured a customer
managed key.
$sel:lastModified:FunctionConfiguration'
, functionConfiguration_lastModified
- The date and time that the function was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
$sel:lastUpdateStatus:FunctionConfiguration'
, functionConfiguration_lastUpdateStatus
- The status of the last update that was performed on the function. This
is first set to Successful
after function creation completes.
$sel:lastUpdateStatusReason:FunctionConfiguration'
, functionConfiguration_lastUpdateStatusReason
- The reason for the last update that was performed on the function.
$sel:lastUpdateStatusReasonCode:FunctionConfiguration'
, functionConfiguration_lastUpdateStatusReasonCode
- The reason code for the last update that was performed on the function.
$sel:layers:FunctionConfiguration'
, functionConfiguration_layers
- The function's
layers.
$sel:masterArn:FunctionConfiguration'
, functionConfiguration_masterArn
- For Lambda@Edge functions, the ARN of the main function.
$sel:memorySize:FunctionConfiguration'
, functionConfiguration_memorySize
- The amount of memory available to the function at runtime.
$sel:packageType:FunctionConfiguration'
, functionConfiguration_packageType
- The type of deployment package. Set to Image
for container image and
set Zip
for .zip file archive.
$sel:revisionId:FunctionConfiguration'
, functionConfiguration_revisionId
- The latest updated revision of the function or alias.
$sel:role':FunctionConfiguration'
, functionConfiguration_role
- The function's execution role.
$sel:runtime:FunctionConfiguration'
, functionConfiguration_runtime
- The runtime environment for the Lambda function.
FunctionConfiguration
, functionConfiguration_signingJobArn
- The ARN of the signing job.
FunctionConfiguration
, functionConfiguration_signingProfileVersionArn
- The ARN of the signing profile version.
$sel:snapStart:FunctionConfiguration'
, functionConfiguration_snapStart
- Set ApplyOn
to PublishedVersions
to create a snapshot of the
initialized execution environment when you publish a function version.
For more information, see
Reducing startup time with Lambda SnapStart.
$sel:state:FunctionConfiguration'
, functionConfiguration_state
- The current state of the function. When the state is Inactive
, you can
reactivate the function by invoking it.
$sel:stateReason:FunctionConfiguration'
, functionConfiguration_stateReason
- The reason for the function's current state.
$sel:stateReasonCode:FunctionConfiguration'
, functionConfiguration_stateReasonCode
- The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function.
$sel:timeout:FunctionConfiguration'
, functionConfiguration_timeout
- The amount of time in seconds that Lambda allows a function to run
before stopping it.
$sel:tracingConfig:FunctionConfiguration'
, functionConfiguration_tracingConfig
- The function's X-Ray tracing configuration.
$sel:version:FunctionConfiguration'
, functionConfiguration_version
- The version of the Lambda function.
$sel:vpcConfig:FunctionConfiguration'
, functionConfiguration_vpcConfig
- The function's networking configuration.
Response Lenses
functionConfiguration_architectures :: Lens' FunctionConfiguration (Maybe (NonEmpty Architecture)) Source #
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
.
functionConfiguration_codeSha256 :: Lens' FunctionConfiguration (Maybe Text) Source #
The SHA256 hash of the function's deployment package.
functionConfiguration_codeSize :: Lens' FunctionConfiguration (Maybe Integer) Source #
The size of the function's deployment package, in bytes.
functionConfiguration_deadLetterConfig :: Lens' FunctionConfiguration (Maybe DeadLetterConfig) Source #
The function's dead letter queue.
functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's description.
functionConfiguration_environment :: Lens' FunctionConfiguration (Maybe EnvironmentResponse) Source #
The function's environment variables. Omitted from CloudTrail logs.
functionConfiguration_ephemeralStorage :: Lens' FunctionConfiguration (Maybe EphemeralStorage) Source #
The size of the function’s /tmp
directory in MB. The default value is
512, but it can be any whole number between 512 and 10,240 MB.
functionConfiguration_fileSystemConfigs :: Lens' FunctionConfiguration (Maybe [FileSystemConfig]) Source #
Connection settings for an Amazon EFS file system.
functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's Amazon Resource Name (ARN).
functionConfiguration_functionName :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the function.
functionConfiguration_handler :: Lens' FunctionConfiguration (Maybe Text) Source #
The function that Lambda calls to begin running your function.
functionConfiguration_imageConfigResponse :: Lens' FunctionConfiguration (Maybe ImageConfigResponse) Source #
The function's image configuration values.
functionConfiguration_kmsKeyArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The KMS key that's used to encrypt the function's environment variables. This key is returned only if you've configured a customer managed key.
functionConfiguration_lastModified :: Lens' FunctionConfiguration (Maybe Text) Source #
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
functionConfiguration_lastUpdateStatus :: Lens' FunctionConfiguration (Maybe LastUpdateStatus) Source #
The status of the last update that was performed on the function. This
is first set to Successful
after function creation completes.
functionConfiguration_lastUpdateStatusReason :: Lens' FunctionConfiguration (Maybe Text) Source #
The reason for the last update that was performed on the function.
functionConfiguration_lastUpdateStatusReasonCode :: Lens' FunctionConfiguration (Maybe LastUpdateStatusReasonCode) Source #
The reason code for the last update that was performed on the function.
functionConfiguration_layers :: Lens' FunctionConfiguration (Maybe [Layer]) Source #
The function's layers.
functionConfiguration_masterArn :: Lens' FunctionConfiguration (Maybe Text) Source #
For Lambda@Edge functions, the ARN of the main function.
functionConfiguration_memorySize :: Lens' FunctionConfiguration (Maybe Natural) Source #
The amount of memory available to the function at runtime.
functionConfiguration_packageType :: Lens' FunctionConfiguration (Maybe PackageType) Source #
The type of deployment package. Set to Image
for container image and
set Zip
for .zip file archive.
functionConfiguration_revisionId :: Lens' FunctionConfiguration (Maybe Text) Source #
The latest updated revision of the function or alias.
functionConfiguration_role :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's execution role.
functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe Runtime) Source #
The runtime environment for the Lambda function.
functionConfiguration_signingJobArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The ARN of the signing job.
functionConfiguration_signingProfileVersionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The ARN of the signing profile version.
functionConfiguration_snapStart :: Lens' FunctionConfiguration (Maybe SnapStartResponse) Source #
Set ApplyOn
to PublishedVersions
to create a snapshot of the
initialized execution environment when you publish a function version.
For more information, see
Reducing startup time with Lambda SnapStart.
functionConfiguration_state :: Lens' FunctionConfiguration (Maybe State) Source #
The current state of the function. When the state is Inactive
, you can
reactivate the function by invoking it.
functionConfiguration_stateReason :: Lens' FunctionConfiguration (Maybe Text) Source #
The reason for the function's current state.
functionConfiguration_stateReasonCode :: Lens' FunctionConfiguration (Maybe StateReasonCode) Source #
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function.
functionConfiguration_timeout :: Lens' FunctionConfiguration (Maybe Natural) Source #
The amount of time in seconds that Lambda allows a function to run before stopping it.
functionConfiguration_tracingConfig :: Lens' FunctionConfiguration (Maybe TracingConfigResponse) Source #
The function's X-Ray tracing configuration.
functionConfiguration_version :: Lens' FunctionConfiguration (Maybe Text) Source #
The version of the Lambda function.
functionConfiguration_vpcConfig :: Lens' FunctionConfiguration (Maybe VpcConfigResponse) Source #
The function's networking configuration.