/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Lambda::Invoke

NAME

Paws::Lambda::Invoke - Arguments for method Invoke on Paws::Lambda

DESCRIPTION

This class represents the parameters used for calling the method Invoke on the AWS Lambda service. Use the attributes of this class as arguments to method Invoke.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Invoke.

SYNOPSIS

  my $lambda = Paws->service('Lambda');
# To invoke a Lambda function
# The following example invokes version 1 of a function named my-function with
# an empty event payload.
  my $InvocationResponse = $lambda->Invoke(
    'FunctionName' => 'my-function',
    'Payload'      => '{}',
    'Qualifier'    => 1
  );

  # Results:
  my $Payload    = $InvocationResponse->Payload;
  my $StatusCode = $InvocationResponse->StatusCode;

  # Returns a L<Paws::Lambda::InvocationResponse> object.
  # To invoke a Lambda function asynchronously
  # The following example invokes version 1 of a function named my-function
  # asynchronously.
  my $InvocationResponse = $lambda->Invoke(
    'FunctionName'   => 'my-function',
    'InvocationType' => 'Event',
    'Payload'        => '{}',
    'Qualifier'      => 1
  );

  # Results:
  my $Payload    = $InvocationResponse->Payload;
  my $StatusCode = $InvocationResponse->StatusCode;

  # Returns a L<Paws::Lambda::InvocationResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lambda/Invoke

ATTRIBUTES

ClientContext => Str

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

REQUIRED FunctionName => Str

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.

InvocationType => Str

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.

Valid values are: "Event", "RequestResponse", "DryRun"

LogType => Str

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

Valid values are: "None", "Tail"

Payload => Str

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

Qualifier => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method Invoke in Paws::Lambda

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues