Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameters:
-
function_name
(NamespacedFunctionName)
–
The name or ARN of the Lambda function, version, or alias.
Name formats
-
Function name - my-function (name-only), my-function:v1 (with alias).
-
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
-
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
-
qualifier
(Optional[NumericLatestPublishedOrAliasQualifier], default:
None
)
–
A version number or alias name.
Raises:
Examples:
To get an asynchronous invocation configuration
The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.
>>> client.get_function_event_invoke_config(function_name='my-function', qualifier='BLUE')
Source code in docs_src/capo_lambda/_services/_lambda.py
| def get_function_event_invoke_config(
self,
function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName",
*,
config_overrides: Optional[LambdaClientConfig] = None,
qualifier: Optional[
"capo_lambda.types.numeric_latest_published_or_alias_qualifier.NumericLatestPublishedOrAliasQualifier"
] = None,
) -> "capo_lambda.types.function_event_invoke_config.FunctionEventInvokeConfig":
"""<p>Retrieves the configuration for asynchronous invocation for a function, version, or alias.</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, version, or alias.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> - <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias).</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>You can append a version number or alias to any of the formats. 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>
qualifier: <p>A version number or alias name.</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 get an asynchronous invocation configuration
The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.
>>> client.get_function_event_invoke_config(function_name='my-function', qualifier='BLUE')
"""
def _handler(
req: "OperationRequest[capo_lambda.types.get_function_event_invoke_config_request.GetFunctionEventInvokeConfigRequest]",
) -> OperationResponse[
"capo_lambda.types.function_event_invoke_config.FunctionEventInvokeConfig"
]:
import capo_lambda._operations.aws_gir_api_service.get_function_event_invoke_config
output, http_response = (
capo_lambda._operations.aws_gir_api_service.get_function_event_invoke_config.get_function_event_invoke_config(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetFunctionEventInvokeConfig")
)
input_: capo_lambda.types.get_function_event_invoke_config_request.GetFunctionEventInvokeConfigRequest = {
"function_name": function_name
}
if qualifier is not None:
input_["qualifier"] = qualifier
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|