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.

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

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

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.

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

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

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.

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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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

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

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.