AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Details about a function's configuration.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Lambda.Model.GetFunctionConfigurationResponse

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

C# 
public class GetFunctionConfigurationResponse : AmazonWebServiceResponse

The GetFunctionConfigurationResponse type exposes the following members

Constructors

NameDescription
Public Method GetFunctionConfigurationResponse()

Properties

NameTypeDescription
Public Property Architectures System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property CodeSha256 System.String

Gets and sets the property CodeSha256.

The SHA256 hash of the function's deployment package.

Public Property CodeSize System.Nullable<System.Int64>

Gets and sets the property CodeSize.

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

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DeadLetterConfig Amazon.Lambda.Model.DeadLetterConfig

Gets and sets the property DeadLetterConfig.

The function's dead letter queue.

Public Property Description System.String

Gets and sets the property Description.

The function's description.

Public Property Environment Amazon.Lambda.Model.EnvironmentResponse

Gets and sets the property Environment.

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

Public Property EphemeralStorage Amazon.Lambda.Model.EphemeralStorage

Gets and sets the property EphemeralStorage.

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).

Public Property FileSystemConfigs System.Collections.Generic.List<Amazon.Lambda.Model.FileSystemConfig>

Gets and sets the property FileSystemConfigs.

Connection settings for an Amazon EFS file system.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property FunctionArn System.String

Gets and sets the property FunctionArn.

The function's Amazon Resource Name (ARN).

Public Property FunctionName System.String

Gets and sets the property FunctionName.

The name of the function.

Public Property Handler System.String

Gets and sets the property Handler.

The function that Lambda calls to begin running your function.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ImageConfigResponse Amazon.Lambda.Model.ImageConfigResponse

Gets and sets the property ImageConfigResponse.

The function's image configuration values.

Public Property KMSKeyArn System.String

Gets and sets the property KMSKeyArn.

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.

Public Property LastModified System.String

Gets and sets the property LastModified.

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

Public Property LastUpdateStatus Amazon.Lambda.LastUpdateStatus

Gets and sets the property LastUpdateStatus.

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

Public Property LastUpdateStatusReason System.String

Gets and sets the property LastUpdateStatusReason.

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

Public Property LastUpdateStatusReasonCode Amazon.Lambda.LastUpdateStatusReasonCode

Gets and sets the property LastUpdateStatusReasonCode.

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

Public Property Layers System.Collections.Generic.List<Amazon.Lambda.Model.Layer>

Gets and sets the property Layers.

The function's layers.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property LoggingConfig Amazon.Lambda.Model.LoggingConfig

Gets and sets the property LoggingConfig.

The function's Amazon CloudWatch Logs configuration settings.

Public Property MasterArn System.String

Gets and sets the property MasterArn.

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

Public Property MemorySize System.Nullable<System.Int32>

Gets and sets the property MemorySize.

The amount of memory available to the function at runtime.

Public Property PackageType Amazon.Lambda.PackageType

Gets and sets the property PackageType.

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

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RevisionId System.String

Gets and sets the property RevisionId.

The latest updated revision of the function or alias.

Public Property Role System.String

Gets and sets the property Role.

The function's execution role.

Public Property Runtime Amazon.Lambda.Runtime

Gets and sets the property Runtime.

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.

Public Property RuntimeVersionConfig Amazon.Lambda.Model.RuntimeVersionConfig

Gets and sets the property RuntimeVersionConfig.

The ARN of the runtime and any errors that occured.

Public Property SigningJobArn System.String

Gets and sets the property SigningJobArn.

The ARN of the signing job.

Public Property SigningProfileVersionArn System.String

Gets and sets the property SigningProfileVersionArn.

The ARN of the signing profile version.

Public Property SnapStart Amazon.Lambda.Model.SnapStartResponse

Gets and sets the property SnapStart.

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.

Public Property State Amazon.Lambda.State

Gets and sets the property State.

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

Public Property StateReason System.String

Gets and sets the property StateReason.

The reason for the function's current state.

Public Property StateReasonCode Amazon.Lambda.StateReasonCode

Gets and sets the property StateReasonCode.

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

Public Property Timeout System.Nullable<System.Int32>

Gets and sets the property Timeout.

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

Public Property TracingConfig Amazon.Lambda.Model.TracingConfigResponse

Gets and sets the property TracingConfig.

The function's X-Ray tracing configuration.

Public Property Version System.String

Gets and sets the property Version.

The version of the Lambda function.

Public Property VpcConfig Amazon.Lambda.Model.VpcConfigDetail

Gets and sets the property VpcConfig.

The function's networking configuration.

Examples

The following example returns and configuration details for version 1 of a function named my-function.

To get a Lambda function's event source mapping


var client = new AmazonLambdaClient();
var response = client.GetEventSourceMapping(new GetEventSourceMappingRequest 
{
    UUID = "14e0db71-xmpl-4eb5-b481-8945cf9d10c2"
});

int batchSize = response.BatchSize;
bool bisectBatchOnFunctionError = response.BisectBatchOnFunctionError;
DestinationConfig destinationConfig = response.DestinationConfig;
string eventSourceArn = response.EventSourceArn;
string functionArn = response.FunctionArn;
DateTime lastModified = response.LastModified;
string lastProcessingResult = response.LastProcessingResult;
int maximumRecordAgeInSeconds = response.MaximumRecordAgeInSeconds;
int maximumRetryAttempts = response.MaximumRetryAttempts;
string state = response.State;
string stateTransitionReason = response.StateTransitionReason;
string uuid = response.UUID;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer