Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
To get all of a function's details, including function-level settings, use GetFunction.
Synopsis
- data GetFunctionConfiguration = GetFunctionConfiguration' {
- qualifier :: Maybe Text
- functionName :: Text
- newGetFunctionConfiguration :: Text -> GetFunctionConfiguration
- getFunctionConfiguration_qualifier :: Lens' GetFunctionConfiguration (Maybe Text)
- getFunctionConfiguration_functionName :: Lens' GetFunctionConfiguration Text
- data FunctionConfiguration = FunctionConfiguration' {
- memorySize :: Maybe Natural
- runtime :: Maybe Runtime
- state :: Maybe State
- signingProfileVersionArn :: Maybe Text
- lastUpdateStatus :: Maybe LastUpdateStatus
- functionArn :: Maybe Text
- kmsKeyArn :: Maybe Text
- packageType :: Maybe PackageType
- fileSystemConfigs :: Maybe [FileSystemConfig]
- environment :: Maybe EnvironmentResponse
- deadLetterConfig :: Maybe DeadLetterConfig
- architectures :: Maybe (NonEmpty Architecture)
- signingJobArn :: Maybe Text
- role' :: Maybe Text
- vpcConfig :: Maybe VpcConfigResponse
- version :: Maybe Text
- functionName :: Maybe Text
- layers :: Maybe [Layer]
- codeSize :: Maybe Integer
- handler :: Maybe Text
- timeout :: Maybe Natural
- lastUpdateStatusReason :: Maybe Text
- stateReason :: Maybe Text
- lastModified :: Maybe Text
- codeSha256 :: Maybe Text
- tracingConfig :: Maybe TracingConfigResponse
- stateReasonCode :: Maybe StateReasonCode
- imageConfigResponse :: Maybe ImageConfigResponse
- description :: Maybe Text
- lastUpdateStatusReasonCode :: Maybe LastUpdateStatusReasonCode
- revisionId :: Maybe Text
- masterArn :: Maybe Text
- newFunctionConfiguration :: FunctionConfiguration
- functionConfiguration_memorySize :: Lens' FunctionConfiguration (Maybe Natural)
- functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe Runtime)
- functionConfiguration_state :: Lens' FunctionConfiguration (Maybe State)
- functionConfiguration_signingProfileVersionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastUpdateStatus :: Lens' FunctionConfiguration (Maybe LastUpdateStatus)
- functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_kmsKeyArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_packageType :: Lens' FunctionConfiguration (Maybe PackageType)
- functionConfiguration_fileSystemConfigs :: Lens' FunctionConfiguration (Maybe [FileSystemConfig])
- functionConfiguration_environment :: Lens' FunctionConfiguration (Maybe EnvironmentResponse)
- functionConfiguration_deadLetterConfig :: Lens' FunctionConfiguration (Maybe DeadLetterConfig)
- functionConfiguration_architectures :: Lens' FunctionConfiguration (Maybe (NonEmpty Architecture))
- functionConfiguration_signingJobArn :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_role :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_vpcConfig :: Lens' FunctionConfiguration (Maybe VpcConfigResponse)
- functionConfiguration_version :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_functionName :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_layers :: Lens' FunctionConfiguration (Maybe [Layer])
- functionConfiguration_codeSize :: Lens' FunctionConfiguration (Maybe Integer)
- functionConfiguration_handler :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_timeout :: Lens' FunctionConfiguration (Maybe Natural)
- functionConfiguration_lastUpdateStatusReason :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_stateReason :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastModified :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_codeSha256 :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_tracingConfig :: Lens' FunctionConfiguration (Maybe TracingConfigResponse)
- functionConfiguration_stateReasonCode :: Lens' FunctionConfiguration (Maybe StateReasonCode)
- functionConfiguration_imageConfigResponse :: Lens' FunctionConfiguration (Maybe ImageConfigResponse)
- functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_lastUpdateStatusReasonCode :: Lens' FunctionConfiguration (Maybe LastUpdateStatusReasonCode)
- functionConfiguration_revisionId :: Lens' FunctionConfiguration (Maybe Text)
- functionConfiguration_masterArn :: Lens' FunctionConfiguration (Maybe Text)
Creating a Request
data GetFunctionConfiguration Source #
See: newGetFunctionConfiguration
smart constructor.
GetFunctionConfiguration' | |
|
Instances
newGetFunctionConfiguration Source #
Create a value of GetFunctionConfiguration
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:qualifier:GetFunctionConfiguration'
, getFunctionConfiguration_qualifier
- Specify a version or alias to get details about a published version of
the function.
$sel:functionName:GetFunctionConfiguration'
, getFunctionConfiguration_functionName
- The name of the Lambda function, version, or alias.
Name formats
- Function name -
my-function
(name-only),my-function:v1
(with alias). - Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. - Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. 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
getFunctionConfiguration_qualifier :: Lens' GetFunctionConfiguration (Maybe Text) Source #
Specify a version or alias to get details about a published version of the function.
getFunctionConfiguration_functionName :: Lens' GetFunctionConfiguration Text Source #
The name of the Lambda function, version, or alias.
Name formats
- Function name -
my-function
(name-only),my-function:v1
(with alias). - Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. - Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. 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:memorySize:FunctionConfiguration'
, functionConfiguration_memorySize
- The amount of memory available to the function at runtime.
$sel:runtime:FunctionConfiguration'
, functionConfiguration_runtime
- The runtime environment for the Lambda function.
$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:signingProfileVersionArn:FunctionConfiguration'
, functionConfiguration_signingProfileVersionArn
- The ARN of the signing profile version.
$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:functionArn:FunctionConfiguration'
, functionConfiguration_functionArn
- The function's Amazon Resource Name (ARN).
$sel:kmsKeyArn:FunctionConfiguration'
, functionConfiguration_kmsKeyArn
- The KMS key that's used to encrypt the function's environment
variables. This key is only returned if you've configured a customer
managed CMK.
$sel:packageType:FunctionConfiguration'
, functionConfiguration_packageType
- The type of deployment package. Set to Image
for container image and
set Zip
for .zip file archive.
$sel:fileSystemConfigs:FunctionConfiguration'
, functionConfiguration_fileSystemConfigs
- Connection settings for an
Amazon EFS file system.
$sel:environment:FunctionConfiguration'
, functionConfiguration_environment
- The function's
environment variables.
$sel:deadLetterConfig:FunctionConfiguration'
, functionConfiguration_deadLetterConfig
- The function's dead letter queue.
$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:signingJobArn:FunctionConfiguration'
, functionConfiguration_signingJobArn
- The ARN of the signing job.
$sel:role':FunctionConfiguration'
, functionConfiguration_role
- The function's execution role.
$sel:vpcConfig:FunctionConfiguration'
, functionConfiguration_vpcConfig
- The function's networking configuration.
$sel:version:FunctionConfiguration'
, functionConfiguration_version
- The version of the Lambda function.
$sel:functionName:FunctionConfiguration'
, functionConfiguration_functionName
- The name of the function.
$sel:layers:FunctionConfiguration'
, functionConfiguration_layers
- The function's
layers.
$sel:codeSize:FunctionConfiguration'
, functionConfiguration_codeSize
- The size of the function's deployment package, in bytes.
$sel:handler:FunctionConfiguration'
, functionConfiguration_handler
- The function that Lambda calls to begin executing your function.
$sel:timeout:FunctionConfiguration'
, functionConfiguration_timeout
- The amount of time in seconds that Lambda allows a function to run
before stopping it.
$sel:lastUpdateStatusReason:FunctionConfiguration'
, functionConfiguration_lastUpdateStatusReason
- The reason for the last update that was performed on the function.
$sel:stateReason:FunctionConfiguration'
, functionConfiguration_stateReason
- The reason for the function's current state.
$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:codeSha256:FunctionConfiguration'
, functionConfiguration_codeSha256
- The SHA256 hash of the function's deployment package.
$sel:tracingConfig:FunctionConfiguration'
, functionConfiguration_tracingConfig
- The function's X-Ray tracing configuration.
$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:imageConfigResponse:FunctionConfiguration'
, functionConfiguration_imageConfigResponse
- The function's image configuration values.
$sel:description:FunctionConfiguration'
, functionConfiguration_description
- The function's description.
$sel:lastUpdateStatusReasonCode:FunctionConfiguration'
, functionConfiguration_lastUpdateStatusReasonCode
- The reason code for the last update that was performed on the function.
$sel:revisionId:FunctionConfiguration'
, functionConfiguration_revisionId
- The latest updated revision of the function or alias.
$sel:masterArn:FunctionConfiguration'
, functionConfiguration_masterArn
- For Lambda@Edge functions, the ARN of the master function.
Response Lenses
functionConfiguration_memorySize :: Lens' FunctionConfiguration (Maybe Natural) Source #
The amount of memory available to the function at runtime.
functionConfiguration_runtime :: Lens' FunctionConfiguration (Maybe Runtime) Source #
The runtime environment for the Lambda function.
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_signingProfileVersionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The ARN of the signing profile version.
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_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's Amazon Resource Name (ARN).
functionConfiguration_kmsKeyArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
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_fileSystemConfigs :: Lens' FunctionConfiguration (Maybe [FileSystemConfig]) Source #
Connection settings for an Amazon EFS file system.
functionConfiguration_environment :: Lens' FunctionConfiguration (Maybe EnvironmentResponse) Source #
The function's environment variables.
functionConfiguration_deadLetterConfig :: Lens' FunctionConfiguration (Maybe DeadLetterConfig) Source #
The function's dead letter queue.
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_signingJobArn :: Lens' FunctionConfiguration (Maybe Text) Source #
The ARN of the signing job.
functionConfiguration_role :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's execution role.
functionConfiguration_vpcConfig :: Lens' FunctionConfiguration (Maybe VpcConfigResponse) Source #
The function's networking configuration.
functionConfiguration_version :: Lens' FunctionConfiguration (Maybe Text) Source #
The version of the Lambda function.
functionConfiguration_functionName :: Lens' FunctionConfiguration (Maybe Text) Source #
The name of the function.
functionConfiguration_layers :: Lens' FunctionConfiguration (Maybe [Layer]) Source #
The function's layers.
functionConfiguration_codeSize :: Lens' FunctionConfiguration (Maybe Integer) Source #
The size of the function's deployment package, in bytes.
functionConfiguration_handler :: Lens' FunctionConfiguration (Maybe Text) Source #
The function that Lambda calls to begin executing your 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_lastUpdateStatusReason :: Lens' FunctionConfiguration (Maybe Text) Source #
The reason for the last update that was performed on the function.
functionConfiguration_stateReason :: Lens' FunctionConfiguration (Maybe Text) Source #
The reason for the function's current state.
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_codeSha256 :: Lens' FunctionConfiguration (Maybe Text) Source #
The SHA256 hash of the function's deployment package.
functionConfiguration_tracingConfig :: Lens' FunctionConfiguration (Maybe TracingConfigResponse) Source #
The function's X-Ray tracing configuration.
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_imageConfigResponse :: Lens' FunctionConfiguration (Maybe ImageConfigResponse) Source #
The function's image configuration values.
functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text) Source #
The function's description.
functionConfiguration_lastUpdateStatusReasonCode :: Lens' FunctionConfiguration (Maybe LastUpdateStatusReasonCode) Source #
The reason code for the last update that was performed on the function.
functionConfiguration_revisionId :: Lens' FunctionConfiguration (Maybe Text) Source #
The latest updated revision of the function or alias.
functionConfiguration_masterArn :: Lens' FunctionConfiguration (Maybe Text) Source #
For Lambda@Edge functions, the ARN of the master function.