AddLayerVersionPermission

$result = $client->addLayerVersionPermission([/* ... */]);
$promise = $client->addLayerVersionPermissionAsync([/* ... */]);

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

Parameter Syntax

$result = $client->addLayerVersionPermission([
    'Action' => '<string>', // REQUIRED
    'LayerName' => '<string>', // REQUIRED
    'OrganizationId' => '<string>',
    'Principal' => '<string>', // REQUIRED
    'RevisionId' => '<string>',
    'StatementId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RevisionId' => '<string>',
    'Statement' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

ResourceConflictException:

The resource already exists, or another operation is in progress.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

PolicyLengthExceededException:

The permissions policy for the resource is too large. For more information, see Lambda quotas.

PreconditionFailedException:

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

• For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

• For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

Examples

Example 1: To add permissions to a layer version

The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.

$result = $client->addLayerVersionPermission([
    'Action' => 'lambda:GetLayerVersion',
    'LayerName' => 'my-layer',
    'Principal' => '223456789012',
    'StatementId' => 'xaccount',
    'VersionNumber' => 1,
]);

Result syntax:

[
    'RevisionId' => '35d87451-f796-4a3f-a618-95a3671b0a0c',
    'Statement' => '{"Sid":"xaccount","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::223456789012:root"},"Action":"lambda:GetLayerVersion","Resource":"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1"}',
]

AddPermission

$result = $client->addPermission([/* ... */]);
$promise = $client->addPermissionAsync([/* ... */]);

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

Parameter Syntax

$result = $client->addPermission([
    'Action' => '<string>', // REQUIRED
    'EventSourceToken' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'FunctionUrlAuthType' => 'NONE|AWS_IAM',
    'Principal' => '<string>', // REQUIRED
    'PrincipalOrgID' => '<string>',
    'Qualifier' => '<string>',
    'RevisionId' => '<string>',
    'SourceAccount' => '<string>',
    'SourceArn' => '<string>',
    'StatementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Statement' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

ResourceConflictException:

The resource already exists, or another operation is in progress.

InvalidParameterValueException:

One of the parameters in the request is not valid.

PolicyLengthExceededException:

The permissions policy for the resource is too large. For more information, see Lambda quotas.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

PreconditionFailedException:

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

• For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

• For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

Examples

Example 1: To grant Amazon S3 permission to invoke a function

The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.

$result = $client->addPermission([
    'Action' => 'lambda:InvokeFunction',
    'FunctionName' => 'my-function',
    'Principal' => 's3.amazonaws.com',
    'SourceAccount' => '123456789012',
    'SourceArn' => 'arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*',
    'StatementId' => 's3',
]);

Result syntax:

[
    'Statement' => '{"Sid":"s3","Effect":"Allow","Principal":{"Service":"s3.amazonaws.com"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function","Condition":{"StringEquals":{"AWS:SourceAccount":"123456789012"},"ArnLike":{"AWS:SourceArn":"arn:aws:s3:::my-bucket-1xpuxmplzrlbh"}}}',
]

Example 2: To grant another account permission to invoke a function

The following example adds permission for account 223456789012 invoke a Lambda function named my-function.

$result = $client->addPermission([
    'Action' => 'lambda:InvokeFunction',
    'FunctionName' => 'my-function',
    'Principal' => '223456789012',
    'StatementId' => 'xaccount',
]);

Result syntax:

[
    'Statement' => '{"Sid":"xaccount","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::223456789012:root"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function"}',
]

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Parameter Syntax

$result = $client->createAlias([
    'Description' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'FunctionVersion' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]);

Parameter Details

Result Syntax

[
    'AliasArn' => '<string>',
    'Description' => '<string>',
    'FunctionVersion' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

ResourceConflictException:

The resource already exists, or another operation is in progress.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To create an alias for a Lambda function

The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.

$result = $client->createAlias([
    'Description' => 'alias for live version of function',
    'FunctionName' => 'my-function',
    'FunctionVersion' => '1',
    'Name' => 'LIVE',
]);

Result syntax:

[
    'AliasArn' => 'arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE',
    'Description' => 'alias for live version of function',
    'FunctionVersion' => '1',
    'Name' => 'LIVE',
    'RevisionId' => '873282ed-xmpl-4dc8-a069-d0c647e470c6',
]

CreateCodeSigningConfig

$result = $client->createCodeSigningConfig([/* ... */]);
$promise = $client->createCodeSigningConfigAsync([/* ... */]);

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

Parameter Syntax

$result = $client->createCodeSigningConfig([
    'AllowedPublishers' => [ // REQUIRED
        'SigningProfileVersionArns' => ['<string>', ...], // REQUIRED
    ],
    'CodeSigningPolicies' => [
        'UntrustedArtifactOnDeployment' => 'Warn|Enforce',
    ],
    'Description' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CodeSigningConfig' => [
        'AllowedPublishers' => [
            'SigningProfileVersionArns' => ['<string>', ...],
        ],
        'CodeSigningConfigArn' => '<string>',
        'CodeSigningConfigId' => '<string>',
        'CodeSigningPolicies' => [
            'UntrustedArtifactOnDeployment' => 'Warn|Enforce',
        ],
        'Description' => '<string>',
        'LastModified' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

CreateEventSourceMapping

$result = $client->createEventSourceMapping([/* ... */]);
$promise = $client->createEventSourceMappingAsync([/* ... */]);

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

• Amazon DynamoDB Streams

• Amazon Kinesis

• Amazon SQS

• Amazon MQ and RabbitMQ

• Amazon MSK

• Apache Kafka

• Amazon DocumentDB

The following error handling options are available only for DynamoDB and Kinesis event sources:

• BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

• MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

• MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

• ParallelizationFactor – Process multiple batches from each shard concurrently.

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

• DestinationConfig – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or Amazon S3 bucket.

For information about which configuration parameters apply to each event source, see the following topics.

• Amazon DynamoDB Streams

• Amazon Kinesis

• Amazon SQS

• Amazon MQ and RabbitMQ

• Amazon MSK

• Apache Kafka

• Amazon DocumentDB

Parameter Syntax

$result = $client->createEventSourceMapping([
    'AmazonManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'DocumentDBEventSourceConfig' => [
        'CollectionName' => '<string>',
        'DatabaseName' => '<string>',
        'FullDocument' => 'UpdateLookup|Default',
    ],
    'Enabled' => true || false,
    'EventSourceArn' => '<string>',
    'FilterCriteria' => [
        'Filters' => [
            [
                'Pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'FunctionName' => '<string>', // REQUIRED
    'FunctionResponseTypes' => ['<string>', ...],
    'KMSKeyArn' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'MetricsConfig' => [
        'Metrics' => ['<string>', ...],
    ],
    'ParallelizationFactor' => <integer>,
    'ProvisionedPollerConfig' => [
        'MaximumPollers' => <integer>,
        'MinimumPollers' => <integer>,
    ],
    'Queues' => ['<string>', ...],
    'ScalingConfig' => [
        'MaximumConcurrency' => <integer>,
    ],
    'SelfManagedEventSource' => [
        'Endpoints' => [
            '<EndPointType>' => ['<string>', ...],
            // ...
        ],
    ],
    'SelfManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'SourceAccessConfigurations' => [
        [
            'Type' => 'BASIC_AUTH|VPC_SUBNET|VPC_SECURITY_GROUP|SASL_SCRAM_512_AUTH|SASL_SCRAM_256_AUTH|VIRTUAL_HOST|CLIENT_CERTIFICATE_TLS_AUTH|SERVER_ROOT_CA_CERTIFICATE',
            'URI' => '<string>',
        ],
        // ...
    ],
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <integer || string || DateTime>,
    'Tags' => ['<string>', ...],
    'Topics' => ['<string>', ...],
    'TumblingWindowInSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'AmazonManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'DocumentDBEventSourceConfig' => [
        'CollectionName' => '<string>',
        'DatabaseName' => '<string>',
        'FullDocument' => 'UpdateLookup|Default',
    ],
    'EventSourceArn' => '<string>',
    'EventSourceMappingArn' => '<string>',
    'FilterCriteria' => [
        'Filters' => [
            [
                'Pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'FilterCriteriaError' => [
        'ErrorCode' => '<string>',
        'Message' => '<string>',
    ],
    'FunctionArn' => '<string>',
    'FunctionResponseTypes' => ['<string>', ...],
    'KMSKeyArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'MetricsConfig' => [
        'Metrics' => ['<string>', ...],
    ],
    'ParallelizationFactor' => <integer>,
    'ProvisionedPollerConfig' => [
        'MaximumPollers' => <integer>,
        'MinimumPollers' => <integer>,
    ],
    'Queues' => ['<string>', ...],
    'ScalingConfig' => [
        'MaximumConcurrency' => <integer>,
    ],
    'SelfManagedEventSource' => [
        'Endpoints' => [
            '<EndPointType>' => ['<string>', ...],
            // ...
        ],
    ],
    'SelfManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'SourceAccessConfigurations' => [
        [
            'Type' => 'BASIC_AUTH|VPC_SUBNET|VPC_SECURITY_GROUP|SASL_SCRAM_512_AUTH|SASL_SCRAM_256_AUTH|VIRTUAL_HOST|CLIENT_CERTIFICATE_TLS_AUTH|SERVER_ROOT_CA_CERTIFICATE',
            'URI' => '<string>',
        ],
        // ...
    ],
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <DateTime>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'Topics' => ['<string>', ...],
    'TumblingWindowInSeconds' => <integer>,
    'UUID' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceConflictException:

The resource already exists, or another operation is in progress.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceNotFoundException:

The resource specified in the request does not exist.

Examples

Example 1: To create a mapping between an event source and an AWS Lambda function

The following example creates a mapping between an SQS queue and the my-function Lambda function.

$result = $client->createEventSourceMapping([
    'BatchSize' => 5,
    'EventSourceArn' => 'arn:aws:sqs:us-west-2:123456789012:my-queue',
    'FunctionName' => 'my-function',
]);

Result syntax:

[
    'BatchSize' => 5,
    'EventSourceArn' => 'arn:aws:sqs:us-west-2:123456789012:my-queue',
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
    'LastModified' => ,
    'State' => 'Creating',
    'StateTransitionReason' => 'USER_INITIATED',
    'UUID' => 'a1b2c3d4-5678-90ab-cdef-11111EXAMPLE',
]

CreateFunction

$result = $client->createFunction([/* ... */]);
$promise = $client->createFunctionAsync([/* ... */]);

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

Parameter Syntax

$result = $client->createFunction([
    'Architectures' => ['<string>', ...],
    'Code' => [ // REQUIRED
        'ImageUri' => '<string>',
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3ObjectVersion' => '<string>',
        'SourceKMSKeyArn' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'CodeSigningConfigArn' => '<string>',
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Variables' => ['<string>', ...],
    ],
    'EphemeralStorage' => [
        'Size' => <integer>, // REQUIRED
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>', // REQUIRED
            'LocalMountPath' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FunctionName' => '<string>', // REQUIRED
    'Handler' => '<string>',
    'ImageConfig' => [
        'Command' => ['<string>', ...],
        'EntryPoint' => ['<string>', ...],
        'WorkingDirectory' => '<string>',
    ],
    'KMSKeyArn' => '<string>',
    'Layers' => ['<string>', ...],
    'LoggingConfig' => [
        'ApplicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
        'LogFormat' => 'JSON|Text',
        'LogGroup' => '<string>',
        'SystemLogLevel' => 'DEBUG|INFO|WARN',
    ],
    'MemorySize' => <integer>,
    'PackageType' => 'Zip|Image',
    'Publish' => true || false,
    'Role' => '<string>', // REQUIRED
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|nodejs14.x|nodejs16.x|java8|java8.al2|java11|python2.7|python3.6|python3.7|python3.8|python3.9|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|dotnet6|dotnet8|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided|provided.al2|nodejs18.x|python3.10|java17|ruby3.2|ruby3.3|ruby3.4|python3.11|nodejs20.x|provided.al2023|python3.12|java21|python3.13|nodejs22.x',
    'SnapStart' => [
        'ApplyOn' => 'PublishedVersions|None',
    ],
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'Architectures' => ['<string>', ...],
    'CodeSha256' => '<string>',
    'CodeSize' => <integer>,
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'Variables' => ['<string>', ...],
    ],
    'EphemeralStorage' => [
        'Size' => <integer>,
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>',
            'LocalMountPath' => '<string>',
        ],
        // ...
    ],
    'FunctionArn' => '<string>',
    'FunctionName' => '<string>',
    'Handler' => '<string>',
    'ImageConfigResponse' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'ImageConfig' => [
            'Command' => ['<string>', ...],
            'EntryPoint' => ['<string>', ...],
            'WorkingDirectory' => '<string>',
        ],
    ],
    'KMSKeyArn' => '<string>',
    'LastModified' => '<string>',
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
            'SigningJobArn' => '<string>',
            'SigningProfileVersionArn' => '<string>',
        ],
        // ...
    ],
    'LoggingConfig' => [
        'ApplicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
        'LogFormat' => 'JSON|Text',
        'LogGroup' => '<string>',
        'SystemLogLevel' => 'DEBUG|INFO|WARN',
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'PackageType' => 'Zip|Image',
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|nodejs14.x|nodejs16.x|java8|java8.al2|java11|python2.7|python3.6|python3.7|python3.8|python3.9|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|dotnet6|dotnet8|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided|provided.al2|nodejs18.x|python3.10|java17|ruby3.2|ruby3.3|ruby3.4|python3.11|nodejs20.x|provided.al2023|python3.12|java21|python3.13|nodejs22.x',
    'RuntimeVersionConfig' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'RuntimeVersionArn' => '<string>',
    ],
    'SigningJobArn' => '<string>',
    'SigningProfileVersionArn' => '<string>',
    'SnapStart' => [
        'ApplyOn' => 'PublishedVersions|None',
        'OptimizationStatus' => 'On|Off',
    ],
    'State' => 'Pending|Active|Inactive|Failed',
    'StateReason' => '<string>',
    'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

ResourceConflictException:

The resource already exists, or another operation is in progress.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

CodeStorageExceededException:

Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.

CodeVerificationFailedException:

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.

InvalidCodeSignatureException:

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.

CodeSigningConfigNotFoundException:

The specified code signing configuration does not exist.

Examples

Example 1: To create a function

The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.

$result = $client->createFunction([
    'Code' => [
        'S3Bucket' => 'my-bucket-1xpuxmplzrlbh',
        'S3Key' => 'function.zip',
    ],
    'Description' => 'Process image objects from Amazon S3.',
    'Environment' => [
        'Variables' => [
            'BUCKET' => 'my-bucket-1xpuxmplzrlbh',
            'PREFIX' => 'inbound',
        ],
    ],
    'FunctionName' => 'my-function',
    'Handler' => 'index.handler',
    'KMSKeyArn' => 'arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966',
    'MemorySize' => 256,
    'Publish' => 1,
    'Role' => 'arn:aws:iam::123456789012:role/lambda-role',
    'Runtime' => 'nodejs12.x',
    'Tags' => [
        'DEPARTMENT' => 'Assets',
    ],
    'Timeout' => 15,
    'TracingConfig' => [
        'Mode' => 'Active',
    ],
]);

Result syntax:

[
    'CodeSha256' => 'YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=',
    'CodeSize' => 5797206,
    'Description' => 'Process image objects from Amazon S3.',
    'Environment' => [
        'Variables' => [
            'BUCKET' => 'my-bucket-1xpuxmplzrlbh',
            'PREFIX' => 'inbound',
        ],
    ],
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
    'FunctionName' => 'my-function',
    'Handler' => 'index.handler',
    'KMSKeyArn' => 'arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966',
    'LastModified' => '2020-04-10T19:06:32.563+0000',
    'LastUpdateStatus' => 'Successful',
    'MemorySize' => 256,
    'RevisionId' => 'b75dcd81-xmpl-48a8-a75a-93ba8b5b9727',
    'Role' => 'arn:aws:iam::123456789012:role/lambda-role',
    'Runtime' => 'nodejs12.x',
    'State' => 'Active',
    'Timeout' => 15,
    'TracingConfig' => [
        'Mode' => 'Active',
    ],
    'Version' => '1',
]

CreateFunctionUrlConfig

$result = $client->createFunctionUrlConfig([/* ... */]);
$promise = $client->createFunctionUrlConfigAsync([/* ... */]);

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Parameter Syntax

$result = $client->createFunctionUrlConfig([
    'AuthType' => 'NONE|AWS_IAM', // REQUIRED
    'Cors' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'FunctionName' => '<string>', // REQUIRED
    'InvokeMode' => 'BUFFERED|RESPONSE_STREAM',
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AuthType' => 'NONE|AWS_IAM',
    'Cors' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'CreationTime' => '<string>',
    'FunctionArn' => '<string>',
    'FunctionUrl' => '<string>',
    'InvokeMode' => 'BUFFERED|RESPONSE_STREAM',
]

Result Details

Errors

ResourceConflictException:

The resource already exists, or another operation is in progress.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ServiceException:

The Lambda service encountered an internal error.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Deletes a Lambda function alias.

Parameter Syntax

$result = $client->deleteAlias([
    'FunctionName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceConflictException:

The resource already exists, or another operation is in progress.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To delete a Lambda function alias

The following example deletes an alias named BLUE from a function named my-function

$result = $client->deleteAlias([
    'FunctionName' => 'my-function',
    'Name' => 'BLUE',
]);

DeleteCodeSigningConfig

$result = $client->deleteCodeSigningConfig([/* ... */]);
$promise = $client->deleteCodeSigningConfigAsync([/* ... */]);

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

Parameter Syntax

$result = $client->deleteCodeSigningConfig([
    'CodeSigningConfigArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

ResourceConflictException:

The resource already exists, or another operation is in progress.

DeleteEventSourceMapping

$result = $client->deleteEventSourceMapping([/* ... */]);
$promise = $client->deleteEventSourceMappingAsync([/* ... */]);

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

Parameter Syntax

$result = $client->deleteEventSourceMapping([
    'UUID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AmazonManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'DocumentDBEventSourceConfig' => [
        'CollectionName' => '<string>',
        'DatabaseName' => '<string>',
        'FullDocument' => 'UpdateLookup|Default',
    ],
    'EventSourceArn' => '<string>',
    'EventSourceMappingArn' => '<string>',
    'FilterCriteria' => [
        'Filters' => [
            [
                'Pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'FilterCriteriaError' => [
        'ErrorCode' => '<string>',
        'Message' => '<string>',
    ],
    'FunctionArn' => '<string>',
    'FunctionResponseTypes' => ['<string>', ...],
    'KMSKeyArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'MetricsConfig' => [
        'Metrics' => ['<string>', ...],
    ],
    'ParallelizationFactor' => <integer>,
    'ProvisionedPollerConfig' => [
        'MaximumPollers' => <integer>,
        'MinimumPollers' => <integer>,
    ],
    'Queues' => ['<string>', ...],
    'ScalingConfig' => [
        'MaximumConcurrency' => <integer>,
    ],
    'SelfManagedEventSource' => [
        'Endpoints' => [
            '<EndPointType>' => ['<string>', ...],
            // ...
        ],
    ],
    'SelfManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'SourceAccessConfigurations' => [
        [
            'Type' => 'BASIC_AUTH|VPC_SUBNET|VPC_SECURITY_GROUP|SASL_SCRAM_512_AUTH|SASL_SCRAM_256_AUTH|VIRTUAL_HOST|CLIENT_CERTIFICATE_TLS_AUTH|SERVER_ROOT_CA_CERTIFICATE',
            'URI' => '<string>',
        ],
        // ...
    ],
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <DateTime>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'Topics' => ['<string>', ...],
    'TumblingWindowInSeconds' => <integer>,
    'UUID' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceConflictException:

The resource already exists, or another operation is in progress.

ResourceInUseException:

The operation conflicts with the resource's availability. For example, you tried to update an event source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

Examples

Example 1: To delete a Lambda function event source mapping

The following example deletes an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.

$result = $client->deleteEventSourceMapping([
    'UUID' => '14e0db71-xmpl-4eb5-b481-8945cf9d10c2',
]);

Result syntax:

[
    'BatchSize' => 5,
    'EventSourceArn' => 'arn:aws:sqs:us-west-2:123456789012:my-queue',
    'FunctionArn' => 'arn:aws:lambda:us-east-2:123456789012:function:my-function',
    'LastModified' => ,
    'State' => 'Enabled',
    'StateTransitionReason' => 'USER_INITIATED',
    'UUID' => '14e0db71-xmpl-4eb5-b481-8945cf9d10c2',
]

DeleteFunction

$result = $client->deleteFunction([/* ... */]);
$promise = $client->deleteFunctionAsync([/* ... */]);

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

Parameter Syntax

$result = $client->deleteFunction([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceConflictException:

The resource already exists, or another operation is in progress.

Examples

Example 1: To delete a version of a Lambda function

The following example deletes version 1 of a Lambda function named my-function.

$result = $client->deleteFunction([
    'FunctionName' => 'my-function',
    'Qualifier' => '1',
]);

DeleteFunctionCodeSigningConfig

$result = $client->deleteFunctionCodeSigningConfig([/* ... */]);
$promise = $client->deleteFunctionCodeSigningConfigAsync([/* ... */]);

Removes the code signing configuration from the function.

Parameter Syntax

$result = $client->deleteFunctionCodeSigningConfig([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

CodeSigningConfigNotFoundException:

The specified code signing configuration does not exist.

ResourceNotFoundException:

The resource specified in the request does not exist.

ServiceException:

The Lambda service encountered an internal error.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceConflictException:

The resource already exists, or another operation is in progress.

DeleteFunctionConcurrency

$result = $client->deleteFunctionConcurrency([/* ... */]);
$promise = $client->deleteFunctionConcurrencyAsync([/* ... */]);

Removes a concurrent execution limit from a function.

Parameter Syntax

$result = $client->deleteFunctionConcurrency([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceConflictException:

The resource already exists, or another operation is in progress.

Examples

Example 1: To remove the reserved concurrent execution limit from a function

The following example deletes the reserved concurrent execution limit from a function named my-function.

$result = $client->deleteFunctionConcurrency([
    'FunctionName' => 'my-function',
]);

DeleteFunctionEventInvokeConfig

$result = $client->deleteFunctionEventInvokeConfig([/* ... */]);
$promise = $client->deleteFunctionEventInvokeConfigAsync([/* ... */]);

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Parameter Syntax

$result = $client->deleteFunctionEventInvokeConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceConflictException:

The resource already exists, or another operation is in progress.

Examples

Example 1: To delete an asynchronous invocation configuration

The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.

$result = $client->deleteFunctionEventInvokeConfig([
    'FunctionName' => 'my-function',
    'Qualifier' => 'GREEN',
]);

DeleteFunctionUrlConfig

$result = $client->deleteFunctionUrlConfig([/* ... */]);
$promise = $client->deleteFunctionUrlConfigAsync([/* ... */]);

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.

Parameter Syntax

$result = $client->deleteFunctionUrlConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceConflictException:

The resource already exists, or another operation is in progress.

ResourceNotFoundException:

The resource specified in the request does not exist.

ServiceException:

The Lambda service encountered an internal error.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

DeleteLayerVersion

$result = $client->deleteLayerVersion([/* ... */]);
$promise = $client->deleteLayerVersionAsync([/* ... */]);

Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

Parameter Syntax

$result = $client->deleteLayerVersion([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To delete a version of a Lambda layer

The following example deletes version 2 of a layer named my-layer.

$result = $client->deleteLayerVersion([
    'LayerName' => 'my-layer',
    'VersionNumber' => 2,
]);

DeleteProvisionedConcurrencyConfig

$result = $client->deleteProvisionedConcurrencyConfig([/* ... */]);
$promise = $client->deleteProvisionedConcurrencyConfigAsync([/* ... */]);

Deletes the provisioned concurrency configuration for a function.

Parameter Syntax

$result = $client->deleteProvisionedConcurrencyConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceConflictException:

The resource already exists, or another operation is in progress.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ServiceException:

The Lambda service encountered an internal error.

Examples

Example 1: To delete a provisioned concurrency configuration

The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.

$result = $client->deleteProvisionedConcurrencyConfig([
    'FunctionName' => 'my-function',
    'Qualifier' => 'GREEN',
]);

GetAccountSettings

$result = $client->getAccountSettings([/* ... */]);
$promise = $client->getAccountSettingsAsync([/* ... */]);

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

Parameter Syntax

$result = $client->getAccountSettings([
]);

Parameter Details

Result Syntax

[
    'AccountLimit' => [
        'CodeSizeUnzipped' => <integer>,
        'CodeSizeZipped' => <integer>,
        'ConcurrentExecutions' => <integer>,
        'TotalCodeSize' => <integer>,
        'UnreservedConcurrentExecutions' => <integer>,
    ],
    'AccountUsage' => [
        'FunctionCount' => <integer>,
        'TotalCodeSize' => <integer>,
    ],
]

Result Details

Errors

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ServiceException:

The Lambda service encountered an internal error.

Examples

Example 1: To get account settings

This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.

$result = $client->getAccountSettings([
]);

Result syntax:

[
    'AccountLimit' => [
        'CodeSizeUnzipped' => 262144000,
        'CodeSizeZipped' => 52428800,
        'ConcurrentExecutions' => 1000,
        'TotalCodeSize' => 80530636800,
        'UnreservedConcurrentExecutions' => 1000,
    ],
    'AccountUsage' => [
        'FunctionCount' => 4,
        'TotalCodeSize' => 9426,
    ],
]

GetAlias

$result = $client->getAlias([/* ... */]);
$promise = $client->getAliasAsync([/* ... */]);

Returns details about a Lambda function alias.

Parameter Syntax

$result = $client->getAlias([
    'FunctionName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AliasArn' => '<string>',
    'Description' => '<string>',
    'FunctionVersion' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To get a Lambda function alias

The following example returns details about an alias named BLUE for a function named my-function

$result = $client->getAlias([
    'FunctionName' => 'my-function',
    'Name' => 'BLUE',
]);

Result syntax:

[
    'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE',
    'Description' => 'Production environment BLUE.',
    'FunctionVersion' => '3',
    'Name' => 'BLUE',
    'RevisionId' => '594f41fb-xmpl-4c20-95c7-6ca5f2a92c93',
]

GetCodeSigningConfig

$result = $client->getCodeSigningConfig([/* ... */]);
$promise = $client->getCodeSigningConfigAsync([/* ... */]);

Returns information about the specified code signing configuration.

Parameter Syntax

$result = $client->getCodeSigningConfig([
    'CodeSigningConfigArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CodeSigningConfig' => [
        'AllowedPublishers' => [
            'SigningProfileVersionArns' => ['<string>', ...],
        ],
        'CodeSigningConfigArn' => '<string>',
        'CodeSigningConfigId' => '<string>',
        'CodeSigningPolicies' => [
            'UntrustedArtifactOnDeployment' => 'Warn|Enforce',
        ],
        'Description' => '<string>',
        'LastModified' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

GetEventSourceMapping

$result = $client->getEventSourceMapping([/* ... */]);
$promise = $client->getEventSourceMappingAsync([/* ... */]);

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

Parameter Syntax

$result = $client->getEventSourceMapping([
    'UUID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AmazonManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'DocumentDBEventSourceConfig' => [
        'CollectionName' => '<string>',
        'DatabaseName' => '<string>',
        'FullDocument' => 'UpdateLookup|Default',
    ],
    'EventSourceArn' => '<string>',
    'EventSourceMappingArn' => '<string>',
    'FilterCriteria' => [
        'Filters' => [
            [
                'Pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'FilterCriteriaError' => [
        'ErrorCode' => '<string>',
        'Message' => '<string>',
    ],
    'FunctionArn' => '<string>',
    'FunctionResponseTypes' => ['<string>', ...],
    'KMSKeyArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'MetricsConfig' => [
        'Metrics' => ['<string>', ...],
    ],
    'ParallelizationFactor' => <integer>,
    'ProvisionedPollerConfig' => [
        'MaximumPollers' => <integer>,
        'MinimumPollers' => <integer>,
    ],
    'Queues' => ['<string>', ...],
    'ScalingConfig' => [
        'MaximumConcurrency' => <integer>,
    ],
    'SelfManagedEventSource' => [
        'Endpoints' => [
            '<EndPointType>' => ['<string>', ...],
            // ...
        ],
    ],
    'SelfManagedKafkaEventSourceConfig' => [
        'ConsumerGroupId' => '<string>',
    ],
    'SourceAccessConfigurations' => [
        [
            'Type' => 'BASIC_AUTH|VPC_SUBNET|VPC_SECURITY_GROUP|SASL_SCRAM_512_AUTH|SASL_SCRAM_256_AUTH|VIRTUAL_HOST|CLIENT_CERTIFICATE_TLS_AUTH|SERVER_ROOT_CA_CERTIFICATE',
            'URI' => '<string>',
        ],
        // ...
    ],
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <DateTime>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'Topics' => ['<string>', ...],
    'TumblingWindowInSeconds' => <integer>,
    'UUID' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To get a Lambda function's event source mapping

The following example returns details about an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.

$result = $client->getEventSourceMapping([
    'UUID' => '14e0db71-xmpl-4eb5-b481-8945cf9d10c2',
]);

Result syntax:

[
    'BatchSize' => 500,
    'BisectBatchOnFunctionError' => ,
    'DestinationConfig' => [
    ],
    'EventSourceArn' => 'arn:aws:sqs:us-east-2:123456789012:mySQSqueue',
    'FunctionArn' => 'arn:aws:lambda:us-east-2:123456789012:function:myFunction',
    'LastModified' => ,
    'LastProcessingResult' => 'No records processed',
    'MaximumRecordAgeInSeconds' => 604800,
    'MaximumRetryAttempts' => 10000,
    'State' => 'Creating',
    'StateTransitionReason' => 'User action',
    'UUID' => '14e0db71-xmpl-4eb5-b481-8945cf9d10c2',
]

GetFunction

$result = $client->getFunction([/* ... */]);
$promise = $client->getFunctionAsync([/* ... */]);

Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

Parameter Syntax

$result = $client->getFunction([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Code' => [
        'ImageUri' => '<string>',
        'Location' => '<string>',
        'RepositoryType' => '<string>',
        'ResolvedImageUri' => '<string>',
        'SourceKMSKeyArn' => '<string>',
    ],
    'Concurrency' => [
        'ReservedConcurrentExecutions' => <integer>,
    ],
    'Configuration' => [
        'Architectures' => ['<string>', ...],
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'DeadLetterConfig' => [
            'TargetArn' => '<string>',
        ],
        'Description' => '<string>',
        'Environment' => [
            'Error' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'Variables' => ['<string>', ...],
        ],
        'EphemeralStorage' => [
            'Size' => <integer>,
        ],
        'FileSystemConfigs' => [
            [
                'Arn' => '<string>',
                'LocalMountPath' => '<string>',
            ],
            // ...
        ],
        'FunctionArn' => '<string>',
        'FunctionName' => '<string>',
        'Handler' => '<string>',
        'ImageConfigResponse' => [
            'Error' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'ImageConfig' => [
                'Command' => ['<string>', ...],
                'EntryPoint' => ['<string>', ...],
                'WorkingDirectory' => '<string>',
            ],
        ],
        'KMSKeyArn' => '<string>',
        'LastModified' => '<string>',
        'LastUpdateStatus' => 'Successful|Failed|InProgress',
        'LastUpdateStatusReason' => '<string>',
        'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
        'Layers' => [
            [
                'Arn' => '<string>',
                'CodeSize' => <integer>,
                'SigningJobArn' => '<string>',
                'SigningProfileVersionArn' => '<string>',
            ],
            // ...
        ],
        'LoggingConfig' => [
            'ApplicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
            'LogFormat' => 'JSON|Text',
            'LogGroup' => '<string>',
            'SystemLogLevel' => 'DEBUG|INFO|WARN',
        ],
        'MasterArn' => '<string>',
        'MemorySize' => <integer>,
        'PackageType' => 'Zip|Image',
        'RevisionId' => '<string>',
        'Role' => '<string>',
        'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|nodejs14.x|nodejs16.x|java8|java8.al2|java11|python2.7|python3.6|python3.7|python3.8|python3.9|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|dotnet6|dotnet8|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided|provided.al2|nodejs18.x|python3.10|java17|ruby3.2|ruby3.3|ruby3.4|python3.11|nodejs20.x|provided.al2023|python3.12|java21|python3.13|nodejs22.x',
        'RuntimeVersionConfig' => [
            'Error' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'RuntimeVersionArn' => '<string>',
        ],
        'SigningJobArn' => '<string>',
        'SigningProfileVersionArn' => '<string>',
        'SnapStart' => [
            'ApplyOn' => 'PublishedVersions|None',
            'OptimizationStatus' => 'On|Off',
        ],
        'State' => 'Pending|Active|Inactive|Failed',
        'StateReason' => '<string>',
        'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
        'Timeout' => <integer>,
        'TracingConfig' => [
            'Mode' => 'Active|PassThrough',
        ],
        'Version' => '<string>',
        'VpcConfig' => [
            'Ipv6AllowedForDualStack' => true || false,
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
    ],
    'Tags' => ['<string>', ...],
    'TagsError' => [
        'ErrorCode' => '<string>',
        'Message' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

Examples

Example 1: To get a Lambda function

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

$result = $client->getFunction([
    'FunctionName' => 'my-function',
    'Qualifier' => '1',
]);

Result syntax:

[
    'Code' => [
        'Location' => 'https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...',
        'RepositoryType' => 'S3',
    ],
    'Configuration' => [
        'CodeSha256' => 'YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=',
        'CodeSize' => 5797206,
        'Description' => 'Process image objects from Amazon S3.',
        'Environment' => [
            'Variables' => [
                'BUCKET' => 'my-bucket-1xpuxmplzrlbh',
                'PREFIX' => 'inbound',
            ],
        ],
        'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
        'FunctionName' => 'my-function',
        'Handler' => 'index.handler',
        'KMSKeyArn' => 'arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966',
        'LastModified' => '2020-04-10T19:06:32.563+0000',
        'LastUpdateStatus' => 'Successful',
        'MemorySize' => 256,
        'RevisionId' => 'b75dcd81-xmpl-48a8-a75a-93ba8b5b9727',
        'Role' => 'arn:aws:iam::123456789012:role/lambda-role',
        'Runtime' => 'nodejs12.x',
        'State' => 'Active',
        'Timeout' => 15,
        'TracingConfig' => [
            'Mode' => 'Active',
        ],
        'Version' => '$LATEST',
    ],
    'Tags' => [
        'DEPARTMENT' => 'Assets',
    ],
]

GetFunctionCodeSigningConfig

$result = $client->getFunctionCodeSigningConfig([/* ... */]);
$promise = $client->getFunctionCodeSigningConfigAsync([/* ... */]);

Returns the code signing configuration for the specified function.

Parameter Syntax

$result = $client->getFunctionCodeSigningConfig([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CodeSigningConfigArn' => '<string>',
    'FunctionName' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

ServiceException:

The Lambda service encountered an internal error.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

GetFunctionConcurrency

$result = $client->getFunctionConcurrency([/* ... */]);
$promise = $client->getFunctionConcurrencyAsync([/* ... */]);

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

Parameter Syntax

$result = $client->getFunctionConcurrency([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReservedConcurrentExecutions' => <integer>,
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ServiceException:

The Lambda service encountered an internal error.

Examples

Example 1: To get the reserved concurrency setting for a function

The following example returns the reserved concurrency setting for a function named my-function.

$result = $client->getFunctionConcurrency([
    'FunctionName' => 'my-function',
]);

Result syntax:

[
    'ReservedConcurrentExecutions' => 250,
]

GetFunctionConfiguration

$result = $client->getFunctionConfiguration([/* ... */]);
$promise = $client->getFunctionConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getFunctionConfiguration([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Architectures' => ['<string>', ...],
    'CodeSha256' => '<string>',
    'CodeSize' => <integer>,
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'Variables' => ['<string>', ...],
    ],
    'EphemeralStorage' => [
        'Size' => <integer>,
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>',
            'LocalMountPath' => '<string>',
        ],
        // ...
    ],
    'FunctionArn' => '<string>',
    'FunctionName' => '<string>',
    'Handler' => '<string>',
    'ImageConfigResponse' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'ImageConfig' => [
            'Command' => ['<string>', ...],
            'EntryPoint' => ['<string>', ...],
            'WorkingDirectory' => '<string>',
        ],
    ],
    'KMSKeyArn' => '<string>',
    'LastModified' => '<string>',
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
            'SigningJobArn' => '<string>',
            'SigningProfileVersionArn' => '<string>',
        ],
        // ...
    ],
    'LoggingConfig' => [
        'ApplicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
        'LogFormat' => 'JSON|Text',
        'LogGroup' => '<string>',
        'SystemLogLevel' => 'DEBUG|INFO|WARN',
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'PackageType' => 'Zip|Image',
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|nodejs14.x|nodejs16.x|java8|java8.al2|java11|python2.7|python3.6|python3.7|python3.8|python3.9|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|dotnet6|dotnet8|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided|provided.al2|nodejs18.x|python3.10|java17|ruby3.2|ruby3.3|ruby3.4|python3.11|nodejs20.x|provided.al2023|python3.12|java21|python3.13|nodejs22.x',
    'RuntimeVersionConfig' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'RuntimeVersionArn' => '<string>',
    ],
    'SigningJobArn' => '<string>',
    'SigningProfileVersionArn' => '<string>',
    'SnapStart' => [
        'ApplyOn' => 'PublishedVersions|None',
        'OptimizationStatus' => 'On|Off',
    ],
    'State' => 'Pending|Active|Inactive|Failed',
    'StateReason' => '<string>',
    'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup|ImageDeleted|ImageAccessDenied|InvalidImage|KMSKeyAccessDenied|KMSKeyNotFound|InvalidStateKMSKey|DisabledKMSKey|EFSIOError|EFSMountConnectivityError|EFSMountFailure|EFSMountTimeout|InvalidRuntime|InvalidZipFileException|FunctionError',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

Examples

Example 1: To get a Lambda function's event source mapping

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

$result = $client->getFunctionConfiguration([
    'FunctionName' => 'my-function',
    'Qualifier' => '1',
]);

Result syntax:

[
    'CodeSha256' => 'YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=',
    'CodeSize' => 5797206,
    'Description' => 'Process image objects from Amazon S3.',
    'Environment' => [
        'Variables' => [
            'BUCKET' => 'my-bucket-1xpuxmplzrlbh',
            'PREFIX' => 'inbound',
        ],
    ],
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
    'FunctionName' => 'my-function',
    'Handler' => 'index.handler',
    'KMSKeyArn' => 'arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966',
    'LastModified' => '2020-04-10T19:06:32.563+0000',
    'LastUpdateStatus' => 'Successful',
    'MemorySize' => 256,
    'RevisionId' => 'b75dcd81-xmpl-48a8-a75a-93ba8b5b9727',
    'Role' => 'arn:aws:iam::123456789012:role/lambda-role',
    'Runtime' => 'nodejs12.x',
    'State' => 'Active',
    'Timeout' => 15,
    'TracingConfig' => [
        'Mode' => 'Active',
    ],
    'Version' => '$LATEST',
]

GetFunctionEventInvokeConfig

$result = $client->getFunctionEventInvokeConfig([/* ... */]);
$promise = $client->getFunctionEventInvokeConfigAsync([/* ... */]);

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Parameter Syntax

$result = $client->getFunctionEventInvokeConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'MaximumEventAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Examples

Example 1: To get an asynchronous invocation configuration

The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.

$result = $client->getFunctionEventInvokeConfig([
    'FunctionName' => 'my-function',
    'Qualifier' => 'BLUE',
]);

Result syntax:

[
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => 'arn:aws:sqs:us-east-2:123456789012:failed-invocations',
        ],
        'OnSuccess' => [
        ],
    ],
    'FunctionArn' => 'arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE',
    'LastModified' => ,
    'MaximumEventAgeInSeconds' => 3600,
    'MaximumRetryAttempts' => 0,
]

GetFunctionRecursionConfig

$result = $client->getFunctionRecursionConfig([/* ... */]);
$promise = $client->getFunctionRecursionConfigAsync([/* ... */]);

Returns your function's recursive loop detection configuration.

Parameter Syntax

$result = $client->getFunctionRecursionConfig([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecursiveLoop' => 'Allow|Terminate',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ServiceException:

The Lambda service encountered an internal error.

GetFunctionUrlConfig

$result = $client->getFunctionUrlConfig([/* ... */]);
$promise = $client->getFunctionUrlConfigAsync([/* ... */]);

Returns details about a Lambda function URL.

Parameter Syntax

$result = $client->getFunctionUrlConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AuthType' => 'NONE|AWS_IAM',
    'Cors' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'CreationTime' => '<string>',
    'FunctionArn' => '<string>',
    'FunctionUrl' => '<string>',
    'InvokeMode' => 'BUFFERED|RESPONSE_STREAM',
    'LastModifiedTime' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

GetLayerVersion

$result = $client->getLayerVersion([/* ... */]);
$promise = $client->getLayerVersionAsync([/* ... */]);

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

Parameter Syntax

$result = $client->getLayerVersion([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompatibleArchitectures' => ['<string>', ...],
    'CompatibleRuntimes' => ['<string>', ...],
    'Content' => [
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'Location' => '<string>',
        'SigningJobArn' => '<string>',
        'SigningProfileVersionArn' => '<string>',
    ],
    'CreatedDate' => '<string>',
    'Description' => '<string>',
    'LayerArn' => '<string>',
    'LayerVersionArn' => '<string>',
    'LicenseInfo' => '<string>',
    'Version' => <integer>,
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceNotFoundException:

The resource specified in the request does not exist.

Examples

Example 1: To get information about a Lambda layer version

The following example returns information for version 1 of a layer named my-layer.

$result = $client->getLayerVersion([
    'LayerName' => 'my-layer',
    'VersionNumber' => 1,
]);

Result syntax:

[
    'CompatibleRuntimes' => [
        'python3.6',
        'python3.7',
    ],
    'Content' => [
        'CodeSha256' => 'tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=',
        'CodeSize' => 169,
        'Location' => 'https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...',
    ],
    'CreatedDate' => '2018-11-14T23:03:52.894+0000',
    'Description' => 'My Python layer',
    'LayerArn' => 'arn:aws:lambda:us-east-2:123456789012:layer:my-layer',
    'LayerVersionArn' => 'arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1',
    'LicenseInfo' => 'MIT',
    'Version' => 1,
]

GetLayerVersionByArn

$result = $client->getLayerVersionByArn([/* ... */]);
$promise = $client->getLayerVersionByArnAsync([/* ... */]);

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

Parameter Syntax

$result = $client->getLayerVersionByArn([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompatibleArchitectures' => ['<string>', ...],
    'CompatibleRuntimes' => ['<string>', ...],
    'Content' => [
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'Location' => '<string>',
        'SigningJobArn' => '<string>',
        'SigningProfileVersionArn' => '<string>',
    ],
    'CreatedDate' => '<string>',
    'Description' => '<string>',
    'LayerArn' => '<string>',
    'LayerVersionArn' => '<string>',
    'LicenseInfo' => '<string>',
    'Version' => <integer>,
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ResourceNotFoundException:

The resource specified in the request does not exist.

Examples

Example 1: To get information about a Lambda layer version

The following example returns information about the layer version with the specified Amazon Resource Name (ARN).

$result = $client->getLayerVersionByArn([
    'Arn' => 'arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3',
]);

Result syntax:

[
    'CompatibleRuntimes' => [
        'python3.8',
    ],
    'Content' => [
        'CodeSha256' => '6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=',
        'CodeSize' => 9529009,
        'Location' => 'https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf...',
    ],
    'CreatedDate' => '2020-03-31T00:35:18.949+0000',
    'Description' => 'Dependencies for the blank-python sample app.',
    'LayerArn' => 'arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib',
    'LayerVersionArn' => 'arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3',
    'Version' => 3,
]

GetLayerVersionPolicy

$result = $client->getLayerVersionPolicy([/* ... */]);
$promise = $client->getLayerVersionPolicyAsync([/* ... */]);

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Parameter Syntax

$result = $client->getLayerVersionPolicy([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Returns the resource-based IAM policy for a function, version, or alias.

Parameter Syntax

$result = $client->getPolicy([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

Examples

Example 1: To retrieve a Lambda function policy

The following example returns the resource-based policy for version 1 of a Lambda function named my-function.

$result = $client->getPolicy([
    'FunctionName' => 'my-function',
    'Qualifier' => '1',
]);

Result syntax:

[
    'Policy' => '{"Version":"2012-10-17","Id":"default","Statement":[{"Sid":"xaccount","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function:1"}]}',
    'RevisionId' => '4843f2f6-7c59-4fda-b484-afd0bc0e22b8',
]

GetProvisionedConcurrencyConfig

$result = $client->getProvisionedConcurrencyConfig([/* ... */]);
$promise = $client->getProvisionedConcurrencyConfigAsync([/* ... */]);

Retrieves the provisioned concurrency configuration for a function's alias or version.

Parameter Syntax

$result = $client->getProvisionedConcurrencyConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AllocatedProvisionedConcurrentExecutions' => <integer>,
    'AvailableProvisionedConcurrentExecutions' => <integer>,
    'LastModified' => '<string>',
    'RequestedProvisionedConcurrentExecutions' => <integer>,
    'Status' => 'IN_PROGRESS|READY|FAILED',
    'StatusReason' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

ServiceException:

The Lambda service encountered an internal error.

ProvisionedConcurrencyConfigNotFoundException:

The specified configuration does not exist.

Examples

Example 1: To get a provisioned concurrency configuration

The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.

$result = $client->getProvisionedConcurrencyConfig([
    'FunctionName' => 'my-function',
    'Qualifier' => 'BLUE',
]);

Result syntax:

[
    'AllocatedProvisionedConcurrentExecutions' => 100,
    'AvailableProvisionedConcurrentExecutions' => 100,
    'LastModified' => '2019-12-31T20:28:49+0000',
    'RequestedProvisionedConcurrentExecutions' => 100,
    'Status' => 'READY',
]

Example 2: To view a provisioned concurrency configuration

The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.

$result = $client->getProvisionedConcurrencyConfig([
    'FunctionName' => 'my-function',
    'Qualifier' => 'BLUE',
]);

Result syntax:

[
    'AllocatedProvisionedConcurrentExecutions' => 100,
    'AvailableProvisionedConcurrentExecutions' => 100,
    'LastModified' => '2019-12-31T20:28:49+0000',
    'RequestedProvisionedConcurrentExecutions' => 100,
    'Status' => 'READY',
]

GetRuntimeManagementConfig

$result = $client->getRuntimeManagementConfig([/* ... */]);
$promise = $client->getRuntimeManagementConfigAsync([/* ... */]);

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

Parameter Syntax

$result = $client->getRuntimeManagementConfig([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FunctionArn' => '<string>',
    'RuntimeVersionArn' => '<string>',
    'UpdateRuntimeOn' => 'Auto|Manual|FunctionUpdate',
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidParameterValueException:

One of the parameters in the request is not valid.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

Invoke

$result = $client->invoke([/* ... */]);
$promise = $client->invokeAsync([/* ... */]);

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

Parameter Syntax

$result = $client->invoke([
    'ClientContext' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'InvocationType' => 'Event|RequestResponse|DryRun',
    'LogType' => 'None|Tail',
    'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Qualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ExecutedVersion' => '<string>',
    'FunctionError' => '<string>',
    'LogResult' => '<string>',
    'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
    'StatusCode' => <integer>,
]

Result Details

Errors

ServiceException:

The Lambda service encountered an internal error.

ResourceNotFoundException:

The resource specified in the request does not exist.

InvalidRequestContentException:

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.

RequestTooLargeException:

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda quotas.

UnsupportedMediaTypeException:

The content type of the Invoke request body is not JSON.

TooManyRequestsException:

The request throughput limit was exceeded. For more information, see Lambda quotas.

InvalidParameterValueException:

One of the parameters in the request is not valid.

EC2UnexpectedException:

Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.

SubnetIPAddressLimitReachedException:

Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

ENILimitReachedException:

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.

EFSMountConnectivityException:

The Lambda function couldn't make a network connection to the configured file system.

EFSMountFailureException:

The Lambda function couldn't mount the configured file system due to a permission or configuration issue.

EFSMountTimeoutException:

The Lambda function made a network connection to the configured file system, but the mount operation timed out.

EFSIOException:

An error occurred when reading from or writing to a connected file system.

SnapStartException:

The afterRestore() runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

SnapStartTimeoutException:

Lambda couldn't restore the snapshot within the timeout limit.

SnapStartNotReadyException:

Lambda is initializing your function. You can invoke the function when the function state becomes Active.

EC2ThrottledException:

Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for the function.

EC2AccessDeniedException:

Need additional permissions to configure VPC settings.

InvalidSubnetIDException:

The subnet ID provided in the Lambda function VPC configuration is not valid.

InvalidSecurityGroupIDException:

The security group ID provided in the Lambda function VPC configuration is not valid.

InvalidZipFileException:

Lambda could not unzip the deployment package.

KMSDisabledException:

Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

KMSInvalidStateException:

Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.

KMSAccessDeniedException:

Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

KMSNotFoundException:

Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

InvalidRuntimeException:

The runtime or runtime version specified is not supported.

ResourceConflictException:

The resource already exists, or another operation is in progress.

ResourceNotReadyException:

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.

RecursiveInvocationException:

Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.

Examples

Example 1: To invoke a Lambda function

The following example invokes version 1 of a function named my-function with an empty event payload.

$result = $client->invoke([
    'FunctionName' => 'my-function',
    'Payload' => <BLOB>,
    'Qualifier' => '1',
]);

Result syntax:

[
    'Payload' => <BLOB>,
    'StatusCode' => 200,
]

Example 2: To invoke a Lambda function asynchronously

The following example invokes version 1 of a function named my-function asynchronously.

$result = $client->invoke([
    'FunctionName' => 'my-function',
    'InvocationType' => 'Event',
    'Payload' => <BLOB>,
    'Qualifier' => '1',
]);

Result syntax:

[
    'Payload' => <BLOB>,
    'StatusCode' => 202,
]

InvokeAsync

$result = $client->invokeAsync([/* ... */]);
$promise = $client->invokeAsyncAsync([/* ... */]);

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

Parameter Syntax

$result = $client->invokeAsync([
    'FunctionName' => '<string>', // REQUIRED
    'InvokeArgs' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details