get_web_function_endpoint ¶

get_web_function_endpoint(
    function_name: FunctionName,
    endpoint_name: EndpointName,
    *,
    config_overrides: Optional[LambdaWebClientConfig] = None,
) -> GetWebFunctionEndpointResponse

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

Parameters:

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.
endpoint_name (EndpointName) –
The endpoint to retrieve.

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.

Raises:

AccessDeniedException –

You don't have permission to perform this operation. Check the IAM policies for your identity and any resource-based policy on the web function.
InternalServerException –

The request failed because of an internal error in the service. Retry the request. If the error persists, open a support case.
ResourceNotFoundException –

The specified web function, revision, endpoint, or resource-based policy doesn't exist. Verify the resource identifier and try again.
ThrottlingException –

The request was denied because it exceeded the request rate that Lambda allows for your account. Reduce the frequency of requests and retry with exponential backoff.
ValidationException –

The request failed validation because a parameter was missing, malformed, or outside the allowed range. Check the request parameters and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lambda_web/_services/lambda_web.py

def get_web_function_endpoint(
    self,
    function_name: "capo_lambda_web.types.function_name.FunctionName",
    endpoint_name: "capo_lambda_web.types.endpoint_name.EndpointName",
    *,
    config_overrides: Optional[LambdaWebClientConfig] = None,
) -> "capo_lambda_web.types.get_web_function_endpoint_response.GetWebFunctionEndpointResponse":
    """<p>Retrieves details about a web function endpoint, including its current state, configuration, and domain name.</p>

    Args:
        function_name: <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: <p>The endpoint to retrieve.</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>

    Raises:
        capo_lambda_web.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform this operation. Check the IAM policies for your identity and any resource-based policy on the web function.</p>
        capo_lambda_web.errors.internal_server_exception.InternalServerException: <p>The request failed because of an internal error in the service. Retry the request. If the error persists, open a support case.</p>
        capo_lambda_web.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified web function, revision, endpoint, or resource-based policy doesn't exist. Verify the resource identifier and try again.</p>
        capo_lambda_web.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the request rate that Lambda allows for your account. Reduce the frequency of requests and retry with exponential backoff.</p>
        capo_lambda_web.errors.validation_exception.ValidationException: <p>The request failed validation because a parameter was missing, malformed, or outside the allowed range. Check the request parameters and try again.</p>
        capo_lambda_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lambda_web.types.get_web_function_endpoint_request.GetWebFunctionEndpointRequest]",
    ) -> OperationResponse[
        "capo_lambda_web.types.get_web_function_endpoint_response.GetWebFunctionEndpointResponse"
    ]:
        import capo_lambda_web._operations.lambda_web.get_web_function_endpoint

        output, http_response = (
            capo_lambda_web._operations.lambda_web.get_web_function_endpoint.get_web_function_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWebFunctionEndpoint")
    )
    input_: capo_lambda_web.types.get_web_function_endpoint_request.GetWebFunctionEndpointRequest = {
        "function_name": function_name,
        "endpoint_name": endpoint_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output