Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually .
If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier
parameter in the request. If you don't provide the Qualifier
parameter, the > LATEST
version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
This operation requires permission for the lambda:InvokeFunction
action.
- invoke :: Text -> HashMap Text Value -> Invoke
- data Invoke
- iInvocationType :: Lens' Invoke (Maybe InvocationType)
- iLogType :: Lens' Invoke (Maybe LogType)
- iQualifier :: Lens' Invoke (Maybe Text)
- iClientContext :: Lens' Invoke (Maybe Text)
- iFunctionName :: Lens' Invoke Text
- iPayload :: Lens' Invoke (HashMap Text Value)
- invokeResponse :: Int -> InvokeResponse
- data InvokeResponse
- irsFunctionError :: Lens' InvokeResponse (Maybe Text)
- irsLogResult :: Lens' InvokeResponse (Maybe Text)
- irsPayload :: Lens' InvokeResponse (Maybe (HashMap Text Value))
- irsStatusCode :: Lens' InvokeResponse Int
Creating a Request
Creates a value of Invoke
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iInvocationType
- By default, theInvoke
API assumesRequestResponse
invocation type. You can optionally request asynchronous execution by specifyingEvent
as theInvocationType
. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifyingDryRun
as theInvocationType
. This is useful in a cross-account scenario when you want to verify access to a function without running it.iLogType
- You can set this optional parameter toTail
in the request only if you specify theInvocationType
parameter with valueRequestResponse
. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in thex-amz-log-result
header.iQualifier
- You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points. If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the> LATEST
version.iClientContext
- Using theClientContext
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 aClientContext
JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide . The ClientContext JSON must be base64-encoded.iFunctionName
- The Lambda function name. You can specify a function name (for example,Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify a partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.iPayload
- JSON that you want to provide to your Lambda function as input.
See: invoke
smart constructor.
Eq Invoke Source # | |
Data Invoke Source # | |
Show Invoke Source # | |
Generic Invoke Source # | |
Hashable Invoke Source # | |
NFData Invoke Source # | |
AWSRequest Invoke Source # | |
ToBody Invoke Source # | |
ToPath Invoke Source # | |
ToHeaders Invoke Source # | |
ToQuery Invoke Source # | |
type Rep Invoke Source # | |
type Rs Invoke Source # | |
Request Lenses
iInvocationType :: Lens' Invoke (Maybe InvocationType) Source #
By default, the Invoke
API assumes RequestResponse
invocation type. You can optionally request asynchronous execution by specifying Event
as the InvocationType
. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying DryRun
as the InvocationType
. This is useful in a cross-account scenario when you want to verify access to a function without running it.
iLogType :: Lens' Invoke (Maybe LogType) Source #
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.
iQualifier :: Lens' Invoke (Maybe Text) Source #
You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points. If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the > LATEST
version.
iClientContext :: Lens' Invoke (Maybe Text) Source #
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.
iFunctionName :: Lens' Invoke Text Source #
The Lambda function name. You can specify a function name (for example, Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
iPayload :: Lens' Invoke (HashMap Text Value) Source #
JSON that you want to provide to your Lambda function as input.
Destructuring the Response
Creates a value of InvokeResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
irsFunctionError
- Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values;Handled
orUnhandled
.Handled
errors are errors that are reported by the function while theUnhandled
errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report anHandled
error, see Programming Model .irsLogResult
- It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type isRequestResponse
and the logs were requested.irsPayload
- It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type isRequestResponse
. In the event of a function error this field contains a message describing the error. For theHandled
errors the Lambda function will report this message. ForUnhandled
errors AWS Lambda reports the message.irsStatusCode
- The HTTP status code will be in the 200 range for successful request. For theRequestResonse
invocation type this status code will be 200. For theEvent
invocation type this status code will be 202. For theDryRun
invocation type the status code will be 204.
data InvokeResponse Source #
Upon success, returns an empty response. Otherwise, throws an exception.
See: invokeResponse
smart constructor.
Response Lenses
irsFunctionError :: Lens' InvokeResponse (Maybe Text) Source #
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled
or Unhandled
. Handled
errors are errors that are reported by the function while the Unhandled
errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled
error, see Programming Model .
irsLogResult :: Lens' InvokeResponse (Maybe Text) Source #
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse
and the logs were requested.
irsPayload :: Lens' InvokeResponse (Maybe (HashMap Text Value)) Source #
It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse
. In the event of a function error this field contains a message describing the error. For the Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the message.
irsStatusCode :: Lens' InvokeResponse Int Source #
The HTTP status code will be in the 200 range for successful request. For the RequestResonse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code will be 204.