You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::LambdaPreview::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash) —

    a customizable set of options



153
154
155
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 153

def initialize(*args)
  super
end

Instance Method Details

#add_event_source(params = {}) ⇒ Types::EventSourceConfiguration

Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.

This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.

Examples:

Request syntax with placeholder values


resp = client.add_event_source({
  event_source: "String", # required
  function_name: "FunctionName", # required
  role: "RoleArn", # required
  batch_size: 1,
  parameters: {
    "String" => "String",
  },
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source #=> String
resp.function_name #=> String
resp.parameters #=> Hash
resp.parameters["String"] #=> String
resp.role #=> String
resp.last_modified #=> Time
resp.is_active #=> Boolean
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_source (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

  • :function_name (required, String) —

    The Lambda function to invoke when AWS Lambda detects an event on the stream.

  • :role (required, String) —

    The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

  • :batch_size (Integer) —

    The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

  • :parameters (Hash<String,String>) —

    A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

Returns:

See Also:



259
260
261
262
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 259

def add_event_source(params = {}, options = {})
  req = build_request(:add_event_source, params)
  req.send_request(options)
end

#delete_function(params = {}) ⇒ Struct

Deletes the specified Lambda function code and configuration.

This operation requires permission for the lambda:DeleteFunction action.

Examples:

Request syntax with placeholder values


resp = client.delete_function({
  function_name: "FunctionName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



284
285
286
287
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 284

def delete_function(params = {}, options = {})
  req = build_request(:delete_function, params)
  req.send_request(options)
end

#get_event_source(params = {}) ⇒ Types::EventSourceConfiguration

Returns configuration information for the specified event source mapping (see AddEventSource).

This operation requires permission for the lambda:GetEventSource action.

Examples:

Request syntax with placeholder values


resp = client.get_event_source({
  uuid: "String", # required
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source #=> String
resp.function_name #=> String
resp.parameters #=> Hash
resp.parameters["String"] #=> String
resp.role #=> String
resp.last_modified #=> Time
resp.is_active #=> Boolean
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The AWS Lambda assigned ID of the event source mapping.

Returns:

See Also:



333
334
335
336
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 333

def get_event_source(params = {}, options = {})
  req = build_request(:get_event_source, params)
  req.send_request(options)
end

#get_function(params = {}) ⇒ Types::GetFunctionResponse

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the lambda:GetFunction action.

Examples:

Request syntax with placeholder values


resp = client.get_function({
  function_name: "FunctionName", # required
})

Response structure


resp.configuration.function_name #=> String
resp.configuration.function_arn #=> String
resp.configuration.configuration_id #=> String
resp.configuration.runtime #=> String, one of "nodejs"
resp.configuration.role #=> String
resp.configuration.handler #=> String
resp.configuration.mode #=> String, one of "event"
resp.configuration.code_size #=> Integer
resp.configuration.description #=> String
resp.configuration.timeout #=> Integer
resp.configuration.memory_size #=> Integer
resp.configuration.last_modified #=> Time
resp.code.repository_type #=> String
resp.code.location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function name.

Returns:

See Also:



382
383
384
385
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 382

def get_function(params = {}, options = {})
  req = build_request(:get_function, params)
  req.send_request(options)
end

#get_function_configuration(params = {}) ⇒ Types::FunctionConfiguration

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

Examples:

Request syntax with placeholder values


resp = client.get_function_configuration({
  function_name: "FunctionName", # required
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the Lambda function for which you want to retrieve the configuration information.

Returns:

See Also:



438
439
440
441
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 438

def get_function_configuration(params = {}, options = {})
  req = build_request(:get_function_configuration, params)
  req.send_request(options)
end

#invoke_async(params = {}) ⇒ Types::InvokeAsyncResponse

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeFunction action.

Examples:

Request syntax with placeholder values


resp = client.invoke_async({
  function_name: "FunctionName", # required
  invoke_args: "data", # required
})

Response structure


resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function name.

  • :invoke_args (required, String, IO) —

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

Returns:

See Also:



476
477
478
479
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 476

def invoke_async(params = {}, options = {})
  req = build_request(:invoke_async, params)
  req.send_request(options)
end

#list_event_sources(params = {}) ⇒ Types::ListEventSourcesResponse

Returns a list of event source mappings you created using the AddEventSource (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSources action.

Examples:

Request syntax with placeholder values


resp = client.list_event_sources({
  event_source_arn: "String",
  function_name: "FunctionName",
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.event_sources #=> Array
resp.event_sources[0].uuid #=> String
resp.event_sources[0].batch_size #=> Integer
resp.event_sources[0].event_source #=> String
resp.event_sources[0].function_name #=> String
resp.event_sources[0].parameters #=> Hash
resp.event_sources[0].parameters["String"] #=> String
resp.event_sources[0].role #=> String
resp.event_sources[0].last_modified #=> Time
resp.event_sources[0].is_active #=> Boolean
resp.event_sources[0].status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_source_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis stream.

  • :function_name (String) —

    The name of the AWS Lambda function.

  • :marker (String) —

    Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.

  • :max_items (Integer) —

    Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 539

def list_event_sources(params = {}, options = {})
  req = build_request(:list_event_sources, params)
  req.send_request(options)
end

#list_functions(params = {}) ⇒ Types::ListFunctionsResponse

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

Examples:

Request syntax with placeholder values


resp = client.list_functions({
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.functions #=> Array
resp.functions[0].function_name #=> String
resp.functions[0].function_arn #=> String
resp.functions[0].configuration_id #=> String
resp.functions[0].runtime #=> String, one of "nodejs"
resp.functions[0].role #=> String
resp.functions[0].handler #=> String
resp.functions[0].mode #=> String, one of "event"
resp.functions[0].code_size #=> Integer
resp.functions[0].description #=> String
resp.functions[0].timeout #=> Integer
resp.functions[0].memory_size #=> Integer
resp.functions[0].last_modified #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :marker (String) —

    Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

  • :max_items (Integer) —

    Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

Returns:

See Also:



593
594
595
596
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 593

def list_functions(params = {}, options = {})
  req = build_request(:list_functions, params)
  req.send_request(options)
end

#remove_event_source(params = {}) ⇒ Struct

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:RemoveEventSource action.

Examples:

Request syntax with placeholder values


resp = client.remove_event_source({
  uuid: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The event source mapping ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



619
620
621
622
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 619

def remove_event_source(params = {}, options = {})
  req = build_request(:remove_event_source, params)
  req.send_request(options)
end

#update_function_configuration(params = {}) ⇒ Types::FunctionConfiguration

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

Examples:

Request syntax with placeholder values


resp = client.update_function_configuration({
  function_name: "FunctionName", # required
  role: "RoleArn",
  handler: "Handler",
  description: "Description",
  timeout: 1,
  memory_size: 1,
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the Lambda function.

  • :role (String) —

    The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

  • :handler (String) —

    The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

  • :description (String) —

    A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

  • :timeout (Integer) —

    The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

  • :memory_size (Integer) —

    The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

See Also:



707
708
709
710
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 707

def update_function_configuration(params = {}, options = {})
  req = build_request(:update_function_configuration, params)
  req.send_request(options)
end

#upload_function(params = {}) ⇒ Types::FunctionConfiguration

Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.

This operation requires permission for the lambda:UploadFunction action.

Examples:

Request syntax with placeholder values


resp = client.upload_function({
  function_name: "FunctionName", # required
  function_zip: "data", # required
  runtime: "nodejs", # required, accepts nodejs
  role: "RoleArn", # required
  handler: "Handler", # required
  mode: "event", # required, accepts event
  description: "Description",
  timeout: 1,
  memory_size: 1,
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.

  • :function_zip (required, String, IO) —

    A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

  • :runtime (required, String) —

    The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

  • :role (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

  • :handler (required, String) —

    The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

  • :mode (required, String) —

    How the Lambda function will be invoked. Lambda supports only the "event" mode.

  • :description (String) —

    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

  • :timeout (Integer) —

    The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

  • :memory_size (Integer) —

    The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

See Also:



819
820
821
822
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/client.rb', line 819

def upload_function(params = {}, options = {})
  req = build_request(:upload_function, params)
  req.send_request(options)
end