Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameters:
-
function_name
(NamespacedFunctionName)
–
The name or ARN of the Lambda function.
Name formats
-
Function name - my-function.
-
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
-
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
-
marker
(Optional[String], default:
None
)
–
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
-
max_items
(Optional[MaxFunctionEventInvokeConfigListItems], default:
None
)
–
The maximum number of configurations to return.
Raises:
Examples:
To view a list of asynchronous invocation configurations
The following example returns a list of asynchronous invocation configurations for a function named my-function.
>>> client.list_function_event_invoke_configs(function_name='my-function')
Source code in docs_src/capo_lambda/_services/_lambda.py
| def list_function_event_invoke_configs(
self,
function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName",
*,
config_overrides: Optional[LambdaClientConfig] = None,
marker: Optional["capo_lambda.types.string.String"] = None,
max_items: Optional[
"capo_lambda.types.max_function_event_invoke_config_list_items.MaxFunctionEventInvokeConfigListItems"
] = None,
) -> "capo_lambda.types.list_function_event_invoke_configs_response.ListFunctionEventInvokeConfigsResponse":
"""<p>Retrieves a list of configurations for asynchronous invocation for a function.</p> <p>To configure options for asynchronous invocation, use <a>PutFunctionEventInvokeConfig</a>.</p>
Args:
function_name: <p>The name or ARN of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> - <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> - <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> - <code>123456789012:function:my-function</code>.</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>
marker: <p>Specify the pagination token that's returned by a previous request to retrieve the next page of results.</p>
max_items: <p>The maximum number of configurations to return.</p>
Raises:
capo_lambda.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One of the parameters in the request is not valid.</p>
capo_lambda.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
capo_lambda.errors.service_exception.ServiceException: <p>The Lambda service encountered an internal error.</p>
capo_lambda.errors.too_many_requests_exception.TooManyRequestsException: <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
capo_lambda.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To view a list of asynchronous invocation configurations
The following example returns a list of asynchronous invocation configurations for a function named my-function.
>>> client.list_function_event_invoke_configs(function_name='my-function')
"""
def _handler(
req: "OperationRequest[capo_lambda.types.list_function_event_invoke_configs_request.ListFunctionEventInvokeConfigsRequest]",
) -> OperationResponse[
"capo_lambda.types.list_function_event_invoke_configs_response.ListFunctionEventInvokeConfigsResponse"
]:
import capo_lambda._operations.aws_gir_api_service.list_function_event_invoke_configs
output, http_response = (
capo_lambda._operations.aws_gir_api_service.list_function_event_invoke_configs.list_function_event_invoke_configs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListFunctionEventInvokeConfigs")
)
input_: capo_lambda.types.list_function_event_invoke_configs_request.ListFunctionEventInvokeConfigsRequest = {
"function_name": function_name
}
if marker is not None:
input_["marker"] = marker
if max_items is not None:
input_["max_items"] = max_items
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|