SDK for PHP V3

Lambda Web 2025-03-07

Client: Aws\LambdaWeb\LambdaWebClient
Service ID: lambda-web
Version: 2025-03-07

This page describes the parameters and results for the operations of the Lambda Web (2025-03-07), and shows how to use the Aws\LambdaWeb\LambdaWebClient object to call the described operations. This documentation is specific to the 2025-03-07 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateWebFunction ( array $params = [] )
Creates a web function with an initial revision and endpoint.
CreateWebFunctionEndpoint ( array $params = [] )
Creates an endpoint for a web function.
CreateWebFunctionRevision ( array $params = [] )
Creates an immutable revision for a web function.
DeleteResourcePolicy ( array $params = [] )
Removes the resource-based policy from a web function.
DeleteWebFunction ( array $params = [] )
Deletes a web function and all of its associated revisions and endpoints.
DeleteWebFunctionEndpoint ( array $params = [] )
Deletes a web function endpoint.
DeleteWebFunctionRevision ( array $params = [] )
Deletes a web function revision.
GetResourcePolicy ( array $params = [] )
Retrieves the resource-based policy attached to a web function.
GetWebAccountSettings ( array $params = [] )
Retrieves details about your AWS Lambda Web Functions account settings for the current AWS Region, including the quotas that apply to web functions and your current usage.
GetWebFunction ( array $params = [] )
Retrieves details about a web function, including its current state and configuration.
GetWebFunctionEndpoint ( array $params = [] )
Retrieves details about a web function endpoint, including its current state, configuration, and domain name.
GetWebFunctionRevision ( array $params = [] )
Retrieves details about a web function revision, including its state and configuration.
ListTags ( array $params = [] )
Returns a list of tags applied to a web function.
ListWebFunctionEndpoints ( array $params = [] )
Lists endpoints for a web function.
ListWebFunctionRevisions ( array $params = [] )
Lists revisions for a web function.
ListWebFunctions ( array $params = [] )
Lists web functions in your account.
PutResourcePolicy ( array $params = [] )
Adds or updates a resource-based policy on a web function.
TagResource ( array $params = [] )
Adds tags to a web function.
UntagResource ( array $params = [] )
Removes tags from a web function.
UpdateWebFunctionEndpoint ( array $params = [] )
Updates the configuration of a web function endpoint.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListWebFunctionEndpoints
ListWebFunctionRevisions
ListWebFunctions

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
WebFunctionActive GetWebFunction 1 300
WebFunctionDeleted GetWebFunction 1 300
WebFunctionEndpointActive GetWebFunctionEndpoint 1 300
WebFunctionEndpointDeleted GetWebFunctionEndpoint 1 300
WebFunctionEndpointUpdated GetWebFunctionEndpoint 1 300
WebFunctionRevisionActive GetWebFunctionRevision 1 300

Operations

CreateWebFunction 

$result = $client->createWebFunction([/* ... */]);
$promise = $client->createWebFunctionAsync([/* ... */]);

Creates a web function with an initial revision and endpoint. To create a web function, you provide the function name, revision configuration (code and service settings), and endpoint configuration.

To use this operation, you must have the CreateWebFunction permission on the web function. You don't need separate permissions for the initial revision or endpoint.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->createWebFunction([
    'endpointConfig' => [
        'authType' => 'ApplicationManaged|IamAuth', // REQUIRED
        'autoDeploymentMode' => 'LatestRevision|Disabled',
        'description' => '<string>',
        'endpointName' => '<string>', // REQUIRED
        'endpointType' => 'HomeRegion|MultiRegion|PerRegion', // REQUIRED
        'regions' => ['<string>', ...],
        'scalingConfig' => [
            'maxEnvironments' => <integer>,
        ],
        'throttleConfig' => [
            'rateLimit' => <integer>,
        ],
    ],
    'functionName' => '<string>', // REQUIRED
    'revisionConfig' => [
        'buildConfig' => [ // REQUIRED
            'codeConfig' => [ // REQUIRED
                's3Object' => [ // REQUIRED
                    'bucket' => '<string>', // REQUIRED
                    'key' => '<string>', // REQUIRED
                    'versionId' => '<string>',
                ],
            ],
            'runtimeConfig' => [ // REQUIRED
                'runtime' => '<string>', // REQUIRED
            ],
        ],
        'description' => '<string>',
        'kmsKeyArn' => '<string>',
        'serviceConfig' => [ // REQUIRED
            'environmentVariables' => ['<string>', ...],
            'executionRoleArn' => '<string>', // REQUIRED
            'maxConcurrencyPerEnvironment' => <integer>,
            'telemetryConfig' => [
                'loggingConfig' => [
                    'applicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
                    'logGroup' => '<string>',
                    'systemLogLevel' => 'DEBUG|INFO|WARN',
                ],
            ],
            'timeoutSeconds' => <integer>,
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
endpointConfig
Type: EndpointConfig structure

The configuration for the initial endpoint of the web function.

functionName
Required: Yes
Type: string

The name of the web function. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

revisionConfig
Type: RevisionConfig structure

The configuration for the initial revision of the web function, including code and service settings.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of tag keys and values to apply to the web function.

Result Syntax

[
    'createdAt' => <DateTime>,
    'endpoint' => [
        'authType' => 'ApplicationManaged|IamAuth',
        'autoDeploymentMode' => 'LatestRevision|Disabled',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'endpointArn' => '<string>',
        'endpointName' => '<string>',
        'endpointType' => 'HomeRegion|MultiRegion|PerRegion',
        'regions' => ['<string>', ...],
        'revisionWeights' => [
            [
                'revisionId' => '<string>',
                'weight' => <integer>,
            ],
            // ...
        ],
        'scalingConfig' => [
            'maxEnvironments' => <integer>,
        ],
        'state' => 'Pending|Active|Failed|Deleting',
        'stateReason' => '<string>',
        'throttleConfig' => [
            'rateLimit' => <integer>,
        ],
        'updateStatus' => 'InProgress|Successful|Failed',
        'updateStatusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'functionArn' => '<string>',
    'functionName' => '<string>',
    'revision' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'revisionArn' => '<string>',
        'revisionId' => '<string>',
        'state' => 'Pending|Active|Failed',
        'stateReason' => '<string>',
    ],
    'state' => 'Pending|Active|Failed|Deleting',
    'stateReason' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was created.

endpoint
Type: FunctionEndpointSummary structure

A summary of the initial endpoint created with the web function.

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

functionName
Required: Yes
Type: string

The name of the web function.

revision
Type: FunctionRevisionSummary structure

A summary of the initial revision created with the web function.

state
Required: Yes
Type: string

The current state of the web function.

stateReason
Required: Yes
Type: string

The reason for the current state of the web function.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of tag keys and values associated with the web function.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was last updated.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

CreateWebFunctionEndpoint 

$result = $client->createWebFunctionEndpoint([/* ... */]);
$promise = $client->createWebFunctionEndpointAsync([/* ... */]);

Creates an endpoint for a web function. An endpoint exposes the web function over HTTPS and routes traffic to one or more revisions.

To use this operation, you must have the CreateWebFunctionEndpoint permission on the web function, not on the endpoint being created.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->createWebFunctionEndpoint([
    'authType' => 'ApplicationManaged|IamAuth', // REQUIRED
    'autoDeploymentMode' => 'LatestRevision|Disabled',
    'description' => '<string>',
    'endpointName' => '<string>', // REQUIRED
    'endpointType' => 'HomeRegion|MultiRegion|PerRegion', // REQUIRED
    'functionName' => '<string>', // REQUIRED
    'regions' => ['<string>', ...],
    'revisionWeights' => [
        [
            'revisionId' => '<string>', // REQUIRED
            'weight' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'scalingConfig' => [
        'maxEnvironments' => <integer>,
    ],
    'throttleConfig' => [
        'rateLimit' => <integer>,
    ],
]);

Parameter Details

Members
authType
Required: Yes
Type: string

The authorization type for the endpoint.

autoDeploymentMode
Type: string

The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.

description
Type: string

A description of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint to create. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

endpointType
Required: Yes
Type: string

The type of endpoint to create. Determines how traffic is served and routed across Regions.

functionName
Required: Yes
Type: string

The name of the web function to create the endpoint for. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

regions
Type: Array of strings

The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

revisionWeights
Type: Array of RevisionWeight structures

A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for the endpoint. There is no default value. If you don't specify a scaling configuration, it is absent from the response.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for the endpoint. There is no default value. If you don't specify a throttling configuration, it is absent from the response.

Result Syntax

[
    'authType' => 'ApplicationManaged|IamAuth',
    'autoDeploymentMode' => 'LatestRevision|Disabled',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainName' => '<string>',
    'endpointArn' => '<string>',
    'endpointName' => '<string>',
    'endpointType' => 'HomeRegion|MultiRegion|PerRegion',
    'functionArn' => '<string>',
    'regionalEndpoints' => [
        '<Region>' => [
            'authType' => 'ApplicationManaged|IamAuth',
            'domainName' => '<string>',
            'revisionWeights' => [
                [
                    'revisionId' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
            'scalingConfig' => [
                'maxEnvironments' => <integer>,
            ],
            'state' => 'Pending|Active|Failed|Deleting',
            'stateReason' => '<string>',
            'throttleConfig' => [
                'rateLimit' => <integer>,
            ],
            'updateStatus' => 'InProgress|Successful|Failed',
            'updateStatusReason' => '<string>',
        ],
        // ...
    ],
    'regions' => ['<string>', ...],
    'revisionWeights' => [
        [
            'revisionId' => '<string>',
            'weight' => <integer>,
        ],
        // ...
    ],
    'scalingConfig' => [
        'maxEnvironments' => <integer>,
    ],
    'state' => 'Pending|Active|Failed|Deleting',
    'stateReason' => '<string>',
    'throttleConfig' => [
        'rateLimit' => <integer>,
    ],
    'updateStatus' => 'InProgress|Successful|Failed',
    'updateStatusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members
authType
Required: Yes
Type: string

The authorization type for a web function endpoint. Possible values: ApplicationManaged (the function handles authorization), IamAuth (Lambda authorizes requests with AWS SigV4 and IAM).

autoDeploymentMode
Required: Yes
Type: string

The auto-deployment mode for a web function endpoint. Possible values: LatestRevision (endpoint automatically serves the newest revision), Disabled (revision routing is fixed until explicitly changed).

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was created.

description
Type: string

The description of the endpoint.

domainName
Required: Yes
Type: string

The domain name assigned to the endpoint.

endpointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint.

endpointType
Required: Yes
Type: string

The type of a web function endpoint. Possible values: HomeRegion (serves from the Region where the function was created), MultiRegion (replicates across chosen Regions and routes to the nearest), PerRegion (separate endpoint per Region).

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

regionalEndpoints
Required: Yes
Type: Associative array of custom strings keys (Region) to RegionalEndpoint structures

The list of regional endpoint configurations.

regions
Required: Yes
Type: Array of strings

The Regions configured for the endpoint.

revisionWeights
Required: Yes
Type: Array of RevisionWeight structures

The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for a web function endpoint.

state
Required: Yes
Type: string

The current state of the endpoint.

stateReason
Required: Yes
Type: string

The reason for the current state of the endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for a web function endpoint.

updateStatus
Type: string

The status of the most recent update to an endpoint. Possible values: InProgress (update is in progress), Successful (update completed successfully), Failed (update failed).

updateStatusReason
Type: string

The reason for the endpoint's most recent update status.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was last updated.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

CreateWebFunctionRevision 

$result = $client->createWebFunctionRevision([/* ... */]);
$promise = $client->createWebFunctionRevisionAsync([/* ... */]);

Creates an immutable revision for a web function. A revision represents a specific version of the function code and configuration.

To use this operation, you must have the CreateWebFunctionRevision permission on the web function, not on the revision being created.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->createWebFunctionRevision([
    'buildConfig' => [ // REQUIRED
        'codeConfig' => [ // REQUIRED
            's3Object' => [ // REQUIRED
                'bucket' => '<string>', // REQUIRED
                'key' => '<string>', // REQUIRED
                'versionId' => '<string>',
            ],
        ],
        'runtimeConfig' => [ // REQUIRED
            'runtime' => '<string>', // REQUIRED
        ],
    ],
    'description' => '<string>',
    'functionName' => '<string>', // REQUIRED
    'kmsKeyArn' => '<string>',
    'serviceConfig' => [ // REQUIRED
        'environmentVariables' => ['<string>', ...],
        'executionRoleArn' => '<string>', // REQUIRED
        'maxConcurrencyPerEnvironment' => <integer>,
        'telemetryConfig' => [
            'loggingConfig' => [
                'applicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
                'logGroup' => '<string>',
                'systemLogLevel' => 'DEBUG|INFO|WARN',
            ],
        ],
        'timeoutSeconds' => <integer>,
    ],
]);

Parameter Details

Members
buildConfig
Required: Yes
Type: BuildConfig structure

The build configuration for the revision, including code location and runtime settings.

description
Type: string

A description of the revision.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

kmsKeyArn
Type: string

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used to encrypt the revision's code and environment variables.

serviceConfig
Required: Yes
Type: ServiceConfig structure

The service configuration for the revision, including execution role, timeout, and concurrency settings.

Result Syntax

[
    'buildConfig' => [
        'codeConfig' => [
            's3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'versionId' => '<string>',
            ],
        ],
        'runtimeConfig' => [
            'runtime' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'errors' => [
        [
            'attribute' => '<string>',
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'functionArn' => '<string>',
    'kmsKeyArn' => '<string>',
    'revisionArn' => '<string>',
    'revisionId' => '<string>',
    'serviceConfig' => [
        'environmentVariables' => ['<string>', ...],
        'executionRoleArn' => '<string>',
        'maxConcurrencyPerEnvironment' => <integer>,
        'telemetryConfig' => [
            'loggingConfig' => [
                'applicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
                'logGroup' => '<string>',
                'systemLogLevel' => 'DEBUG|INFO|WARN',
            ],
        ],
        'timeoutSeconds' => <integer>,
    ],
    'state' => 'Pending|Active|Failed',
    'stateReason' => '<string>',
]

Result Details

Members
buildConfig
Required: Yes
Type: BuildConfig structure

The build configuration for a web function revision, including code location and runtime settings.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the revision was created.

description
Type: string

The description of the revision.

errors
Type: Array of RevisionError structures

A list of errors encountered during revision creation. This field is absent when the revision has no errors.

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

kmsKeyArn
Type: string

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the revision's code and environment variables.

revisionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the revision.

revisionId
Required: Yes
Type: string

The identifier of the revision.

serviceConfig
Required: Yes
Type: ServiceConfig structure

The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.

state
Required: Yes
Type: string

The current state of the revision.

stateReason
Required: Yes
Type: string

The reason for the current state of the revision.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

DeleteResourcePolicy 

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Removes the resource-based policy from a web function.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'resourceArn' => '<string>', // REQUIRED
    'revisionId' => '<string>',
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

revisionId
Type: string

The revision ID of the policy. Use this to prevent deleting a policy that has been updated since you last retrieved it. If you don't specify a value, the policy is deleted regardless of its current revision.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

DeleteWebFunction 

$result = $client->deleteWebFunction([/* ... */]);
$promise = $client->deleteWebFunctionAsync([/* ... */]);

Deletes a web function and all of its associated revisions and endpoints.

To use this operation, you must have the DeleteWebFunction permission on the web function. You don't need the DeleteWebFunctionRevision or DeleteWebFunctionEndpoint permission.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

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

Parameter Details

Members
functionName
Required: Yes
Type: string

The name of the web function to delete. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

DeleteWebFunctionEndpoint 

$result = $client->deleteWebFunctionEndpoint([/* ... */]);
$promise = $client->deleteWebFunctionEndpointAsync([/* ... */]);

Deletes a web function endpoint.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->deleteWebFunctionEndpoint([
    'endpointName' => '<string>', // REQUIRED
    'functionName' => '<string>', // REQUIRED
]);

Parameter Details

Members
endpointName
Required: Yes
Type: string

The name of the endpoint to delete. You can specify the endpoint name or the endpoint ARN. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

DeleteWebFunctionRevision 

$result = $client->deleteWebFunctionRevision([/* ... */]);
$promise = $client->deleteWebFunctionRevisionAsync([/* ... */]);

Deletes a web function revision. You cannot delete a revision that is currently serving traffic on an endpoint.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->deleteWebFunctionRevision([
    'functionName' => '<string>', // REQUIRED
    'revisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

revisionId
Required: Yes
Type: string

The identifier of the revision to delete. You can specify the revision identifier or the revision ARN. The length constraint applies only to the full ARN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

GetResourcePolicy 

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves the resource-based policy attached to a web function.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

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

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

Result Syntax

[
    'policy' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
policy
Required: Yes
Type: string

The JSON-formatted resource-based policy attached to the web function.

revisionId
Required: Yes
Type: string

The revision ID of the policy.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

GetWebAccountSettings 

$result = $client->getWebAccountSettings([/* ... */]);
$promise = $client->getWebAccountSettingsAsync([/* ... */]);

Retrieves details about your AWS Lambda Web Functions account settings for the current AWS Region, including the quotas that apply to web functions and your current usage.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'accountQuotas' => [
        'maxEndpointsPerFunction' => <integer>,
        'maxRevisionsPerFunction' => <integer>,
        'maxTotalArmVCpus' => <integer>,
        'maxTotalRateLimit' => <integer>,
    ],
    'accountUsage' => [
        'functionCount' => <integer>,
    ],
]

Result Details

Members
accountQuotas
Required: Yes
Type: AccountQuotas structure

The quotas that apply to web functions in your account in the current AWS Region.

accountUsage
Required: Yes
Type: AccountUsage structure

The current web function usage for your account in the current AWS Region.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

GetWebFunction 

$result = $client->getWebFunction([/* ... */]);
$promise = $client->getWebFunctionAsync([/* ... */]);

Retrieves details about a web function, including its current state and configuration.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

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

Parameter Details

Members
functionName
Required: Yes
Type: string

The name of the web function to retrieve. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Result Syntax

[
    'createdAt' => <DateTime>,
    'functionArn' => '<string>',
    'functionName' => '<string>',
    'state' => 'Pending|Active|Failed|Deleting',
    'stateReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was created.

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

functionName
Required: Yes
Type: string

The name of the web function.

state
Required: Yes
Type: string

The current state of the web function.

stateReason
Required: Yes
Type: string

The reason for the current state of the web function.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was last updated.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

GetWebFunctionEndpoint 

$result = $client->getWebFunctionEndpoint([/* ... */]);
$promise = $client->getWebFunctionEndpointAsync([/* ... */]);

Retrieves details about a web function endpoint, including its current state, configuration, and domain name.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->getWebFunctionEndpoint([
    'endpointName' => '<string>', // REQUIRED
    'functionName' => '<string>', // REQUIRED
]);

Parameter Details

Members
endpointName
Required: Yes
Type: string

The name of the endpoint to retrieve. You can specify the endpoint name or the endpoint ARN. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Result Syntax

[
    'authType' => 'ApplicationManaged|IamAuth',
    'autoDeploymentMode' => 'LatestRevision|Disabled',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainName' => '<string>',
    'endpointArn' => '<string>',
    'endpointName' => '<string>',
    'endpointType' => 'HomeRegion|MultiRegion|PerRegion',
    'functionArn' => '<string>',
    'regionalEndpoints' => [
        '<Region>' => [
            'authType' => 'ApplicationManaged|IamAuth',
            'domainName' => '<string>',
            'revisionWeights' => [
                [
                    'revisionId' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
            'scalingConfig' => [
                'maxEnvironments' => <integer>,
            ],
            'state' => 'Pending|Active|Failed|Deleting',
            'stateReason' => '<string>',
            'throttleConfig' => [
                'rateLimit' => <integer>,
            ],
            'updateStatus' => 'InProgress|Successful|Failed',
            'updateStatusReason' => '<string>',
        ],
        // ...
    ],
    'regions' => ['<string>', ...],
    'revisionWeights' => [
        [
            'revisionId' => '<string>',
            'weight' => <integer>,
        ],
        // ...
    ],
    'scalingConfig' => [
        'maxEnvironments' => <integer>,
    ],
    'state' => 'Pending|Active|Failed|Deleting',
    'stateReason' => '<string>',
    'throttleConfig' => [
        'rateLimit' => <integer>,
    ],
    'updateStatus' => 'InProgress|Successful|Failed',
    'updateStatusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members
authType
Required: Yes
Type: string

The authorization type for a web function endpoint. Possible values: ApplicationManaged (the function handles authorization), IamAuth (Lambda authorizes requests with AWS SigV4 and IAM).

autoDeploymentMode
Required: Yes
Type: string

The auto-deployment mode for a web function endpoint. Possible values: LatestRevision (endpoint automatically serves the newest revision), Disabled (revision routing is fixed until explicitly changed).

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was created.

description
Type: string

The description of the endpoint.

domainName
Required: Yes
Type: string

The domain name assigned to the endpoint.

endpointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint.

endpointType
Required: Yes
Type: string

The type of a web function endpoint. Possible values: HomeRegion (serves from the Region where the function was created), MultiRegion (replicates across chosen Regions and routes to the nearest), PerRegion (separate endpoint per Region).

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

regionalEndpoints
Required: Yes
Type: Associative array of custom strings keys (Region) to RegionalEndpoint structures

The list of regional endpoint configurations.

regions
Required: Yes
Type: Array of strings

The Regions configured for the endpoint.

revisionWeights
Required: Yes
Type: Array of RevisionWeight structures

The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for a web function endpoint.

state
Required: Yes
Type: string

The current state of the endpoint.

stateReason
Required: Yes
Type: string

The reason for the current state of the endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for a web function endpoint.

updateStatus
Type: string

The status of the most recent update to an endpoint. Possible values: InProgress (update is in progress), Successful (update completed successfully), Failed (update failed).

updateStatusReason
Type: string

The reason for the endpoint's most recent update status.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was last updated.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

GetWebFunctionRevision 

$result = $client->getWebFunctionRevision([/* ... */]);
$promise = $client->getWebFunctionRevisionAsync([/* ... */]);

Retrieves details about a web function revision, including its state and configuration.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->getWebFunctionRevision([
    'functionName' => '<string>', // REQUIRED
    'revisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

revisionId
Required: Yes
Type: string

The identifier of the revision to retrieve. You can specify the revision identifier or the revision ARN. The length constraint applies only to the full ARN.

Result Syntax

[
    'buildConfig' => [
        'codeConfig' => [
            's3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'versionId' => '<string>',
            ],
        ],
        'runtimeConfig' => [
            'runtime' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'errors' => [
        [
            'attribute' => '<string>',
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'functionArn' => '<string>',
    'kmsKeyArn' => '<string>',
    'revisionArn' => '<string>',
    'revisionId' => '<string>',
    'serviceConfig' => [
        'environmentVariables' => ['<string>', ...],
        'executionRoleArn' => '<string>',
        'maxConcurrencyPerEnvironment' => <integer>,
        'telemetryConfig' => [
            'loggingConfig' => [
                'applicationLogLevel' => 'TRACE|DEBUG|INFO|WARN|ERROR|FATAL',
                'logGroup' => '<string>',
                'systemLogLevel' => 'DEBUG|INFO|WARN',
            ],
        ],
        'timeoutSeconds' => <integer>,
    ],
    'state' => 'Pending|Active|Failed',
    'stateReason' => '<string>',
]

Result Details

Members
buildConfig
Required: Yes
Type: BuildConfig structure

The build configuration for a web function revision, including code location and runtime settings.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the revision was created.

description
Type: string

The description of the revision.

errors
Type: Array of RevisionError structures

A list of errors encountered during revision creation. This field is absent when the revision has no errors.

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

kmsKeyArn
Type: string

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the revision's code and environment variables.

revisionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the revision.

revisionId
Required: Yes
Type: string

The identifier of the revision.

serviceConfig
Required: Yes
Type: ServiceConfig structure

The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.

state
Required: Yes
Type: string

The current state of the revision.

stateReason
Required: Yes
Type: string

The reason for the current state of the revision.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ListTags 

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns a list of tags applied to a web function.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

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

Parameter Details

Members
resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of tag keys and values associated with the web function.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ListWebFunctionEndpoints 

$result = $client->listWebFunctionEndpoints([/* ... */]);
$promise = $client->listWebFunctionEndpointsAsync([/* ... */]);

Lists endpoints for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->listWebFunctionEndpoints([
    'filters' => [
        [
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'functionName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
Type: Array of Filter structures

A list of filters to apply to the results. Supported filter names: authType, autoDeploymentMode, endpointType, state, and updateStatus.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

maxResults
Type: int

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

nextToken
Type: string

The pagination token that's returned by a previous request to retrieve the next page of results.

Result Syntax

[
    'endpoints' => [
        [
            'authType' => 'ApplicationManaged|IamAuth',
            'autoDeploymentMode' => 'LatestRevision|Disabled',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'domainName' => '<string>',
            'endpointArn' => '<string>',
            'endpointName' => '<string>',
            'endpointType' => 'HomeRegion|MultiRegion|PerRegion',
            'regions' => ['<string>', ...],
            'revisionWeights' => [
                [
                    'revisionId' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
            'scalingConfig' => [
                'maxEnvironments' => <integer>,
            ],
            'state' => 'Pending|Active|Failed|Deleting',
            'stateReason' => '<string>',
            'throttleConfig' => [
                'rateLimit' => <integer>,
            ],
            'updateStatus' => 'InProgress|Successful|Failed',
            'updateStatusReason' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
endpoints
Required: Yes
Type: Array of FunctionEndpointSummary structures

A list of endpoint summaries for the web function.

nextToken
Type: string

The pagination token that's included if more results are available.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ListWebFunctionRevisions 

$result = $client->listWebFunctionRevisions([/* ... */]);
$promise = $client->listWebFunctionRevisionsAsync([/* ... */]);

Lists revisions for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->listWebFunctionRevisions([
    'filters' => [
        [
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'functionName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
Type: Array of Filter structures

A list of filters to apply to the results. The only supported filter name is state.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

maxResults
Type: int

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

nextToken
Type: string

The pagination token that's returned by a previous request to retrieve the next page of results.

Result Syntax

[
    'nextToken' => '<string>',
    'revisions' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'revisionArn' => '<string>',
            'revisionId' => '<string>',
            'state' => 'Pending|Active|Failed',
            'stateReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The pagination token that's included if more results are available.

revisions
Required: Yes
Type: Array of FunctionRevisionSummary structures

A list of revision summaries for the web function.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ListWebFunctions 

$result = $client->listWebFunctions([/* ... */]);
$promise = $client->listWebFunctionsAsync([/* ... */]);

Lists web functions in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->listWebFunctions([
    'filters' => [
        [
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
Type: Array of Filter structures

A list of filters to apply to the results. The only supported filter name is state.

maxResults
Type: int

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

nextToken
Type: string

The pagination token that's returned by a previous request to retrieve the next page of results.

Result Syntax

[
    'functions' => [
        [
            'createdAt' => <DateTime>,
            'functionArn' => '<string>',
            'functionName' => '<string>',
            'state' => 'Pending|Active|Failed|Deleting',
            'stateReason' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
functions
Required: Yes
Type: Array of FunctionSummary structures

A list of web function summaries.

nextToken
Type: string

The pagination token that's included if more results are available.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

PutResourcePolicy 

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Adds or updates a resource-based policy on a web function. A resource-based policy grants permissions to other AWS accounts or services to perform actions on the web function.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->putResourcePolicy([
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
    'revisionId' => '<string>',
]);

Parameter Details

Members
policy
Required: Yes
Type: string

The JSON-formatted resource-based policy to attach to the web function.

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

revisionId
Type: string

The revision ID of the existing policy. Use this to prevent conflicts when updating a policy concurrently. If you don't specify a value, the update proceeds without checking the current revision.

Result Syntax

[
    'policy' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
policy
Required: Yes
Type: string

The JSON-formatted resource-based policy attached to the web function.

revisionId
Required: Yes
Type: string

The revision ID of the policy. Use this value in subsequent PutResourcePolicy or DeleteResourcePolicy requests to prevent conflicts.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a web function. If a tag key already exists, the existing value is overwritten with the new value.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->tagResource([
    'resource' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

A map of tag keys and values to add to the web function.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a web function.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->untagResource([
    'resource' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

tagKeys
Required: Yes
Type: Array of strings

A list of tag keys to remove from the web function.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

UpdateWebFunctionEndpoint 

$result = $client->updateWebFunctionEndpoint([/* ... */]);
$promise = $client->updateWebFunctionEndpointAsync([/* ... */]);

Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.

This API is experimental and for internal AWS use only. It is not yet available to external customers.

Parameter Syntax

$result = $client->updateWebFunctionEndpoint([
    'authType' => 'ApplicationManaged|IamAuth',
    'autoDeploymentMode' => 'LatestRevision|Disabled',
    'description' => '<string>',
    'endpointName' => '<string>', // REQUIRED
    'functionName' => '<string>', // REQUIRED
    'revisionWeights' => [
        [
            'revisionId' => '<string>', // REQUIRED
            'weight' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'scalingConfig' => [
        'maxEnvironments' => <integer>,
    ],
    'throttleConfig' => [
        'rateLimit' => <integer>,
    ],
]);

Parameter Details

Members
authType
Type: string

The authorization type for the endpoint.

autoDeploymentMode
Type: string

The auto-deployment mode for the endpoint.

description
Type: string

A description of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint to update. You can specify the endpoint name or the endpoint ARN. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

functionName
Required: Yes
Type: string

The name of the web function. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

revisionWeights
Type: Array of RevisionWeight structures

A list of revision weights that determine how traffic is distributed across revisions.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set maxEnvironments value, specify an empty object.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set rateLimit value, specify an empty object.

Result Syntax

[
    'authType' => 'ApplicationManaged|IamAuth',
    'autoDeploymentMode' => 'LatestRevision|Disabled',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainName' => '<string>',
    'endpointArn' => '<string>',
    'endpointName' => '<string>',
    'endpointType' => 'HomeRegion|MultiRegion|PerRegion',
    'functionArn' => '<string>',
    'regionalEndpoints' => [
        '<Region>' => [
            'authType' => 'ApplicationManaged|IamAuth',
            'domainName' => '<string>',
            'revisionWeights' => [
                [
                    'revisionId' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
            'scalingConfig' => [
                'maxEnvironments' => <integer>,
            ],
            'state' => 'Pending|Active|Failed|Deleting',
            'stateReason' => '<string>',
            'throttleConfig' => [
                'rateLimit' => <integer>,
            ],
            'updateStatus' => 'InProgress|Successful|Failed',
            'updateStatusReason' => '<string>',
        ],
        // ...
    ],
    'regions' => ['<string>', ...],
    'revisionWeights' => [
        [
            'revisionId' => '<string>',
            'weight' => <integer>,
        ],
        // ...
    ],
    'scalingConfig' => [
        'maxEnvironments' => <integer>,
    ],
    'state' => 'Pending|Active|Failed|Deleting',
    'stateReason' => '<string>',
    'throttleConfig' => [
        'rateLimit' => <integer>,
    ],
    'updateStatus' => 'InProgress|Successful|Failed',
    'updateStatusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members
authType
Required: Yes
Type: string

The authorization type for a web function endpoint. Possible values: ApplicationManaged (the function handles authorization), IamAuth (Lambda authorizes requests with AWS SigV4 and IAM).

autoDeploymentMode
Required: Yes
Type: string

The auto-deployment mode for a web function endpoint. Possible values: LatestRevision (endpoint automatically serves the newest revision), Disabled (revision routing is fixed until explicitly changed).

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was created.

description
Type: string

The description of the endpoint.

domainName
Required: Yes
Type: string

The domain name assigned to the endpoint.

endpointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint.

endpointType
Required: Yes
Type: string

The type of a web function endpoint. Possible values: HomeRegion (serves from the Region where the function was created), MultiRegion (replicates across chosen Regions and routes to the nearest), PerRegion (separate endpoint per Region).

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

regionalEndpoints
Required: Yes
Type: Associative array of custom strings keys (Region) to RegionalEndpoint structures

The list of regional endpoint configurations.

regions
Required: Yes
Type: Array of strings

The Regions configured for the endpoint.

revisionWeights
Required: Yes
Type: Array of RevisionWeight structures

The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for a web function endpoint.

state
Required: Yes
Type: string

The current state of the endpoint.

stateReason
Required: Yes
Type: string

The reason for the current state of the endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for a web function endpoint.

updateStatus
Type: string

The status of the most recent update to an endpoint. Possible values: InProgress (update is in progress), Successful (update completed successfully), Failed (update failed).

updateStatusReason
Type: string

The reason for the endpoint's most recent update status.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was last updated.

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this operation.

ConflictException:

The request conflicts with the current state of the resource. Resolve the conflict and try again.

InternalServerException:

An internal server error occurred. Try again later.

ValidationException:

The request failed validation. Check the request parameters and try again.

ResourceNotFoundException:

The specified resource was not found. Verify the resource identifier and try again.

ThrottlingException:

The request was throttled. Reduce the frequency of requests and try again.

ServiceQuotaExceededException:

A service quota was exceeded. Request a quota increase or reduce usage and try again.

Shapes

AccessDeniedException

Description

You do not have sufficient permissions to perform this operation.

Members
message
Required: Yes
Type: string

A message describing the access denied error.

AccountQuotas

Description

The quotas that apply to web functions in your account in the current AWS Region.

Members
maxEndpointsPerFunction
Required: Yes
Type: int

The maximum number of endpoints that a single web function can have.

maxRevisionsPerFunction
Required: Yes
Type: int

The maximum number of revisions that a single web function can have.

maxTotalArmVCpus
Required: Yes
Type: int

The maximum total number of Arm vCPUs that you can allocate across all of your web functions in the current AWS Region.

maxTotalRateLimit
Required: Yes
Type: int

The maximum number of requests per second allowed across all of your web function endpoints in your account in the current AWS Region.

AccountUsage

Description

Contains your current web function usage for the current AWS Region.

Members
functionCount
Required: Yes
Type: int

The number of web functions in your account in the current AWS Region.

BuildConfig

Description

The build configuration for a web function revision, including code location and runtime settings.

Members
codeConfig
Required: Yes
Type: CodeConfig structure

The code configuration specifying where the deployment artifact is stored.

runtimeConfig
Required: Yes
Type: RuntimeConfig structure

The runtime configuration for the revision.

CodeConfig

Description

The code configuration specifying the location of the deployment artifact.

Members
s3Object
Required: Yes
Type: S3Object structure

The Amazon S3 location of the deployment artifact.

ConflictException

Description

The request conflicts with the current state of the resource. Resolve the conflict and try again.

Members
message
Required: Yes
Type: string

A message describing the conflict.

resourceId
Type: string

The identifier of the resource in conflict.

resourceType
Type: string

The type of the resource in conflict.

EndpointConfig

Description

The configuration for a web function endpoint.

Members
authType
Required: Yes
Type: string

The authorization type for the endpoint.

autoDeploymentMode
Type: string

The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.

description
Type: string

A description of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

endpointType
Required: Yes
Type: string

The type of endpoint. Determines how traffic is served and routed across Regions.

regions
Type: Array of strings

The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for the endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for the endpoint.

Filter

Description

A filter to apply when listing resources.

Members
name
Required: Yes
Type: string

The name of the filter field.

values
Required: Yes
Type: Array of strings

The values to match for the filter.

FunctionEndpointSummary

Description

A summary of a web function endpoint.

Members
authType
Required: Yes
Type: string

The authorization type for the endpoint.

autoDeploymentMode
Required: Yes
Type: string

The auto-deployment mode for the endpoint.

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was created.

description
Type: string

A description of the endpoint.

domainName
Required: Yes
Type: string

The domain name of the endpoint.

endpointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the endpoint.

endpointName
Required: Yes
Type: string

The name of the endpoint.

endpointType
Required: Yes
Type: string

The type of the endpoint.

regions
Required: Yes
Type: Array of strings

The list of Regions for the endpoint.

revisionWeights
Required: Yes
Type: Array of RevisionWeight structures

The revision weights for the endpoint.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for the endpoint. This field is absent if the endpoint has no scaling configuration.

state
Required: Yes
Type: string

The current state of the endpoint.

stateReason
Required: Yes
Type: string

The reason for the current state of the endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for the endpoint. This field is absent if the endpoint has no throttling configuration.

updateStatus
Type: string

The status of the most recent update to the endpoint.

updateStatusReason
Type: string

The reason for the current update status of the endpoint.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the endpoint was last updated.

FunctionRevisionSummary

Description

A summary of a web function revision.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the revision was created.

description
Type: string

A description of the revision.

revisionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the revision.

revisionId
Required: Yes
Type: string

The identifier of the revision.

state
Required: Yes
Type: string

The current state of the revision.

stateReason
Required: Yes
Type: string

The reason for the current state of the revision.

FunctionSummary

Description

A summary of a web function.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was created.

functionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the web function.

functionName
Required: Yes
Type: string

The name of the web function.

state
Required: Yes
Type: string

The current state of the web function.

stateReason
Required: Yes
Type: string

The reason for the current state of the web function.

updatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the web function was last updated.

InternalServerException

Description

An internal server error occurred. Try again later.

Members
message
Type: string

A message describing the internal error.

LoggingConfig

Description

The logging configuration for a web function revision.

Members
applicationLogLevel
Type: string

The log level for application logs emitted by the web function. If you don't specify a value, the default is INFO, and this default is returned in the response.

logGroup
Type: string

The name of the Amazon CloudWatch Logs log group the web function sends logs to. If you don't specify a value, the default is /aws/lambda/web/{functionName}, and this default is returned in the response.

systemLogLevel
Type: string

The log level for system logs emitted by the Lambda runtime. If you don't specify a value, the default is INFO, and this default is returned in the response.

RegionalEndpoint

Description

Represents the endpoint configuration and state in a specific Region.

Members
authType
Required: Yes
Type: string

The authorization type for the regional endpoint.

domainName
Type: string

The domain name of the regional endpoint.

revisionWeights
Required: Yes
Type: Array of RevisionWeight structures

The revision weights for the regional endpoint.

scalingConfig
Type: ScalingConfig structure

The scaling configuration for the regional endpoint. This field is absent if the endpoint has no scaling configuration.

state
Required: Yes
Type: string

The current state of the regional endpoint.

stateReason
Required: Yes
Type: string

The reason for the current state of the regional endpoint.

throttleConfig
Type: ThrottleConfig structure

The throttling configuration for the regional endpoint. This field is absent if the endpoint has no throttling configuration.

updateStatus
Type: string

The status of the most recent update to the regional endpoint.

updateStatusReason
Type: string

The reason for the current update status of the regional endpoint.

ResourceNotFoundException

Description

The specified resource was not found. Verify the resource identifier and try again.

Members
message
Required: Yes
Type: string

A message describing the resource not found error.

resourceId
Type: string

The identifier of the resource that was not found.

resourceType
Type: string

The type of the resource that was not found.

RevisionConfig

Description

The configuration for a web function revision, including code build settings and service configuration.

Members
buildConfig
Required: Yes
Type: BuildConfig structure

The build configuration for the revision.

description
Type: string

A description of the revision.

kmsKeyArn
Type: string

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used to encrypt the revision's code and environment variables.

serviceConfig
Required: Yes
Type: ServiceConfig structure

The service configuration for the revision.

RevisionError

Description

A single error encountered while creating or reading a web function revision. The error describes the affected attribute, an error code, and a human-readable message. This structure is present only when the revision has errors.

Members
attribute
Required: Yes
Type: string

The name of the revision attribute that the error applies to. Must be between 1 and 64 characters.

errorCode
Required: Yes
Type: string

A short, machine-readable code that identifies the error. Must be between 1 and 64 characters.

errorMessage
Required: Yes
Type: string

A human-readable message describing the error. Must be between 1 and 2048 characters.

RevisionWeight

Description

Specifies a revision and its traffic weight for an endpoint. Up to two revisions can be assigned weights to split traffic for canary or blue-green deployments.

Members
revisionId
Required: Yes
Type: string

The identifier of the revision.

weight
Required: Yes
Type: int

The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.

RuntimeConfig

Description

The runtime configuration for a web function revision.

Members
runtime
Required: Yes
Type: string

The runtime identifier for the web function (for example, a Node.js runtime identifier).

S3Object

Description

The Amazon S3 location of a deployment artifact.

Members
bucket
Required: Yes
Type: string

The name of the Amazon S3 bucket. Must be between 3 and 63 characters.

key
Required: Yes
Type: string

The Amazon S3 object key. Must be between 1 and 1024 characters.

versionId
Type: string

The version ID of the Amazon S3 object.

ScalingConfig

Description

The scaling configuration for a web function endpoint.

Members
maxEnvironments
Type: int

The maximum number of concurrent execution environments for the endpoint. Minimum value of 2, maximum value of 10000. There is no default value. If you don't specify a value, the scaling configuration is absent from the response. On an update, omit scalingConfig to keep the current value, or specify an empty object to clear a previously set value.

ServiceConfig

Description

The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.

Members
environmentVariables
Type: Associative array of custom strings keys (EnvironmentVariablesKeyString) to strings

A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.

executionRoleArn
Required: Yes
Type: string

The ARN of the IAM role that the web function assumes when it runs. This role provides permissions to access AWS services and resources.

maxConcurrencyPerEnvironment
Type: int

The maximum number of concurrent requests handled per execution environment. Minimum value of 1, maximum value of 128. If you don't specify a value, the default is 64, and this default is returned in the response.

telemetryConfig
Type: TelemetryConfig structure

The telemetry configuration for the web function, including logging settings.

timeoutSeconds
Type: int

The amount of time (in seconds) that Lambda allows the web function to run before stopping it. Minimum value of 3, maximum value of 900. If you don't specify a value, the default is 30, and this default is returned in the response.

ServiceQuotaExceededException

Description

A service quota was exceeded. Request a quota increase or reduce usage and try again.

Members
message
Required: Yes
Type: string

A message describing the quota that was exceeded.

quotaCode
Type: string

The quota code of the exceeded quota.

resourceId
Type: string

The identifier of the resource that exceeded the quota.

resourceType
Type: string

The type of resource that exceeded the quota.

serviceCode
Type: string

The service code of the service that owns the quota.

TelemetryConfig

Description

The telemetry configuration for a web function revision.

Members
loggingConfig
Type: LoggingConfig structure

The logging configuration for the web function.

ThrottleConfig

Description

The throttling configuration for a web function endpoint.

Members
rateLimit
Type: int

The maximum request rate per second for the endpoint. The value must be one of the following supported values: 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, or 10000. The maximum effective value is also bounded by your account-level maximum total rate limit. There is no default value. If you don't specify a value, the throttling configuration is absent from the response. On an update, omit throttleConfig to keep the current value, or specify an empty object to clear a previously set value.

ThrottlingException

Description

The request was throttled. Reduce the frequency of requests and try again.

Members
message
Required: Yes
Type: string

A message describing the throttling error.

quotaCode
Type: string

The quota code that was exceeded, if applicable.

retryAfterSeconds
Type: int

The number of seconds to wait before retrying the request.

serviceCode
Type: string

The service code of the throttled service.

ValidationException

Description

The request failed validation. Check the request parameters and try again.

Members
message
Required: Yes
Type: string

A message describing the validation error.