get_function_configuration¶
Operation¶
async
¶
get_function_configuration(input: GetFunctionConfigurationInput, plugins: list[Plugin] | None = None) -> GetFunctionConfigurationOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetFunctionConfigurationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetFunctionConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetFunctionConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
function_name: str | None = None
The name or ARN 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.
class-attribute
instance-attribute
¶
qualifier: str | None = None
Specify a version or alias to get details about a published version of the function.
Output¶
dataclass
¶
Details about a function's configuration.
Attributes¶
class-attribute
instance-attribute
¶
architectures: list[Architecture] | None = None
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.
class-attribute
instance-attribute
¶
capacity_provider_config: CapacityProviderConfig | None = None
Configuration for the capacity provider that manages compute resources for Lambda functions.
class-attribute
instance-attribute
¶
code_sha256: str | None = None
The SHA256 hash of the function's deployment package.
class-attribute
instance-attribute
¶
code_size: int = 0
The size of the function's deployment package, in bytes.
class-attribute
instance-attribute
¶
config_sha256: str | None = None
The SHA256 hash of the function configuration.
class-attribute
instance-attribute
¶
dead_letter_config: DeadLetterConfig | None = None
The function's dead letter queue.
class-attribute
instance-attribute
¶
description: str | None = None
The function's description.
class-attribute
instance-attribute
¶
durable_config: DurableConfig | None = None
The function's durable execution configuration settings, if the function is configured for durability.
class-attribute
instance-attribute
¶
environment: EnvironmentResponse | None = None
The function's environment variables. Omitted from CloudTrail logs.
class-attribute
instance-attribute
¶
ephemeral_storage: EphemeralStorage | None = None
The size of the function's /tmp directory in MB. The default value is
512, but can be any whole number between 512 and 10,240 MB. For more
information, see Configuring ephemeral storage
(console).
class-attribute
instance-attribute
¶
file_system_configs: list[FileSystemConfig] | None = None
Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.
class-attribute
instance-attribute
¶
function_arn: str | None = None
The function's Amazon Resource Name (ARN).
class-attribute
instance-attribute
¶
function_name: str | None = None
The name of the function.
class-attribute
instance-attribute
¶
handler: str | None = None
The function that Lambda calls to begin running your function.
class-attribute
instance-attribute
¶
image_config_response: ImageConfigResponse | None = None
The function's image configuration values.
class-attribute
instance-attribute
¶
kms_key_arn: str | None = None
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
-
The function's environment variables.
-
The function's Lambda SnapStart snapshots.
-
When used with
SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda. -
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
class-attribute
instance-attribute
¶
last_modified: str | None = None
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
class-attribute
instance-attribute
¶
last_update_status: LastUpdateStatus | None = None
The status of the last update that was performed on the function. This
is first set to Successful after function creation completes.
class-attribute
instance-attribute
¶
last_update_status_reason: str | None = None
The reason for the last update that was performed on the function.
class-attribute
instance-attribute
¶
last_update_status_reason_code: LastUpdateStatusReasonCode | None = None
The reason code for the last update that was performed on the function.
class-attribute
instance-attribute
¶
layers: list[Layer] | None = None
The function's layers.
class-attribute
instance-attribute
¶
logging_config: LoggingConfig | None = None
The function's Amazon CloudWatch Logs configuration settings.
class-attribute
instance-attribute
¶
master_arn: str | None = None
For Lambda@Edge functions, the ARN of the main function.
class-attribute
instance-attribute
¶
memory_size: int | None = None
The amount of memory available to the function at runtime.
class-attribute
instance-attribute
¶
package_type: PackageType | None = None
The type of deployment package. Set to Image for container image and
set Zip for .zip file archive.
class-attribute
instance-attribute
¶
revision_id: str | None = None
The latest updated revision of the function or alias.
class-attribute
instance-attribute
¶
runtime: Runtime | None = None
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
class-attribute
instance-attribute
¶
runtime_version_config: RuntimeVersionConfig | None = None
The ARN of the runtime and any errors that occured.
class-attribute
instance-attribute
¶
signing_job_arn: str | None = None
The ARN of the signing job.
class-attribute
instance-attribute
¶
signing_profile_version_arn: str | None = None
The ARN of the signing profile version.
class-attribute
instance-attribute
¶
snap_start: SnapStartResponse | None = None
Set ApplyOn to PublishedVersions to create a snapshot of the
initialized execution environment when you publish a function version.
For more information, see Improving startup performance with Lambda
SnapStart.
class-attribute
instance-attribute
¶
state: State | None = None
The current state of the function. When the state is Inactive, you can
reactivate the function by invoking it.
class-attribute
instance-attribute
¶
state_reason: str | None = None
The reason for the function's current state.
class-attribute
instance-attribute
¶
state_reason_code: StateReasonCode | None = None
The reason code for the function's current state. When the code is
Creating, you can't invoke or modify the function.
class-attribute
instance-attribute
¶
tenancy_config: TenancyConfig | None = None
The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.
class-attribute
instance-attribute
¶
timeout: int | None = None
The amount of time in seconds that Lambda allows a function to run before stopping it.
class-attribute
instance-attribute
¶
tracing_config: TracingConfigResponse | None = None
The function's X-Ray tracing configuration.
class-attribute
instance-attribute
¶
version: str | None = None
The version of the Lambda function.
class-attribute
instance-attribute
¶
vpc_config: VpcConfigResponse | None = None
The function's networking configuration.