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 */).
- 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.
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
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.
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.
InternalServerException
Description
An internal server error occurred. Try again later.
Members
- message
-
- Type: string
A message describing the internal error.
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.