AWS Lambda 2015-03-31

AddLayerVersionPermission

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

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

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• PolicyLengthExceededException:

  The permissions policy for the resource is too large. Learn more

• PreconditionFailedException:

  The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• PolicyLengthExceededException:

  The permissions policy for the resource is too large. Learn more

• TooManyRequestsException:

  The request throughput limit was exceeded.

• PreconditionFailedException:

  The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API 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([/* ... */]);

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 AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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',
]

CreateEventSourceMapping

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

Parameter Syntax

$result = $client->createEventSourceMapping([
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'Enabled' => true || false,
    'EventSourceArn' => '<string>', // REQUIRED
    'FunctionName' => '<string>', // REQUIRED
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'ParallelizationFactor' => <integer>,
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'ParallelizationFactor' => <integer>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• ResourceConflictException:

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

• TooManyRequestsException:

  The request throughput limit was exceeded.

• 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([/* ... */]);

Parameter Syntax

$result = $client->createFunction([
    'Code' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3ObjectVersion' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Variables' => ['<string>', ...],
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>', // REQUIRED
            'LocalMountPath' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FunctionName' => '<string>', // REQUIRED
    'Handler' => '<string>', // REQUIRED
    'KMSKeyArn' => '<string>',
    'Layers' => ['<string>', ...],
    'MemorySize' => <integer>,
    'Publish' => true || false,
    'Role' => '<string>', // REQUIRED
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided', // REQUIRED
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'CodeSha256' => '<string>',
    'CodeSize' => <integer>,
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'Variables' => ['<string>', ...],
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>',
            'LocalMountPath' => '<string>',
        ],
        // ...
    ],
    'FunctionArn' => '<string>',
    'FunctionName' => '<string>',
    'Handler' => '<string>',
    'KMSKeyArn' => '<string>',
    'LastModified' => '<string>',
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided',
    'State' => 'Pending|Active|Inactive|Failed',
    'StateReason' => '<string>',
    'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

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

• CodeStorageExceededException:

  You have exceeded your maximum total code size per account. Learn more

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',
]

DeleteAlias

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• ResourceConflictException:

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

• TooManyRequestsException:

  The request throughput limit was exceeded.

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',
]);

DeleteEventSourceMapping

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'ParallelizationFactor' => <integer>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• ResourceInUseException:

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• 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',
]);

DeleteFunctionConcurrency

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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',
]);

DeleteLayerVersion

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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([/* ... */]);

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

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

• ServiceException:

  The AWS 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([/* ... */]);

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.

• ServiceException:

  The AWS 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([/* ... */]);

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 AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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',
]

GetEventSourceMapping

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BatchSize' => <integer>,
    'BisectBatchOnFunctionError' => true || false,
    'DestinationConfig' => [
        'OnFailure' => [
            'Destination' => '<string>',
        ],
        'OnSuccess' => [
            'Destination' => '<string>',
        ],
    ],
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'MaximumBatchingWindowInSeconds' => <integer>,
    'MaximumRecordAgeInSeconds' => <integer>,
    'MaximumRetryAttempts' => <integer>,
    'ParallelizationFactor' => <integer>,
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Code' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'Concurrency' => [
        'ReservedConcurrentExecutions' => <integer>,
    ],
    'Configuration' => [
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'DeadLetterConfig' => [
            'TargetArn' => '<string>',
        ],
        'Description' => '<string>',
        'Environment' => [
            'Error' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'Variables' => ['<string>', ...],
        ],
        'FileSystemConfigs' => [
            [
                'Arn' => '<string>',
                'LocalMountPath' => '<string>',
            ],
            // ...
        ],
        'FunctionArn' => '<string>',
        'FunctionName' => '<string>',
        'Handler' => '<string>',
        'KMSKeyArn' => '<string>',
        'LastModified' => '<string>',
        'LastUpdateStatus' => 'Successful|Failed|InProgress',
        'LastUpdateStatusReason' => '<string>',
        'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
        'Layers' => [
            [
                'Arn' => '<string>',
                'CodeSize' => <integer>,
            ],
            // ...
        ],
        'MasterArn' => '<string>',
        'MemorySize' => <integer>,
        'RevisionId' => '<string>',
        'Role' => '<string>',
        'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided',
        'State' => 'Pending|Active|Inactive|Failed',
        'StateReason' => '<string>',
        'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
        'Timeout' => <integer>,
        'TracingConfig' => [
            'Mode' => 'Active|PassThrough',
        ],
        'Version' => '<string>',
        'VpcConfig' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

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',
    ],
]

GetFunctionConcurrency

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

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

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• ServiceException:

  The AWS 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CodeSha256' => '<string>',
    'CodeSize' => <integer>,
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Error' => [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
        ],
        'Variables' => ['<string>', ...],
    ],
    'FileSystemConfigs' => [
        [
            'Arn' => '<string>',
            'LocalMountPath' => '<string>',
        ],
        // ...
    ],
    'FunctionArn' => '<string>',
    'FunctionName' => '<string>',
    'Handler' => '<string>',
    'KMSKeyArn' => '<string>',
    'LastModified' => '<string>',
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|dotnetcore3.1|nodejs4.3-edge|go1.x|ruby2.5|ruby2.7|provided',
    'State' => 'Pending|Active|Inactive|Failed',
    'StateReason' => '<string>',
    'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses|InvalidSubnet|InvalidSecurityGroup',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

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([/* ... */]);

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 AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

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,
]

GetLayerVersion

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

GetPolicy

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

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([/* ... */]);

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

• ResourceNotFoundException:

  The resource specified in the request does not exist.

• TooManyRequestsException:

  The request throughput limit was exceeded.

• ServiceException:

  The AWS Lambda service encountered an internal error.

• ProvisionedConcurrencyConfigNotFoundException:

  The specified configuration does not exist.

Examples

Example 1: 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',
]

Example 2: 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',
]

Invoke

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

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

• RequestTooLargeException:

  The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.

• UnsupportedMediaTypeException:

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

• TooManyRequestsException:

  The request throughput limit was exceeded.

• InvalidParameterValueException:

  One of the parameters in the request is invalid.

• EC2UnexpectedException:

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

• SubnetIPAddressLimitReachedException:

  AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

• ENILimitReachedException:

  AWS Lambda was not able to create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.

• EFSMountConnectivityException:

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

• EFSMountFailureException:

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

• EFSMountTimeoutException:

  The function was able to make a network connection to the configured file system, but the mount operation timed out.

• EFSIOException:

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

• EC2ThrottledException:

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

• EC2AccessDeniedException:

  Need additional permissions to configure VPC settings.

• InvalidSubnetIDException:

  The Subnet ID provided in the Lambda function VPC configuration is invalid.

• InvalidSecurityGroupIDException:

  The Security Group ID provided in the Lambda function VPC configuration is invalid.

• InvalidZipFileException:

  AWS Lambda could not unzip the deployment package.

• KMSDisabledException:

  Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

• KMSInvalidStateException:

  Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.

• KMSAccessDeniedException:

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

• KMSNotFoundException:

  Lambda was unable to 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.

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Status' => <integer>,
]

Result Details

Errors

• ServiceException:

  The AWS 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.

• InvalidRuntimeException:

  The runtime or runtime version specified is not supported.

• ResourceConflictException:

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

Examples

Example 1: To invoke a Lambda function asynchronously

The following example invokes a Lambda function asynchronously

$result = $client->invokeAsync([
    'FunctionName' => 'my-function',
    'InvokeArgs' => <BLOB>,
]);

Result syntax:

[
    'Status' => 202,
]

ListAliases

$result = $client->listAliases([/* ... */]);
$promise = $client->listAliasesAsync([/* ... */]);

Parameter Syntax

$result = $client->listAliases([
    'FunctionName' => '<string>', // REQUIRED
    'FunctionVersion' => '<string>',
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.

Examples

Example 1: To list a function's aliases

The following example returns a list of aliases for a function named my-function.

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

Result syntax:

[
    'Aliases' => [
        [
            'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA',
            'Description' => 'Production environment BLUE.',
            'FunctionVersion' => '2',
            'Name' => 'BLUE',
            'RevisionId' => 'a410117f-xmpl-494e-8035-7e204bb7933b',
            'RoutingConfig' => [
                'AdditionalVersionWeights' => [
                    '0' => 0.7,
                ],
            ],
        ],
        [
            'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE',
            'Description' => 'Production environment GREEN.',
            'FunctionVersion' => '1',
            'Name' => 'GREEN',
            'RevisionId' => '21d40116-xmpl-40ba-9360-3ea284da1bb5',
        ],
    ],
]

ListEventSourceMappings

$result = $client->listEventSourceMappings([/* ... */]);
$promise = $client->listEventSourceMappingsAsync([/* ... */]);

Parameter Syntax

$result = $client->listEventSourceMappings([
    'EventSourceArn' => '<string>',
    'FunctionName' => '<string>',
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EventSourceMappings' => [
        [
            'BatchSize' => <integer>,
            'BisectBatchOnFunctionError' => true || false,
            'DestinationConfig' => [
                'OnFailure' => [
                    'Destination' => '<string>',
                ],
                'OnSuccess' => [
                    'Destination' => '<string>',
                ],
            ],
            'EventSourceArn' => '<string>',
            'FunctionArn' => '<string>',
            'LastModified' => <DateTime>,
            'LastProcessingResult' => '<string>',
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'ParallelizationFactor' => <integer>,
            'State' => '<string>',
            'StateTransitionReason' => '<string>',
            'UUID' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• ServiceException:

  The AWS 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 invalid.

• TooManyRequestsException:

  The request throughput limit was exceeded.