amazonka-lambda-2.0: Amazon Lambda SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lambda.GetFunctionConfiguration

Description

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

Creating a Request

data GetFunctionConfiguration Source #

See: newGetFunctionConfiguration smart constructor.

Constructors

GetFunctionConfiguration' 

Fields

  • qualifier :: Maybe Text

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

  • functionName :: Text

    The name of the Lambda function, version, or alias.

    Name formats

    • Function namemy-function (name-only), my-function:v1 (with alias).
    • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.
    • Partial ARN123456789012: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.

Instances

Instances details
ToHeaders GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

ToPath GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

ToQuery GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

AWSRequest GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

Generic GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

Associated Types

type Rep GetFunctionConfiguration :: Type -> Type #

Read GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

Show GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

NFData GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

Eq GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

Hashable GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

type AWSResponse GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

type Rep GetFunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.GetFunctionConfiguration

type Rep GetFunctionConfiguration = D1 ('MetaData "GetFunctionConfiguration" "Amazonka.Lambda.GetFunctionConfiguration" "amazonka-lambda-2.0-FcjxCCKaCGK94C2lDO9alC" 'False) (C1 ('MetaCons "GetFunctionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "qualifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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.

GetFunctionConfiguration, getFunctionConfiguration_functionName - The name of the Lambda function, version, or alias.

Name formats

  • Function namemy-function (name-only), my-function:v1 (with alias).
  • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.
  • Partial ARN123456789012: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 namemy-function (name-only), my-function:v1 (with alias).
  • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.
  • Partial ARN123456789012: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.

Constructors

FunctionConfiguration' 

Fields

Instances

Instances details
FromJSON FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

Generic FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

Associated Types

type Rep FunctionConfiguration :: Type -> Type #

Show FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

NFData FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

Methods

rnf :: FunctionConfiguration -> () #

Eq FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

Hashable FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

type Rep FunctionConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.FunctionConfiguration

type Rep FunctionConfiguration = D1 ('MetaData "FunctionConfiguration" "Amazonka.Lambda.Types.FunctionConfiguration" "amazonka-lambda-2.0-FcjxCCKaCGK94C2lDO9alC" 'False) (C1 ('MetaCons "FunctionConfiguration'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "architectures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Architecture))) :*: S1 ('MetaSel ('Just "codeSha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "codeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "deadLetterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeadLetterConfig)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentResponse))) :*: (S1 ('MetaSel ('Just "ephemeralStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemeralStorage)) :*: S1 ('MetaSel ('Just "fileSystemConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FileSystemConfig]))))) :*: (((S1 ('MetaSel ('Just "functionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "handler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageConfigResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageConfigResponse)))) :*: ((S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LastUpdateStatus)) :*: (S1 ('MetaSel ('Just "lastUpdateStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdateStatusReasonCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LastUpdateStatusReasonCode))))))) :*: ((((S1 ('MetaSel ('Just "layers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Layer])) :*: S1 ('MetaSel ('Just "masterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "memorySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "packageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageType)))) :*: ((S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "runtime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Runtime)) :*: S1 ('MetaSel ('Just "signingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "signingProfileVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapStartResponse))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :*: S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stateReasonCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateReasonCode)) :*: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "tracingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfigResponse)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigResponse)))))))))

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_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_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #

The function's Amazon Resource Name (ARN).

functionConfiguration_handler :: Lens' FunctionConfiguration (Maybe Text) Source #

The function that Lambda calls to begin running your function.

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_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_runtime :: Lens' FunctionConfiguration (Maybe Runtime) Source #

The runtime environment for the Lambda function.

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.