AWSLambdaInvokeWithResponseStreamRequest

Objective-C

@interface AWSLambdaInvokeWithResponseStreamRequest

Swift

class AWSLambdaInvokeWithResponseStreamRequest

  • Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientContext;

    Swift

    var clientContext: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable functionName;

    Swift

    var functionName: String? { get set }

  • Use one of the following options:

    • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

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

    Declaration

    Objective-C

    @property (nonatomic) AWSLambdaResponseStreamingInvocationType invocationType;

    Swift

    var invocationType: AWSLambdaResponseStreamingInvocationType { get set }

  • Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

    Declaration

    Objective-C

    @property (nonatomic) AWSLambdaLogType logType;

    Swift

    var logType: AWSLambdaLogType { get set }

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

    You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

    Declaration

    Objective-C

    @property (nonatomic, strong) id _Nullable payload;

    Swift

    var payload: Any? { get set }

  • The alias name.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable qualifier;

    Swift

    var qualifier: String? { get set }