2026/10/01 - Lambda Web - 20 new api methods
Changes Lambda Web Functions GA launch. Lambda Web Functions enable customers to run web applications and API backends
Retrieves details about a web function revision, including its state and configuration.
See also: AWS API Documentation
Request Syntax
client.get_web_function_revision(
functionName='string',
revisionId='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
dict
Response Syntax
{
'functionArn': 'string',
'revisionArn': 'string',
'revisionId': 'string',
'description': 'string',
'kmsKeyArn': 'string',
'buildConfig': {
'codeConfig': {
's3Object': {
'bucket': 'string',
'key': 'string',
'versionId': 'string'
}
},
'runtimeConfig': {
'runtime': 'string'
}
},
'serviceConfig': {
'executionRoleArn': 'string',
'timeoutSeconds': 123,
'maxConcurrencyPerEnvironment': 123,
'environmentVariables': {
'string': 'string'
},
'telemetryConfig': {
'loggingConfig': {
'logGroup': 'string',
'applicationLogLevel': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'systemLogLevel': 'DEBUG'|'INFO'|'WARN'
}
}
},
'state': 'Pending'|'Active'|'Failed',
'stateReason': 'string',
'errors': [
{
'attribute': 'string',
'errorCode': 'string',
'errorMessage': 'string'
},
],
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the web function revision.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
revisionArn (string) --
The Amazon Resource Name (ARN) of the revision.
revisionId (string) --
The identifier of the revision.
description (string) --
The description of the revision.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the revision's code and environment variables.
buildConfig (dict) --
The build configuration for a web function revision, including code location and runtime settings.
codeConfig (dict) --
The code configuration specifying where the deployment artifact is stored.
s3Object (dict) --
The Amazon S3 location of the deployment artifact.
bucket (string) --
The name of the Amazon S3 bucket. Must be between 3 and 63 characters.
key (string) --
The Amazon S3 object key. Must be between 1 and 1024 characters.
versionId (string) --
The version ID of the Amazon S3 object.
runtimeConfig (dict) --
The runtime configuration for the revision.
runtime (string) --
The runtime identifier for the web function (for example, a Node.js runtime identifier).
serviceConfig (dict) --
The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.
executionRoleArn (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.
timeoutSeconds (integer) --
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.
maxConcurrencyPerEnvironment (integer) --
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.
environmentVariables (dict) --
A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.
(string) --
(string) --
telemetryConfig (dict) --
The telemetry configuration for the web function, including logging settings.
loggingConfig (dict) --
The logging configuration for the web function.
logGroup (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.
applicationLogLevel (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.
systemLogLevel (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.
state (string) --
The current state of the revision.
stateReason (string) --
The reason for the current state of the revision.
errors (list) --
A list of errors encountered during revision creation. This field is absent when the revision has no errors.
(dict) --
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.
attribute (string) --
The name of the revision attribute that the error applies to. Must be between 1 and 64 characters.
errorCode (string) --
A short, machine-readable code that identifies the error. Must be between 1 and 64 characters.
errorMessage (string) --
A human-readable message describing the error. Must be between 1 and 2048 characters.
createdAt (datetime) --
The date and time the revision was created.
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.
See also: AWS API Documentation
Request Syntax
client.create_web_function(
functionName='string',
revisionConfig={
'description': 'string',
'kmsKeyArn': 'string',
'buildConfig': {
'codeConfig': {
's3Object': {
'bucket': 'string',
'key': 'string',
'versionId': 'string'
}
},
'runtimeConfig': {
'runtime': 'string'
}
},
'serviceConfig': {
'executionRoleArn': 'string',
'timeoutSeconds': 123,
'maxConcurrencyPerEnvironment': 123,
'environmentVariables': {
'string': 'string'
},
'telemetryConfig': {
'loggingConfig': {
'logGroup': 'string',
'applicationLogLevel': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'systemLogLevel': 'DEBUG'|'INFO'|'WARN'
}
}
}
},
endpointConfig={
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
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.
dict
The configuration for the initial revision of the web function, including code and service settings.
description (string) --
A description of the revision.
kmsKeyArn (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.
buildConfig (dict) -- [REQUIRED]
The build configuration for the revision.
codeConfig (dict) -- [REQUIRED]
The code configuration specifying where the deployment artifact is stored.
s3Object (dict) -- [REQUIRED]
The Amazon S3 location of the deployment artifact.
bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket. Must be between 3 and 63 characters.
key (string) -- [REQUIRED]
The Amazon S3 object key. Must be between 1 and 1024 characters.
versionId (string) --
The version ID of the Amazon S3 object.
runtimeConfig (dict) -- [REQUIRED]
The runtime configuration for the revision.
runtime (string) -- [REQUIRED]
The runtime identifier for the web function (for example, a Node.js runtime identifier).
serviceConfig (dict) -- [REQUIRED]
The service configuration for the revision.
executionRoleArn (string) -- [REQUIRED]
The ARN of the IAM role that the web function assumes when it runs. This role provides permissions to access AWS services and resources.
timeoutSeconds (integer) --
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.
maxConcurrencyPerEnvironment (integer) --
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.
environmentVariables (dict) --
A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.
(string) --
(string) --
telemetryConfig (dict) --
The telemetry configuration for the web function, including logging settings.
loggingConfig (dict) --
The logging configuration for the web function.
logGroup (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.
applicationLogLevel (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.
systemLogLevel (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.
dict
The configuration for the initial endpoint of the web function.
endpointName (string) -- [REQUIRED]
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.
description (string) --
A description of the endpoint.
endpointType (string) -- [REQUIRED]
The type of endpoint. Determines how traffic is served and routed across Regions.
authType (string) -- [REQUIRED]
The authorization type for the endpoint.
autoDeploymentMode (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.
regions (list) --
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.
(string) --
scalingConfig (dict) --
The scaling configuration for the endpoint.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the endpoint.
rateLimit (integer) --
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.
dict
A map of tag keys and values to apply to the web function.
(string) --
(string) --
dict
Response Syntax
{
'functionName': 'string',
'functionArn': 'string',
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'revision': {
'revisionArn': 'string',
'revisionId': 'string',
'description': 'string',
'state': 'Pending'|'Active'|'Failed',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1)
},
'endpoint': {
'endpointArn': 'string',
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Contains details about the created web function.
functionName (string) --
The name of the web function.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
state (string) --
The current state of the web function.
stateReason (string) --
The reason for the current state of the web function.
createdAt (datetime) --
The date and time the web function was created.
updatedAt (datetime) --
The date and time the web function was last updated.
revision (dict) --
A summary of the initial revision created with the web function.
revisionArn (string) --
The Amazon Resource Name (ARN) of the revision.
revisionId (string) --
The identifier of the revision.
description (string) --
A description of the revision.
state (string) --
The current state of the revision.
stateReason (string) --
The reason for the current state of the revision.
createdAt (datetime) --
The date and time the revision was created.
endpoint (dict) --
A summary of the initial endpoint created with the web function.
endpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
endpointName (string) --
The name of the endpoint.
description (string) --
A description of the endpoint.
endpointType (string) --
The type of the endpoint.
domainName (string) --
The domain name of the endpoint.
authType (string) --
The authorization type for the endpoint.
autoDeploymentMode (string) --
The auto-deployment mode for the endpoint.
revisionWeights (list) --
The revision weights for the endpoint.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
regions (list) --
The list of Regions for the endpoint.
(string) --
scalingConfig (dict) --
The scaling configuration for the endpoint. This field is absent if the endpoint has no scaling configuration.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the endpoint. This field is absent if the endpoint has no throttling configuration.
rateLimit (integer) --
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.
state (string) --
The current state of the endpoint.
stateReason (string) --
The reason for the current state of the endpoint.
updateStatus (string) --
The status of the most recent update to the endpoint.
updateStatusReason (string) --
The reason for the current update status of the endpoint.
createdAt (datetime) --
The date and time the endpoint was created.
updatedAt (datetime) --
The date and time the endpoint was last updated.
tags (dict) --
A map of tag keys and values associated with the web function.
(string) --
(string) --
Lists revisions for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_web_function_revisions(
functionName='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
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.
list
A list of filters to apply to the results. The only supported filter name is state.
(dict) --
A filter to apply when listing resources.
name (string) -- [REQUIRED]
The name of the filter field.
values (list) -- [REQUIRED]
The values to match for the filter.
(string) --
integer
The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.
string
The pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'revisions': [
{
'revisionArn': 'string',
'revisionId': 'string',
'description': 'string',
'state': 'Pending'|'Active'|'Failed',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Contains the list of web function revisions.
revisions (list) --
A list of revision summaries for the web function.
(dict) --
A summary of a web function revision.
revisionArn (string) --
The Amazon Resource Name (ARN) of the revision.
revisionId (string) --
The identifier of the revision.
description (string) --
A description of the revision.
state (string) --
The current state of the revision.
stateReason (string) --
The reason for the current state of the revision.
createdAt (datetime) --
The date and time the revision was created.
nextToken (string) --
The pagination token that's included if more results are available.
Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.
See also: AWS API Documentation
Request Syntax
client.update_web_function_endpoint(
functionName='string',
endpointName='string',
description='string',
authType='ApplicationManaged'|'IamAuth',
autoDeploymentMode='LatestRevision'|'Disabled',
revisionWeights=[
{
'revisionId': 'string',
'weight': 123
},
],
scalingConfig={
'maxEnvironments': 123
},
throttleConfig={
'rateLimit': 123
}
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
string
A description of the endpoint.
string
The authorization type for the endpoint.
string
The auto-deployment mode for the endpoint.
list
A list of revision weights that determine how traffic is distributed across revisions.
(dict) --
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.
revisionId (string) -- [REQUIRED]
The identifier of the revision.
weight (integer) -- [REQUIRED]
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
dict
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.
maxEnvironments (integer) --
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.
dict
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.
rateLimit (integer) --
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.
dict
Response Syntax
{
'functionArn': 'string',
'endpointArn': 'string',
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string',
'regionalEndpoints': {
'string': {
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the updated endpoint.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
endpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
endpointName (string) --
The name of the endpoint.
description (string) --
The description of the endpoint.
endpointType (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).
domainName (string) --
The domain name assigned to the endpoint.
authType (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 (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).
revisionWeights (list) --
The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
regions (list) --
The Regions configured for the endpoint.
(string) --
scalingConfig (dict) --
The scaling configuration for a web function endpoint.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for a web function endpoint.
rateLimit (integer) --
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.
state (string) --
The current state of the endpoint.
stateReason (string) --
The reason for the current state of the endpoint.
updateStatus (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 (string) --
The reason for the endpoint's most recent update status.
regionalEndpoints (dict) --
The list of regional endpoint configurations.
(string) --
(dict) --
Represents the endpoint configuration and state in a specific Region.
domainName (string) --
The domain name of the regional endpoint.
authType (string) --
The authorization type for the regional endpoint.
revisionWeights (list) --
The revision weights for the regional endpoint.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
scalingConfig (dict) --
The scaling configuration for the regional endpoint. This field is absent if the endpoint has no scaling configuration.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the regional endpoint. This field is absent if the endpoint has no throttling configuration.
rateLimit (integer) --
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.
state (string) --
The current state of the regional endpoint.
stateReason (string) --
The reason for the current state of the regional endpoint.
updateStatus (string) --
The status of the most recent update to the regional endpoint.
updateStatusReason (string) --
The reason for the current update status of the regional endpoint.
createdAt (datetime) --
The date and time the endpoint was created.
updatedAt (datetime) --
The date and time the endpoint was last updated.
Retrieves details about a web function, including its current state and configuration.
See also: AWS API Documentation
Request Syntax
client.get_web_function(
functionName='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'functionName': 'string',
'functionArn': 'string',
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the web function.
functionName (string) --
The name of the web function.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
state (string) --
The current state of the web function.
stateReason (string) --
The reason for the current state of the web function.
createdAt (datetime) --
The date and time the web function was created.
updatedAt (datetime) --
The date and time the web function was last updated.
Deletes a web function revision. You cannot delete a revision that is currently serving traffic on an endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_web_function_revision(
functionName='string',
revisionId='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
None
Deletes a web function endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_web_function_endpoint(
functionName='string',
endpointName='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
None
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.
See also: AWS API Documentation
Request Syntax
client.create_web_function_endpoint(
functionName='string',
endpointName='string',
description='string',
endpointType='HomeRegion'|'MultiRegion'|'PerRegion',
authType='ApplicationManaged'|'IamAuth',
autoDeploymentMode='LatestRevision'|'Disabled',
revisionWeights=[
{
'revisionId': 'string',
'weight': 123
},
],
regions=[
'string',
],
scalingConfig={
'maxEnvironments': 123
},
throttleConfig={
'rateLimit': 123
}
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
string
A description of the endpoint.
string
[REQUIRED]
The type of endpoint to create. Determines how traffic is served and routed across Regions.
string
[REQUIRED]
The authorization type for the endpoint.
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.
list
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.
(dict) --
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.
revisionId (string) -- [REQUIRED]
The identifier of the revision.
weight (integer) -- [REQUIRED]
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
list
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.
(string) --
dict
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.
maxEnvironments (integer) --
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.
dict
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.
rateLimit (integer) --
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.
dict
Response Syntax
{
'functionArn': 'string',
'endpointArn': 'string',
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string',
'regionalEndpoints': {
'string': {
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the created endpoint.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
endpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
endpointName (string) --
The name of the endpoint.
description (string) --
The description of the endpoint.
endpointType (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).
domainName (string) --
The domain name assigned to the endpoint.
authType (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 (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).
revisionWeights (list) --
The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
regions (list) --
The Regions configured for the endpoint.
(string) --
scalingConfig (dict) --
The scaling configuration for a web function endpoint.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for a web function endpoint.
rateLimit (integer) --
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.
state (string) --
The current state of the endpoint.
stateReason (string) --
The reason for the current state of the endpoint.
updateStatus (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 (string) --
The reason for the endpoint's most recent update status.
regionalEndpoints (dict) --
The list of regional endpoint configurations.
(string) --
(dict) --
Represents the endpoint configuration and state in a specific Region.
domainName (string) --
The domain name of the regional endpoint.
authType (string) --
The authorization type for the regional endpoint.
revisionWeights (list) --
The revision weights for the regional endpoint.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
scalingConfig (dict) --
The scaling configuration for the regional endpoint. This field is absent if the endpoint has no scaling configuration.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the regional endpoint. This field is absent if the endpoint has no throttling configuration.
rateLimit (integer) --
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.
state (string) --
The current state of the regional endpoint.
stateReason (string) --
The reason for the current state of the regional endpoint.
updateStatus (string) --
The status of the most recent update to the regional endpoint.
updateStatusReason (string) --
The reason for the current update status of the regional endpoint.
createdAt (datetime) --
The date and time the endpoint was created.
updatedAt (datetime) --
The date and time the endpoint was last updated.
Retrieves details about a web function endpoint, including its current state, configuration, and domain name.
See also: AWS API Documentation
Request Syntax
client.get_web_function_endpoint(
functionName='string',
endpointName='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
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.
dict
Response Syntax
{
'functionArn': 'string',
'endpointArn': 'string',
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string',
'regionalEndpoints': {
'string': {
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the web function endpoint.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
endpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
endpointName (string) --
The name of the endpoint.
description (string) --
The description of the endpoint.
endpointType (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).
domainName (string) --
The domain name assigned to the endpoint.
authType (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 (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).
revisionWeights (list) --
The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
regions (list) --
The Regions configured for the endpoint.
(string) --
scalingConfig (dict) --
The scaling configuration for a web function endpoint.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for a web function endpoint.
rateLimit (integer) --
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.
state (string) --
The current state of the endpoint.
stateReason (string) --
The reason for the current state of the endpoint.
updateStatus (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 (string) --
The reason for the endpoint's most recent update status.
regionalEndpoints (dict) --
The list of regional endpoint configurations.
(string) --
(dict) --
Represents the endpoint configuration and state in a specific Region.
domainName (string) --
The domain name of the regional endpoint.
authType (string) --
The authorization type for the regional endpoint.
revisionWeights (list) --
The revision weights for the regional endpoint.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
scalingConfig (dict) --
The scaling configuration for the regional endpoint. This field is absent if the endpoint has no scaling configuration.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the regional endpoint. This field is absent if the endpoint has no throttling configuration.
rateLimit (integer) --
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.
state (string) --
The current state of the regional endpoint.
stateReason (string) --
The reason for the current state of the regional endpoint.
updateStatus (string) --
The status of the most recent update to the regional endpoint.
updateStatusReason (string) --
The reason for the current update status of the regional endpoint.
createdAt (datetime) --
The date and time the endpoint was created.
updatedAt (datetime) --
The date and time the endpoint was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.delete_web_function(
functionName='string'
)
string
[REQUIRED]
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.
None
Adds tags to a web function. If a tag key already exists, the existing value is overwritten with the new value.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resource='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
dict
[REQUIRED]
A map of tag keys and values to add to the web function.
(string) --
(string) --
None
Retrieves the resource-based policy attached to a web function.
See also: AWS API Documentation
Request Syntax
client.get_resource_policy(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
dict
Response Syntax
{
'policy': 'string',
'revisionId': 'string'
}
Response Structure
(dict) --
Contains the resource-based policy and its revision ID.
policy (string) --
The JSON-formatted resource-based policy attached to the web function.
revisionId (string) --
The revision ID of the policy.
Lists endpoints for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_web_function_endpoints(
functionName='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
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.
list
A list of filters to apply to the results. Supported filter names: authType, autoDeploymentMode, endpointType, state, and updateStatus.
(dict) --
A filter to apply when listing resources.
name (string) -- [REQUIRED]
The name of the filter field.
values (list) -- [REQUIRED]
The values to match for the filter.
(string) --
integer
The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.
string
The pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'endpoints': [
{
'endpointArn': 'string',
'endpointName': 'string',
'description': 'string',
'endpointType': 'HomeRegion'|'MultiRegion'|'PerRegion',
'domainName': 'string',
'authType': 'ApplicationManaged'|'IamAuth',
'autoDeploymentMode': 'LatestRevision'|'Disabled',
'revisionWeights': [
{
'revisionId': 'string',
'weight': 123
},
],
'regions': [
'string',
],
'scalingConfig': {
'maxEnvironments': 123
},
'throttleConfig': {
'rateLimit': 123
},
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'updateStatus': 'InProgress'|'Successful'|'Failed',
'updateStatusReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Contains the list of web function endpoints.
endpoints (list) --
A list of endpoint summaries for the web function.
(dict) --
A summary of a web function endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the endpoint.
endpointName (string) --
The name of the endpoint.
description (string) --
A description of the endpoint.
endpointType (string) --
The type of the endpoint.
domainName (string) --
The domain name of the endpoint.
authType (string) --
The authorization type for the endpoint.
autoDeploymentMode (string) --
The auto-deployment mode for the endpoint.
revisionWeights (list) --
The revision weights for the endpoint.
(dict) --
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.
revisionId (string) --
The identifier of the revision.
weight (integer) --
The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.
regions (list) --
The list of Regions for the endpoint.
(string) --
scalingConfig (dict) --
The scaling configuration for the endpoint. This field is absent if the endpoint has no scaling configuration.
maxEnvironments (integer) --
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.
throttleConfig (dict) --
The throttling configuration for the endpoint. This field is absent if the endpoint has no throttling configuration.
rateLimit (integer) --
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.
state (string) --
The current state of the endpoint.
stateReason (string) --
The reason for the current state of the endpoint.
updateStatus (string) --
The status of the most recent update to the endpoint.
updateStatusReason (string) --
The reason for the current update status of the endpoint.
createdAt (datetime) --
The date and time the endpoint was created.
updatedAt (datetime) --
The date and time the endpoint was last updated.
nextToken (string) --
The pagination token that's included if more results are available.
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.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
resourceArn='string',
policy='string',
revisionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
string
[REQUIRED]
The JSON-formatted resource-based policy to attach to the web function.
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.
dict
Response Syntax
{
'policy': 'string',
'revisionId': 'string'
}
Response Structure
(dict) --
Contains the resource-based policy and its revision ID.
policy (string) --
The JSON-formatted resource-based policy attached to the web function.
revisionId (string) --
The revision ID of the policy. Use this value in subsequent PutResourcePolicy or DeleteResourcePolicy requests to prevent conflicts.
Lists web functions in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_web_functions(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
A list of filters to apply to the results. The only supported filter name is state.
(dict) --
A filter to apply when listing resources.
name (string) -- [REQUIRED]
The name of the filter field.
values (list) -- [REQUIRED]
The values to match for the filter.
(string) --
integer
The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.
string
The pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'functions': [
{
'functionName': 'string',
'functionArn': 'string',
'state': 'Pending'|'Active'|'Failed'|'Deleting',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Contains the list of web functions.
functions (list) --
A list of web function summaries.
(dict) --
A summary of a web function.
functionName (string) --
The name of the web function.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
state (string) --
The current state of the web function.
stateReason (string) --
The reason for the current state of the web function.
createdAt (datetime) --
The date and time the web function was created.
updatedAt (datetime) --
The date and time the web function was last updated.
nextToken (string) --
The pagination token that's included if more results are available.
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.
See also: AWS API Documentation
Request Syntax
client.create_web_function_revision(
functionName='string',
description='string',
kmsKeyArn='string',
buildConfig={
'codeConfig': {
's3Object': {
'bucket': 'string',
'key': 'string',
'versionId': 'string'
}
},
'runtimeConfig': {
'runtime': 'string'
}
},
serviceConfig={
'executionRoleArn': 'string',
'timeoutSeconds': 123,
'maxConcurrencyPerEnvironment': 123,
'environmentVariables': {
'string': 'string'
},
'telemetryConfig': {
'loggingConfig': {
'logGroup': 'string',
'applicationLogLevel': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'systemLogLevel': 'DEBUG'|'INFO'|'WARN'
}
}
}
)
string
[REQUIRED]
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.
string
A description of the revision.
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.
dict
[REQUIRED]
The build configuration for the revision, including code location and runtime settings.
codeConfig (dict) -- [REQUIRED]
The code configuration specifying where the deployment artifact is stored.
s3Object (dict) -- [REQUIRED]
The Amazon S3 location of the deployment artifact.
bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket. Must be between 3 and 63 characters.
key (string) -- [REQUIRED]
The Amazon S3 object key. Must be between 1 and 1024 characters.
versionId (string) --
The version ID of the Amazon S3 object.
runtimeConfig (dict) -- [REQUIRED]
The runtime configuration for the revision.
runtime (string) -- [REQUIRED]
The runtime identifier for the web function (for example, a Node.js runtime identifier).
dict
[REQUIRED]
The service configuration for the revision, including execution role, timeout, and concurrency settings.
executionRoleArn (string) -- [REQUIRED]
The ARN of the IAM role that the web function assumes when it runs. This role provides permissions to access AWS services and resources.
timeoutSeconds (integer) --
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.
maxConcurrencyPerEnvironment (integer) --
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.
environmentVariables (dict) --
A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.
(string) --
(string) --
telemetryConfig (dict) --
The telemetry configuration for the web function, including logging settings.
loggingConfig (dict) --
The logging configuration for the web function.
logGroup (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.
applicationLogLevel (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.
systemLogLevel (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.
dict
Response Syntax
{
'functionArn': 'string',
'revisionArn': 'string',
'revisionId': 'string',
'description': 'string',
'kmsKeyArn': 'string',
'buildConfig': {
'codeConfig': {
's3Object': {
'bucket': 'string',
'key': 'string',
'versionId': 'string'
}
},
'runtimeConfig': {
'runtime': 'string'
}
},
'serviceConfig': {
'executionRoleArn': 'string',
'timeoutSeconds': 123,
'maxConcurrencyPerEnvironment': 123,
'environmentVariables': {
'string': 'string'
},
'telemetryConfig': {
'loggingConfig': {
'logGroup': 'string',
'applicationLogLevel': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
'systemLogLevel': 'DEBUG'|'INFO'|'WARN'
}
}
},
'state': 'Pending'|'Active'|'Failed',
'stateReason': 'string',
'errors': [
{
'attribute': 'string',
'errorCode': 'string',
'errorMessage': 'string'
},
],
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains details about the created revision.
functionArn (string) --
The Amazon Resource Name (ARN) of the web function.
revisionArn (string) --
The Amazon Resource Name (ARN) of the revision.
revisionId (string) --
The identifier of the revision.
description (string) --
The description of the revision.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the revision's code and environment variables.
buildConfig (dict) --
The build configuration for a web function revision, including code location and runtime settings.
codeConfig (dict) --
The code configuration specifying where the deployment artifact is stored.
s3Object (dict) --
The Amazon S3 location of the deployment artifact.
bucket (string) --
The name of the Amazon S3 bucket. Must be between 3 and 63 characters.
key (string) --
The Amazon S3 object key. Must be between 1 and 1024 characters.
versionId (string) --
The version ID of the Amazon S3 object.
runtimeConfig (dict) --
The runtime configuration for the revision.
runtime (string) --
The runtime identifier for the web function (for example, a Node.js runtime identifier).
serviceConfig (dict) --
The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.
executionRoleArn (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.
timeoutSeconds (integer) --
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.
maxConcurrencyPerEnvironment (integer) --
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.
environmentVariables (dict) --
A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.
(string) --
(string) --
telemetryConfig (dict) --
The telemetry configuration for the web function, including logging settings.
loggingConfig (dict) --
The logging configuration for the web function.
logGroup (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.
applicationLogLevel (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.
systemLogLevel (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.
state (string) --
The current state of the revision.
stateReason (string) --
The reason for the current state of the revision.
errors (list) --
A list of errors encountered during revision creation. This field is absent when the revision has no errors.
(dict) --
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.
attribute (string) --
The name of the revision attribute that the error applies to. Must be between 1 and 64 characters.
errorCode (string) --
A short, machine-readable code that identifies the error. Must be between 1 and 64 characters.
errorMessage (string) --
A human-readable message describing the error. Must be between 1 and 2048 characters.
createdAt (datetime) --
The date and time the revision was created.
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.
See also: AWS API Documentation
Request Syntax
client.get_web_account_settings()
dict
Response Syntax
{
'accountQuotas': {
'maxTotalArmVCpus': 123,
'maxTotalRateLimit': 123,
'maxRevisionsPerFunction': 123,
'maxEndpointsPerFunction': 123
},
'accountUsage': {
'functionCount': 123
}
}
Response Structure
(dict) --
Contains your AWS Lambda Web Functions account quotas and usage for the current AWS Region.
accountQuotas (dict) --
The quotas that apply to web functions in your account in the current AWS Region.
maxTotalArmVCpus (integer) --
The maximum total number of Arm vCPUs that you can allocate across all of your web functions in the current AWS Region.
maxTotalRateLimit (integer) --
The maximum number of requests per second allowed across all of your web function endpoints in your account in the current AWS Region.
maxRevisionsPerFunction (integer) --
The maximum number of revisions that a single web function can have.
maxEndpointsPerFunction (integer) --
The maximum number of endpoints that a single web function can have.
accountUsage (dict) --
The current web function usage for your account in the current AWS Region.
functionCount (integer) --
The number of web functions in your account in the current AWS Region.
Returns a list of tags applied to a web function.
See also: AWS API Documentation
Request Syntax
client.list_tags(
resource='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Contains the list of tags.
tags (dict) --
A map of tag keys and values associated with the web function.
(string) --
(string) --
Removes the resource-based policy from a web function.
See also: AWS API Documentation
Request Syntax
client.delete_resource_policy(
resourceArn='string',
revisionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
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.
None
Removes tags from a web function.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resource='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web function.
list
[REQUIRED]
A list of tag keys to remove from the web function.
(string) --
None