Skip to content

UpdateWebFunctionEndpointRequest

Source code in docs_src/capo_lambda_web/types/update_web_function_endpoint_request.py
class UpdateWebFunctionEndpointRequest(TypedDict, closed=True):
    function_name: "capo_lambda_web.types.function_name.FunctionName"
    """<p>The web function.</p> <p>You can specify either of the following:</p> <ul> <li> <p>The function name, for example <code>my-function</code>.</p> </li> <li> <p>The function ARN.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>"""
    endpoint_name: "capo_lambda_web.types.endpoint_name.EndpointName"
    """<p>The endpoint to update.</p> <p>You can specify either of the following:</p> <ul> <li> <p>The endpoint name, for example <code>my-endpoint</code>.</p> </li> <li> <p>The endpoint ARN.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.</p>"""
    description: NotRequired["capo_lambda_web.types.description.Description"]
    """<p>A description of the endpoint. Omit this field to keep the current description.</p>"""
    auth_type: NotRequired["capo_lambda_web.types.auth_type.AuthType"]
    """<p>The authorization type for the endpoint. Omit this field to keep the current authorization type.</p> <p>Valid values:</p> <ul> <li> <p> <code>ApplicationManaged</code> – Your application handles authorization.</p> </li> <li> <p> <code>IamAuth</code> – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).</p> </li> </ul>"""
    auto_deployment_mode: NotRequired[
        "capo_lambda_web.types.auto_deployment_mode.AutoDeploymentMode"
    ]
    """<p>The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.</p> <p>Valid values:</p> <ul> <li> <p> <code>LatestRevision</code> – The endpoint automatically serves the newest revision.</p> </li> <li> <p> <code>Disabled</code> – Revision routing stays fixed until you change it.</p> </li> </ul>"""
    revision_weights: NotRequired[
        "capo_lambda_web.types.revision_weight_list.RevisionWeightList"
    ]
    """<p>A list of revision weights that determine how traffic is distributed across revisions.</p>"""
    scaling_config: NotRequired["capo_lambda_web.types.scaling_config.ScalingConfig"]
    """<p>The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set <code>maxEnvironments</code> value, specify an empty object.</p>"""
    throttle_config: NotRequired["capo_lambda_web.types.throttle_config.ThrottleConfig"]
    """<p>The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set <code>rateLimit</code> value, specify an empty object.</p>"""

auth_type instance-attribute

auth_type: NotRequired[AuthType]

The authorization type for the endpoint. Omit this field to keep the current authorization type.

Valid values:

  • ApplicationManaged – Your application handles authorization.

  • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

auto_deployment_mode instance-attribute

auto_deployment_mode: NotRequired[AutoDeploymentMode]

The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

Valid values:

  • LatestRevision – The endpoint automatically serves the newest revision.

  • Disabled – Revision routing stays fixed until you change it.

description instance-attribute

description: NotRequired[Description]

A description of the endpoint. Omit this field to keep the current description.

endpoint_name instance-attribute

endpoint_name: EndpointName

The endpoint to update.

You can specify either of the following:

  • The endpoint name, for example my-endpoint.

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

function_name instance-attribute

function_name: FunctionName

The web function.

You can specify either of the following:

  • The function name, for example my-function.

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

revision_weights instance-attribute

revision_weights: NotRequired[RevisionWeightList]

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

scaling_config instance-attribute

scaling_config: NotRequired[ScalingConfig]

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.

throttle_config instance-attribute

throttle_config: NotRequired[ThrottleConfig]

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.