Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListWebFunctionEndpoints

Lists endpoints for a web function. Use pagination to ensure that the operation returns quickly and successfully.

Request Syntax


POST /2025-03-07/web-functions/functionName/list-endpoints HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

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.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

A list of filters to apply to the results. Supported filter names: authType, autoDeploymentMode, endpointType, state, and updateStatus. If you don't specify a filter, the operation returns all endpoints for the web function.

Type: Array of Filter objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

maxResults

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

The pagination token that's returned by a previous request to retrieve the next page of results.

Type: String

Pattern: [a-f0-9-]{36}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endpoints": [ 
      { 
         "authType": "string",
         "autoDeploymentMode": "string",
         "createdAt": "string",
         "description": "string",
         "domainName": "string",
         "endpointArn": "string",
         "endpointName": "string",
         "endpointType": "string",
         "regions": [ "string" ],
         "revisionWeights": [ 
            { 
               "revisionId": "string",
               "weight": number
            }
         ],
         "scalingConfig": { 
            "maxEnvironments": number
         },
         "state": "string",
         "stateReason": "string",
         "throttleConfig": { 
            "rateLimit": number
         },
         "updatedAt": "string",
         "updateStatus": "string",
         "updateStatusReason": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

endpoints

A list of endpoint summaries for the web function.

Type: Array of FunctionEndpointSummary objects

nextToken

The pagination token that's included if more results are available. Use this value as the nextToken request parameter in a subsequent call to retrieve the next page of results.

Type: String

Pattern: [a-f0-9-]{36}

Errors

For information about the errors that are common to all actions, see Common Error Types.

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.

message: A message describing the access denied error.

HTTP Status Code: 403

InternalServerException

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

message: A message describing the internal error.

HTTP Status Code: 500

ResourceNotFoundException

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

message: A message describing the resource not found error.
resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

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.

message: A message describing the throttling error.
quotaCode: The quota code that was exceeded, if applicable.
retryAfterSeconds: The number of seconds to wait before retrying the request.
serviceCode: The service code of the throttled service.

HTTP Status Code: 429

ValidationException

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

message: A message describing the validation error.

HTTP Status Code: 400