AWS SDK for C++  1.8.54
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:

Public Member Functions

 InvokeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFunctionName () const
 
bool FunctionNameHasBeenSet () 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
 
bool InvocationTypeHasBeenSet () const
 
void SetInvocationType (const InvocationType &value)
 
void SetInvocationType (InvocationType &&value)
 
InvokeRequestWithInvocationType (const InvocationType &value)
 
InvokeRequestWithInvocationType (InvocationType &&value)
 
const LogTypeGetLogType () const
 
bool LogTypeHasBeenSet () const
 
void SetLogType (const LogType &value)
 
void SetLogType (LogType &&value)
 
InvokeRequestWithLogType (const LogType &value)
 
InvokeRequestWithLogType (LogType &&value)
 
const Aws::StringGetClientContext () const
 
bool ClientContextHasBeenSet () 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
 
bool QualifierHasBeenSet () 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
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
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 SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file InvokeRequest.h.

Constructor & Destructor Documentation

◆ InvokeRequest()

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

Member Function Documentation

◆ AddQueryStringParameters()

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.

◆ ClientContextHasBeenSet()

bool Aws::Lambda::Model::InvokeRequest::ClientContextHasBeenSet ( ) const
inline

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 277 of file InvokeRequest.h.

◆ FunctionNameHasBeenSet()

bool Aws::Lambda::Model::InvokeRequest::FunctionNameHasBeenSet ( ) const
inline

The name 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.

Definition at line 70 of file InvokeRequest.h.

◆ GetClientContext()

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 271 of file InvokeRequest.h.

◆ GetFunctionName()

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

The name 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.

Definition at line 56 of file InvokeRequest.h.

◆ GetInvocationType()

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

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 168 of file InvokeRequest.h.

◆ GetLogType()

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

Set to Tail to include the execution log in the response.

Definition at line 239 of file InvokeRequest.h.

◆ GetQualifier()

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

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

Definition at line 319 of file InvokeRequest.h.

◆ GetRequestSpecificHeaders()

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.

◆ GetServiceRequestName()

virtual const char* Aws::Lambda::Model::InvokeRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file InvokeRequest.h.

◆ InvocationTypeHasBeenSet()

bool Aws::Lambda::Model::InvokeRequest::InvocationTypeHasBeenSet ( ) const
inline

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 181 of file InvokeRequest.h.

◆ LogTypeHasBeenSet()

bool Aws::Lambda::Model::InvokeRequest::LogTypeHasBeenSet ( ) const
inline

Set to Tail to include the execution log in the response.

Definition at line 244 of file InvokeRequest.h.

◆ QualifierHasBeenSet()

bool Aws::Lambda::Model::InvokeRequest::QualifierHasBeenSet ( ) const
inline

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

Definition at line 324 of file InvokeRequest.h.

◆ SetClientContext() [1/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 283 of file InvokeRequest.h.

◆ SetClientContext() [2/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 289 of file InvokeRequest.h.

◆ SetClientContext() [3/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 295 of file InvokeRequest.h.

◆ SetFunctionName() [1/3]

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

The name 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.

Definition at line 84 of file InvokeRequest.h.

◆ SetFunctionName() [2/3]

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

The name 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.

Definition at line 98 of file InvokeRequest.h.

◆ SetFunctionName() [3/3]

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

The name 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.

Definition at line 112 of file InvokeRequest.h.

◆ SetInvocationType() [1/2]

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

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 194 of file InvokeRequest.h.

◆ SetInvocationType() [2/2]

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

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 207 of file InvokeRequest.h.

◆ SetLogType() [1/2]

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

Set to Tail to include the execution log in the response.

Definition at line 249 of file InvokeRequest.h.

◆ SetLogType() [2/2]

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

Set to Tail to include the execution log in the response.

Definition at line 254 of file InvokeRequest.h.

◆ SetQualifier() [1/3]

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

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

Definition at line 329 of file InvokeRequest.h.

◆ SetQualifier() [2/3]

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

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

Definition at line 334 of file InvokeRequest.h.

◆ SetQualifier() [3/3]

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

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

Definition at line 339 of file InvokeRequest.h.

◆ WithClientContext() [1/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 301 of file InvokeRequest.h.

◆ WithClientContext() [2/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 307 of file InvokeRequest.h.

◆ WithClientContext() [3/3]

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

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Definition at line 313 of file InvokeRequest.h.

◆ WithFunctionName() [1/3]

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

The name 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.

Definition at line 126 of file InvokeRequest.h.

◆ WithFunctionName() [2/3]

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

The name 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.

Definition at line 140 of file InvokeRequest.h.

◆ WithFunctionName() [3/3]

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

The name 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.

Definition at line 154 of file InvokeRequest.h.

◆ WithInvocationType() [1/2]

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

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 220 of file InvokeRequest.h.

◆ WithInvocationType() [2/2]

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

Choose from the following options.

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

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

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

Definition at line 233 of file InvokeRequest.h.

◆ WithLogType() [1/2]

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

Set to Tail to include the execution log in the response.

Definition at line 259 of file InvokeRequest.h.

◆ WithLogType() [2/2]

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

Set to Tail to include the execution log in the response.

Definition at line 264 of file InvokeRequest.h.

◆ WithQualifier() [1/3]

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

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

Definition at line 344 of file InvokeRequest.h.

◆ WithQualifier() [2/3]

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

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

Definition at line 349 of file InvokeRequest.h.

◆ WithQualifier() [3/3]

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

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

Definition at line 354 of file InvokeRequest.h.


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