getFunctionEventInvokeConfig method

Future<FunctionEventInvokeConfig> getFunctionEventInvokeConfig({ required String functionName, String? qualifier, })

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw ServiceException. May throw TooManyRequestsException.

Parameter functionName : 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.

Parameter qualifier : A version number or alias name.

Implementation

Future<FunctionEventInvokeConfig> getFunctionEventInvokeConfig({
  required String functionName,
  String? qualifier,
}) async {
  final $query = <String, List<String>>{
    if (qualifier != null) 'Qualifier': [qualifier],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/2019-09-25/functions/${Uri.encodeComponent(functionName)}/event-invoke-config',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return FunctionEventInvokeConfig.fromJson(response);
}