Skip to content

get_function_configuration

Operation

get_function_configuration

get_function_configuration(request: GetFunctionConfigurationInput | GetFunctionConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFunctionConfigurationInputDict]) -> GetFunctionConfigurationOutput

Returns the version-specific settings of a Lambda Event 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
request GetFunctionConfigurationInput | GetFunctionConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetFunctionConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFunctionConfigurationOutput

An instance of GetFunctionConfigurationOutput.

get_function_configuration async

get_function_configuration(request: GetFunctionConfigurationInput | GetFunctionConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFunctionConfigurationInputDict]) -> GetFunctionConfigurationOutput

Returns the version-specific settings of a Lambda Event 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
request GetFunctionConfigurationInput | GetFunctionConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetFunctionConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFunctionConfigurationOutput

An instance of GetFunctionConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetFunctionConfigurationInputDict

Bases: TypedDict

Dictionary form of GetFunctionConfigurationInput.

Attributes

function_name instance-attribute
function_name: Required[str]

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.

qualifier instance-attribute
qualifier: str | None

Specify a version or alias to get details about a published version of the function.

GetFunctionConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetFunctionConfigurationInput structure.

Attributes

function_name class-attribute instance-attribute
function_name: str | 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.

qualifier class-attribute instance-attribute
qualifier: str | None = ...

Specify a version or alias to get details about a published version of the function.

Output

GetFunctionConfigurationOutput dataclass

Bases: _SerdeShape

Details about a function's configuration.

Attributes

architectures class-attribute instance-attribute
architectures: list[str] | 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.

capacity_provider_config class-attribute instance-attribute
capacity_provider_config: CapacityProviderConfig | None = ...

Configuration for the capacity provider that manages compute resources for Lambda functions.

code_sha256 class-attribute instance-attribute
code_sha256: str | None = ...

The SHA256 hash of the function's deployment package.

code_size class-attribute instance-attribute
code_size: int = ...

The size of the function's deployment package, in bytes.

config_sha256 class-attribute instance-attribute
config_sha256: str | None = ...

The SHA256 hash of the function configuration.

dead_letter_config class-attribute instance-attribute
dead_letter_config: DeadLetterConfig | None = ...

The function's dead letter queue.

description class-attribute instance-attribute
description: str | None = ...

The function's description.

durable_config class-attribute instance-attribute
durable_config: DurableConfig | None = ...

The function's durable execution configuration settings, if the function is configured for durability.

environment class-attribute instance-attribute
environment: EnvironmentResponse | None = ...

The function's environment variables. Omitted from CloudTrail logs.

ephemeral_storage class-attribute instance-attribute
ephemeral_storage: EphemeralStorage | 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).

file_system_configs class-attribute instance-attribute
file_system_configs: list[FileSystemConfig] | None = ...

Connection settings for an Amazon EFS file system or an Amazon S3 file system.

function_arn class-attribute instance-attribute
function_arn: str | None = ...

The function's Amazon Resource Name (ARN).

function_name class-attribute instance-attribute
function_name: str | None = ...

The name of the function.

handler class-attribute instance-attribute
handler: str | None = ...

The function that Lambda calls to begin running your function.

image_config_response class-attribute instance-attribute
image_config_response: ImageConfigResponse | None = ...

The function's image configuration values.

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | 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.

last_modified class-attribute instance-attribute
last_modified: str | None = ...

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh🇲🇲ss.sTZD).

last_update_status class-attribute instance-attribute
last_update_status: str | None = ...

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

last_update_status_reason class-attribute instance-attribute
last_update_status_reason: str | None = ...

The reason for the last update that was performed on the function.

last_update_status_reason_code class-attribute instance-attribute
last_update_status_reason_code: str | None = ...

The reason code for the last update that was performed on the function.

layers class-attribute instance-attribute
layers: list[Layer] | None = ...

The function's layers.

logging_config class-attribute instance-attribute
logging_config: LoggingConfig | None = ...

The function's Amazon CloudWatch Logs configuration settings.

master_arn class-attribute instance-attribute
master_arn: str | None = ...

For Lambda@Edge functions, the ARN of the main function.

memory_size class-attribute instance-attribute
memory_size: int | None = ...

The amount of memory available to the function at runtime.

package_type class-attribute instance-attribute
package_type: str | None = ...

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

revision_id class-attribute instance-attribute
revision_id: str | None = ...

The latest updated revision of the function or alias.

role class-attribute instance-attribute
role: str | None = ...

The function's execution role.

runtime class-attribute instance-attribute
runtime: str | 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.

runtime_config class-attribute instance-attribute
runtime_config: FunctionRuntimeConfig | None = ...

The customer-managed runtime configuration for your function. Specifies the customer-managed runtime and the runtime alias that your function uses.

runtime_version_config class-attribute instance-attribute
runtime_version_config: RuntimeVersionConfig | None = ...

The ARN of the runtime and any errors that occured.

signing_job_arn class-attribute instance-attribute
signing_job_arn: str | None = ...

The ARN of the signing job.

signing_profile_version_arn class-attribute instance-attribute
signing_profile_version_arn: str | None = ...

The ARN of the signing profile version.

snap_start class-attribute instance-attribute
snap_start: SnapStartResponse | 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.

state class-attribute instance-attribute
state: str | None = ...

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

state_reason class-attribute instance-attribute
state_reason: str | None = ...

The reason for the function's current state.

state_reason_code class-attribute instance-attribute
state_reason_code: str | None = ...

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

tenancy_config class-attribute instance-attribute
tenancy_config: TenancyConfig | None = ...

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

timeout class-attribute instance-attribute
timeout: int | None = ...

The amount of time in seconds that Lambda allows a function to run before stopping it.

tracing_config class-attribute instance-attribute
tracing_config: TracingConfigResponse | None = ...

The function's X-Ray tracing configuration.

version class-attribute instance-attribute
version: str | None = ...

The version of the Lambda function.

vpc_config class-attribute instance-attribute
vpc_config: VpcConfigResponse | None = ...

The function's networking configuration.