AWSLambdaInvocationRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSLambdaModel.h


Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.

@property (nonatomic, strong) NSString *clientContext

Declared In



The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

@property (nonatomic, strong) NSString *functionName

Declared In



Choose from the following options.

  • RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

  • DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

@property (nonatomic, assign) AWSLambdaInvocationType invocationType

Declared In



You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

@property (nonatomic, assign) AWSLambdaLogType logType

Declared In



JSON that you want to provide to your Lambda function as input.

@property (nonatomic, strong) id _Nullable payload

Declared In



Specify a version or alias to invoke a published version of the function.

@property (nonatomic, strong) NSString *qualifier

Declared In