#include <InvokeRequest.h>

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

[legend]

Public Member Functions

AWS_LAMBDA_API InvokeRequest ()=default

virtual const char * GetServiceRequestName () const override

AWS_LAMBDA_API void AddQueryStringParameters (Aws::Http::URI &uri) const override

AWS_LAMBDA_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

const Aws::String & GetFunctionName () const

bool FunctionNameHasBeenSet () const

template<typename FunctionNameT = Aws::String>

void SetFunctionName (FunctionNameT &&value)

template<typename FunctionNameT = Aws::String>

InvokeRequest & WithFunctionName (FunctionNameT &&value)

InvocationType GetInvocationType () const

bool InvocationTypeHasBeenSet () const

void SetInvocationType (InvocationType value)

InvokeRequest & WithInvocationType (InvocationType value)

LogType GetLogType () const

bool LogTypeHasBeenSet () const

void SetLogType (LogType value)

InvokeRequest & WithLogType (LogType value)

const Aws::String & GetClientContext () const

bool ClientContextHasBeenSet () const

template<typename ClientContextT = Aws::String>

void SetClientContext (ClientContextT &&value)

template<typename ClientContextT = Aws::String>

InvokeRequest & WithClientContext (ClientContextT &&value)

const Aws::String & GetQualifier () const

bool QualifierHasBeenSet () const

template<typename QualifierT = Aws::String>

void SetQualifier (QualifierT &&value)

template<typename QualifierT = Aws::String>

InvokeRequest & WithQualifier (QualifierT &&value)

Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest

AmazonStreamingWebServiceRequest ()

virtual ~AmazonStreamingWebServiceRequest ()

std::shared_ptr< Aws::IOStream > GetBody () const override

void SetBody (const std::shared_ptr< Aws::IOStream > &body)

Aws::Http::HeaderValueCollection GetHeaders () const override

bool IsStreaming () const override

const Aws::String & GetContentType () const

void SetContentType (const Aws::String &contentType)

Public Member Functions inherited from Aws::AmazonWebServiceRequest

AmazonWebServiceRequest ()

virtual ~AmazonWebServiceRequest ()=default

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool IsEventStreamRequest () const

virtual bool HasEventStreamResponse () const

virtual bool SignBody () const

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

virtual bool IsChunked () const

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler & GetRequestSignedHandler () const

const Aws::IOStreamFactory & GetResponseStreamFactory () const

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

virtual const RequestRetryHandler & GetRequestRetryHandler () const

virtual bool ShouldComputeContentMd5 () const

virtual bool ShouldValidateResponseChecksum () const

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

virtual Aws::String GetChecksumAlgorithmName () const

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

virtual EndpointParameters GetEndpointContextParams () const

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

virtual bool RequestChecksumRequired () const

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

Additional Inherited Members

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

Detailed Description

Definition at line 28 of file InvokeRequest.h.

Constructor & Destructor Documentation

◆ InvokeRequest()

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

default

Member Function Documentation

◆ AddQueryStringParameters()

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

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ClientContextHasBeenSet()

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

inline

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

Definition at line 101 of file InvokeRequest.h.

◆ FunctionNameHasBeenSet()

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

inline

The name or ARN 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 58 of file InvokeRequest.h.

◆ GetClientContext()

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

inline

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

Definition at line 100 of file InvokeRequest.h.

◆ GetFunctionName()

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

inline

The name or ARN 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 57 of file InvokeRequest.h.

◆ GetInvocationType()

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 one is 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 77 of file InvokeRequest.h.

◆ GetLogType()

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

inline

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

Definition at line 88 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 112 of file InvokeRequest.h.

◆ GetRequestSpecificHeaders()

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

overridevirtual

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 one is 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 78 of file InvokeRequest.h.

◆ LogTypeHasBeenSet()

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

inline

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

Definition at line 89 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 113 of file InvokeRequest.h.

◆ SetClientContext()

template<typename ClientContextT = Aws::String>

void Aws::Lambda::Model::InvokeRequest::SetClientContext ( ClientContextT && value)

inline

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

Definition at line 103 of file InvokeRequest.h.

◆ SetFunctionName()

template<typename FunctionNameT = Aws::String>

void Aws::Lambda::Model::InvokeRequest::SetFunctionName ( FunctionNameT && value)

inline

The name or ARN 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 60 of file InvokeRequest.h.

◆ SetInvocationType()

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 one is 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 79 of file InvokeRequest.h.

◆ SetLogType()

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

inline

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

Definition at line 90 of file InvokeRequest.h.

◆ SetQualifier()

template<typename QualifierT = Aws::String>

void Aws::Lambda::Model::InvokeRequest::SetQualifier ( QualifierT && value)

inline

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

Definition at line 115 of file InvokeRequest.h.

◆ WithClientContext()

template<typename ClientContextT = Aws::String>

InvokeRequest & Aws::Lambda::Model::InvokeRequest::WithClientContext ( ClientContextT && value)

inline

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

Definition at line 105 of file InvokeRequest.h.

◆ WithFunctionName()

template<typename FunctionNameT = Aws::String>

InvokeRequest & Aws::Lambda::Model::InvokeRequest::WithFunctionName ( FunctionNameT && value)

inline

The name or ARN 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 62 of file InvokeRequest.h.

◆ WithInvocationType()

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 one is 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 80 of file InvokeRequest.h.

◆ WithLogType()

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

inline

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

Definition at line 91 of file InvokeRequest.h.

◆ WithQualifier()

template<typename QualifierT = Aws::String>

InvokeRequest & Aws::Lambda::Model::InvokeRequest::WithQualifier ( QualifierT && value)

inline

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

Definition at line 117 of file InvokeRequest.h.

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

generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/InvokeRequest.h

AWS SDK for C++

AWS SDK for C++ Version 1.11.611

Public Member Functions

Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest

Public Member Functions inherited from Aws::AmazonWebServiceRequest

Additional Inherited Members

Public Types inherited from Aws::AmazonWebServiceRequest

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Detailed Description

Constructor & Destructor Documentation

◆ InvokeRequest()

Member Function Documentation

◆ AddQueryStringParameters()

◆ ClientContextHasBeenSet()

◆ FunctionNameHasBeenSet()

◆ GetClientContext()

◆ GetFunctionName()

◆ GetInvocationType()

◆ GetLogType()

◆ GetQualifier()

◆ GetRequestSpecificHeaders()

◆ GetServiceRequestName()

◆ InvocationTypeHasBeenSet()

◆ LogTypeHasBeenSet()

◆ QualifierHasBeenSet()

◆ SetClientContext()

◆ SetFunctionName()

◆ SetInvocationType()

◆ SetLogType()

◆ SetQualifier()

◆ WithClientContext()

◆ WithFunctionName()

◆ WithInvocationType()

◆ WithLogType()

◆ WithQualifier()