AWS SDK for C++  0.12.9
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lambda::Model::InvokeRequest Class Reference

#include <InvokeRequest.h>

Inheritance diagram for Aws::Lambda::Model::InvokeRequest:
Aws::AmazonStreamingWebServiceRequest Aws::AmazonWebServiceRequest

Public Member Functions

 InvokeRequest ()
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFunctionName () const
 
void SetFunctionName (const Aws::String &value)
 
void SetFunctionName (Aws::String &&value)
 
void SetFunctionName (const char *value)
 
InvokeRequestWithFunctionName (const Aws::String &value)
 
InvokeRequestWithFunctionName (Aws::String &&value)
 
InvokeRequestWithFunctionName (const char *value)
 
const InvocationTypeGetInvocationType () const
 
void SetInvocationType (const InvocationType &value)
 
void SetInvocationType (InvocationType &&value)
 
InvokeRequestWithInvocationType (const InvocationType &value)
 
InvokeRequestWithInvocationType (InvocationType &&value)
 
const LogTypeGetLogType () const
 
void SetLogType (const LogType &value)
 
void SetLogType (LogType &&value)
 
InvokeRequestWithLogType (const LogType &value)
 
InvokeRequestWithLogType (LogType &&value)
 
const Aws::StringGetClientContext () const
 
void SetClientContext (const Aws::String &value)
 
void SetClientContext (Aws::String &&value)
 
void SetClientContext (const char *value)
 
InvokeRequestWithClientContext (const Aws::String &value)
 
InvokeRequestWithClientContext (Aws::String &&value)
 
InvokeRequestWithClientContext (const char *value)
 
const Aws::StringGetQualifier () const
 
void SetQualifier (const Aws::String &value)
 
void SetQualifier (Aws::String &&value)
 
void SetQualifier (const char *value)
 
InvokeRequestWithQualifier (const Aws::String &value)
 
InvokeRequestWithQualifier (Aws::String &&value)
 
InvokeRequestWithQualifier (const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

Detailed Description

Definition at line 36 of file InvokeRequest.h.

Constructor & Destructor Documentation

Aws::Lambda::Model::InvokeRequest::InvokeRequest ( )

Member Function Documentation

void Aws::Lambda::Model::InvokeRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

const Aws::String& Aws::Lambda::Model::InvokeRequest::GetClientContext ( ) const
inline

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.

Definition at line 242 of file InvokeRequest.h.

const Aws::String& Aws::Lambda::Model::InvokeRequest::GetFunctionName ( ) const
inline

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.

Definition at line 54 of file InvokeRequest.h.

const InvocationType& Aws::Lambda::Model::InvokeRequest::GetInvocationType ( ) const
inline

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.

Definition at line 138 of file InvokeRequest.h.

const LogType& Aws::Lambda::Model::InvokeRequest::GetLogType ( ) const
inline

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-results header.

Definition at line 195 of file InvokeRequest.h.

const Aws::String& Aws::Lambda::Model::InvokeRequest::GetQualifier ( ) const
inline

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.

Definition at line 319 of file InvokeRequest.h.

Aws::Http::HeaderValueCollection Aws::Lambda::Model::InvokeRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

void Aws::Lambda::Model::InvokeRequest::SetClientContext ( const Aws::String value)
inline

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.

Definition at line 253 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetClientContext ( Aws::String &&  value)
inline

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.

Definition at line 264 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetClientContext ( const char *  value)
inline

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.

Definition at line 275 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetFunctionName ( const Aws::String value)
inline

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.

Definition at line 66 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetFunctionName ( Aws::String &&  value)
inline

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.

Definition at line 78 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetFunctionName ( const char *  value)
inline

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.

Definition at line 90 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetInvocationType ( const InvocationType value)
inline

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.

Definition at line 150 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetInvocationType ( InvocationType &&  value)
inline

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.

Definition at line 162 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetLogType ( const LogType value)
inline

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-results header.

Definition at line 204 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetLogType ( LogType &&  value)
inline

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-results header.

Definition at line 213 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetQualifier ( const Aws::String value)
inline

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.

Definition at line 330 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetQualifier ( Aws::String &&  value)
inline

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.

Definition at line 341 of file InvokeRequest.h.

void Aws::Lambda::Model::InvokeRequest::SetQualifier ( const char *  value)
inline

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.

Definition at line 352 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithClientContext ( const Aws::String value)
inline

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.

Definition at line 286 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithClientContext ( Aws::String &&  value)
inline

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.

Definition at line 297 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithClientContext ( const char *  value)
inline

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.

Definition at line 308 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithFunctionName ( const Aws::String value)
inline

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.

Definition at line 102 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithFunctionName ( Aws::String &&  value)
inline

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.

Definition at line 114 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithFunctionName ( const char *  value)
inline

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.

Definition at line 126 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithInvocationType ( const InvocationType value)
inline

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.

Definition at line 174 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithInvocationType ( InvocationType &&  value)
inline

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.

Definition at line 186 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithLogType ( const LogType value)
inline

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-results header.

Definition at line 222 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithLogType ( LogType &&  value)
inline

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-results header.

Definition at line 231 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithQualifier ( const Aws::String value)
inline

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.

Definition at line 363 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithQualifier ( Aws::String &&  value)
inline

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.

Definition at line 374 of file InvokeRequest.h.

InvokeRequest& Aws::Lambda::Model::InvokeRequest::WithQualifier ( const char *  value)
inline

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.

Definition at line 385 of file InvokeRequest.h.


The documentation for this class was generated from the following file: