Class: Aws::Lambda::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-lambda/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash) —

    a customizable set of options



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

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3177
3178
3179
 
# File 'lib/aws-sdk-lambda/client.rb', line 3177

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3180
3181
3182
 
# File 'lib/aws-sdk-lambda/client.rb', line 3180

def errors_module
  Errors
end

Instance Method Details

#add_permission(params = {}) ⇒ Types::AddPermissionResponse

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.

For information about the push model, see [Lambda Functions].

If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the ‘AddPermission` request via the `Qualifier` parameter. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:AddPermission` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html [2]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: add-permission


# This example adds a permission for an S3 bucket to invoke a Lambda function.

resp = client.add_permission({
  action: "lambda:InvokeFunction", 
  function_name: "MyFunction", 
  principal: "s3.amazonaws.com", 
  source_account: "123456789012", 
  source_arn: "arn:aws:s3:::examplebucket/*", 
  statement_id: "ID-1", 
})

resp.to_h outputs the following:
{
  statement: "ID-1", 
}

Request syntax with placeholder values


resp = client.add_permission({
  function_name: "FunctionName", # required
  statement_id: "StatementId", # required
  action: "Action", # required
  principal: "Principal", # required
  source_arn: "Arn",
  source_account: "SourceOwner",
  event_source_token: "EventSourceToken",
  qualifier: "Qualifier",
  revision_id: "String",
})

Response structure


resp.statement #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Name of the Lambda function whose resource policy you are updating by adding a new permission.

    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 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 characters in length.

  • :statement_id (required, String) —

    A unique statement identifier.

  • :action (required, String) —

    The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with ‘lambda:` followed by the API name . For example, `lambda:CreateFunction`. You can use wildcard (`lambda:*`) to grant permission for all AWS Lambda actions.

  • :principal (required, String) —

    The principal who is getting this permission. It can be Amazon S3 service Principal (‘s3.amazonaws.com`) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as `sns.amazonaws.com`. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

  • :source_arn (String) —

    This is optional; however, when granting permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function.

    If you add a permission without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function.

  • :source_account (String) —

    This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the ‘SourceArn` identifies a bucket, then this is the bucket owner’s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don’t specify the ‘SourceArn`) owned by a specific account.

  • :event_source_token (String) —

    A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.

  • :qualifier (String) —

    You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:

    ‘arn:aws:lambda:aws-region:acct-id:function:function-name:2`

    If you specify an alias name, for example ‘PROD`, then the permission is valid only for requests made using the alias ARN:

    ‘arn:aws:lambda:aws-region:acct-id:function:function-name:PROD`

    If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.

    ‘arn:aws:lambda:aws-region:acct-id:function:function-name`

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

See Also:



307
308
309
310
 
# File 'lib/aws-sdk-lambda/client.rb', line 307

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'lib/aws-sdk-lambda/client.rb', line 3155

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-lambda'
  context[:gem_version] = '1.8.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_alias(params = {}) ⇒ Types::AliasConfiguration

Creates an alias that points to the specified Lambda function version. For more information, see [Introduction to AWS Lambda Aliases].

Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.

[1]: docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html

Examples:

Request syntax with placeholder values


resp = client.create_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
  function_version: "Version", # required
  description: "Description",
  routing_config: {
    additional_version_weights: {
      "AdditionalVersion" => 1.0,
    },
  },
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Name of the Lambda function for which you want to create an alias. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :name (required, String) —

    Name for the alias you are creating.

  • :function_version (required, String) —

    Lambda function version for which you are creating the alias.

  • :description (String) —

    Description of the alias.

  • :routing_config (Types::AliasRoutingConfiguration) —

    Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.

Returns:

See Also:



379
380
381
382
 
# File 'lib/aws-sdk-lambda/client.rb', line 379

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

#create_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

Identifies a poll-based event source for a Lambda function. It can be either an Amazon Kinesis or DynamoDB stream, or an Amazon SQS queue. AWS Lambda invokes the specified function when records are posted to the event source.

This association between a poll-based source and a Lambda function is called the event source mapping.

You provide mapping information (for example, which stream or SQS queue to read from and which Lambda function to invoke) in the request body.

Amazon Kinesis or DynamoDB stream event sources can be associated with multiple AWS Lambda functions and a given Lambda function can be associated with multiple AWS event sources. For Amazon SQS, you can configure multiple queues as event sources for a single Lambda function, but an SQS queue can be mapped only to a single Lambda function.

If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:CreateEventSourceMapping` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Request syntax with placeholder values


resp = client.create_event_source_mapping({
  event_source_arn: "Arn", # required
  function_name: "FunctionName", # required
  enabled: false,
  batch_size: 1,
  starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP
  starting_position_timestamp: Time.now,
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source_arn #=> String
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



519
520
521
522
 
# File 'lib/aws-sdk-lambda/client.rb', line 519

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

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

Creates a new Lambda 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 operation will fail. Note that the function name is case-sensitive.

If you are using versioning, you can also publish a version of the Lambda function you are creating using the ‘Publish` parameter. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:CreateFunction` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: create-function


# This example creates a Lambda function.

resp = client.create_function({
  code: {
  }, 
  description: "", 
  function_name: "MyFunction", 
  handler: "souce_file.handler_name", # is of the form of the name of your source file and then name of your function handler
  memory_size: 128, 
  publish: true, 
  role: "arn:aws:iam::123456789012:role/service-role/role-name", # replace with the actual arn of the execution role you created
  runtime: "nodejs4.3", 
  timeout: 15, 
  vpc_config: {
  }, 
})

resp.to_h outputs the following:
{
  code_sha_256: "", 
  code_size: 123, 
  description: "", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyFunction", 
  function_name: "MyFunction", 
  handler: "source_file.handler_name", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/service-role/role-name", 
  runtime: "nodejs4.3", 
  timeout: 123, 
  version: "1", 
  vpc_config: {
  }, 
}

Request syntax with placeholder values


resp = client.create_function({
  function_name: "FunctionName", # required
  runtime: "nodejs", # required, accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, java8, python2.7, python3.6, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, nodejs4.3-edge, go1.x
  role: "RoleArn", # required
  handler: "Handler", # required
  code: { # required
    zip_file: "data",
    s3_bucket: "S3Bucket",
    s3_key: "S3Key",
    s3_object_version: "S3ObjectVersion",
  },
  description: "Description",
  timeout: 1,
  memory_size: 1,
  publish: false,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String

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 API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :runtime (required, String) —

    The runtime environment for the Lambda function you are uploading.

    To use the Python runtime v3.6, set the value to “python3.6”. To use the Python runtime v2.7, set the value to “python2.7”. To use the Node.js runtime v6.10, set the value to “nodejs6.10”. To use the Node.js runtime v4.3, set the value to “nodejs4.3”. To use the .NET Core runtime v1.0, set the value to “dotnetcore1.0”. To use the .NET Core runtime v2.0, set the value to “dotnetcore2.0”.

    <note markdown=“1”> Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

    </note>
  • :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. For more information, see [AWS Lambda: How it Works].

    [1]: docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html

  • :handler (required, String) —

    The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be ‘package.class-name::handler` or `package.class-name`. For more information, see [Lambda Function Handler (Java)].

    [1]: docs.aws.amazon.com/lambda/latest/dg/java-programming-model-handler-types.html

  • :code (required, Types::FunctionCode) —

    The code for the Lambda 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 and memory 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.

  • :publish (Boolean) —

    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.

  • :vpc_config (Types::VpcConfig) —

    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

  • :dead_letter_config (Types::DeadLetterConfig) —

    The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

  • :environment (Types::Environment) —

    The parent object that contains your environment’s configuration settings.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the KMS key used to encrypt your function’s environment variables. If not provided, AWS Lambda will use a default service key.

  • :tracing_config (Types::TracingConfig) —

    The parent object that contains your function’s tracing settings.

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

    The list of tags (key-value pairs) assigned to the new function. For more information, see [Tagging Lambda Functions] in the **AWS Lambda Developer Guide**.

    [1]: docs.aws.amazon.com/lambda/latest/dg/tagging.html

Returns:

See Also:



778
779
780
781
 
# File 'lib/aws-sdk-lambda/client.rb', line 778

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

#delete_alias(params = {}) ⇒ Struct

Deletes the specified Lambda function alias. For more information, see [Introduction to AWS Lambda Aliases].

This requires permission for the lambda:DeleteAlias action.

[1]: docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html

Examples:

Example: To delete a Lambda function alias


# This operation deletes a Lambda function alias

resp = client.delete_alias({
  function_name: "myFunction", 
  name: "alias", 
})

Request syntax with placeholder values


resp = client.delete_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :name (required, String) —

    Name of the alias to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



825
826
827
828
 
# File 'lib/aws-sdk-lambda/client.rb', line 825

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

#delete_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

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:DeleteEventSourceMapping` action.

Examples:

Example: To delete a Lambda function event source mapping


# This operation deletes a Lambda function event source mapping

resp = client.delete_event_source_mapping({
  uuid: "12345kxodurf3443", 
})

resp.to_h outputs the following:
{
  batch_size: 123, 
  event_source_arn: "arn:aws:s3:::examplebucket/*", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  last_processing_result: "", 
  state: "", 
  state_transition_reason: "", 
  uuid: "12345kxodurf3443", 
}

Request syntax with placeholder values


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

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source_arn #=> String
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The event source mapping ID.

Returns:

See Also:



892
893
894
895
 
# File 'lib/aws-sdk-lambda/client.rb', line 892

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

#delete_function(params = {}) ⇒ Struct

Deletes the specified Lambda function code and configuration.

If you are using the versioning feature and you don’t specify a function version in your ‘DeleteFunction` request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the `Qualifier` parameter. For information about function versioning, see [AWS Lambda Function Versioning and Aliases].

When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the ‘lambda:DeleteFunction` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To delete a Lambda function


# This operation deletes a Lambda function

resp = client.delete_function({
  function_name: "myFunction", 
  qualifier: "1", 
})

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function to delete.

    You can specify the 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`). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (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 characters in length.

  • :qualifier (String) —

    Using this optional parameter you can specify a function version (but not the ‘$LATEST` version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the `$LATEST`, that is, you cannot specify `$LATEST` as the value of this parameter. The `$LATEST` version can be deleted only when you want to delete all the function versions and aliases.

    You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias.

    If you don’t specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



969
970
971
972
 
# File 'lib/aws-sdk-lambda/client.rb', line 969

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

#delete_function_concurrency(params = {}) ⇒ Struct

Removes concurrent execution limits from this function. For more information, see concurrent-executions.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the function you are removing concurrent execution limits from. For more information, see concurrent-executions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



993
994
995
996
 
# File 'lib/aws-sdk-lambda/client.rb', line 993

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

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse

Returns a customer’s account settings.

You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see [AWS Lambda Limits]. You can also retrieve resource usage statistics, such as code storage usage and function count.

[1]: docs.aws.amazon.com/lambda/latest/dg/limits.html

Examples:

Example: To retrieves a Lambda customer’s account settings


# This operation retrieves a Lambda customer's account settings

resp = client.({
})

resp.to_h outputs the following:
{
  account_limit: {
  }, 
  account_usage: {
  }, 
}

Response structure


resp..total_code_size #=> Integer
resp..code_size_unzipped #=> Integer
resp..code_size_zipped #=> Integer
resp..concurrent_executions #=> Integer
resp..unreserved_concurrent_executions #=> Integer
resp..total_code_size #=> Integer
resp..function_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



1044
1045
1046
1047
 
# File 'lib/aws-sdk-lambda/client.rb', line 1044

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

#get_alias(params = {}) ⇒ Types::AliasConfiguration

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see [Introduction to AWS Lambda Aliases].

This requires permission for the ‘lambda:GetAlias` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html

Examples:

Example: To retrieve a Lambda function alias


# This operation retrieves a Lambda function alias

resp = client.get_alias({
  function_name: "myFunction", 
  name: "myFunctionAlias", 
})

resp.to_h outputs the following:
{
  alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias", 
  description: "", 
  function_version: "1", 
  name: "myFunctionAlias", 
}

Request syntax with placeholder values


resp = client.get_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :name (required, String) —

    Name of the alias for which you want to retrieve information.

Returns:

See Also:



1117
1118
1119
1120
 
# File 'lib/aws-sdk-lambda/client.rb', line 1117

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

#get_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

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

This operation requires permission for the ‘lambda:GetEventSourceMapping` action.

Examples:

Example: To retrieve a Lambda function’s event source mapping


# This operation retrieves a Lambda function's event source mapping

resp = client.get_event_source_mapping({
  uuid: "123489-xxxxx-kdla8d89d7", 
})

resp.to_h outputs the following:
{
  batch_size: 123, 
  event_source_arn: "arn:aws:iam::123456789012:eventsource", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  last_processing_result: "", 
  state: "", 
  state_transition_reason: "", 
  uuid: "123489-xxxxx-kdla8d89d7", 
}

Request syntax with placeholder values


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

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source_arn #=> String
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> 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:



1184
1185
1186
1187
 
# File 'lib/aws-sdk-lambda/client.rb', line 1184

def get_event_source_mapping(params = {}, options = {})
  req = build_request(:get_event_source_mapping, 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 CreateFunction 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.

Using the optional ‘Qualifier` parameter, you can specify a specific function version for which you want this information. If you don’t specify this parameter, the API uses unqualified function ARN which return information about the ‘$LATEST` version of the Lambda function. For more information, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:GetFunction` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To retrieve a Lambda function’s event source mapping


# This operation retrieves a Lambda function's event source mapping

resp = client.get_function({
  function_name: "myFunction", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  code: {
    location: "somelocation", 
    repository_type: "S3", 
  }, 
  configuration: {
    code_sha_256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
    code_size: 262, 
    description: "A starter AWS Lambda function.", 
    environment: {
      variables: {
        "S3_BUCKET" => "test", 
      }, 
    }, 
    function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    function_name: "myFunction", 
    handler: "index.handler", 
    last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
    memory_size: 128, 
    role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
    runtime: "nodejs4.3", 
    timeout: 3, 
    version: "$LATEST", 
    vpc_config: {
      security_group_ids: [
      ], 
      subnet_ids: [
      ], 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_function({
  function_name: "NamespacedFunctionName", # required
  qualifier: "Qualifier",
})

Response structure


resp.configuration.function_name #=> String
resp.configuration.function_arn #=> String
resp.configuration.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.configuration.role #=> String
resp.configuration.handler #=> String
resp.configuration.code_size #=> Integer
resp.configuration.description #=> String
resp.configuration.timeout #=> Integer
resp.configuration.memory_size #=> Integer
resp.configuration.last_modified #=> Time
resp.configuration.code_sha_256 #=> String
resp.configuration.version #=> String
resp.configuration.vpc_config.subnet_ids #=> Array
resp.configuration.vpc_config.subnet_ids[0] #=> String
resp.configuration.vpc_config.security_group_ids #=> Array
resp.configuration.vpc_config.security_group_ids[0] #=> String
resp.configuration.vpc_config.vpc_id #=> String
resp.configuration.dead_letter_config.target_arn #=> String
resp.configuration.environment.variables #=> Hash
resp.configuration.environment.variables["EnvironmentVariableName"] #=> String
resp.configuration.environment.error.error_code #=> String
resp.configuration.environment.error.message #=> String
resp.configuration.kms_key_arn #=> String
resp.configuration.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.configuration.master_arn #=> String
resp.configuration.revision_id #=> String
resp.code.repository_type #=> String
resp.code.location #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.concurrency.reserved_concurrent_executions #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    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 characters in length.

  • :qualifier (String) —

    Use this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don’t provide this parameter, the API uses unqualified function ARN and returns information about the ‘$LATEST` version of the Lambda function.

Returns:

See Also:



1325
1326
1327
1328
 
# File 'lib/aws-sdk-lambda/client.rb', line 1325

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 CreateFunction.

If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional ‘Qualifier` parameter and specifying the function version or alias that points to it. If you don’t provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:GetFunctionConfiguration` operation.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To retrieve a Lambda function’s event source mapping


# This operation retrieves a Lambda function's event source mapping

resp = client.get_function_configuration({
  function_name: "myFunction", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  code_sha_256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
  code_size: 123, 
  dead_letter_config: {
  }, 
  description: "", 
  environment: {
  }, 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  function_name: "myFunction", 
  handler: "index.handler", 
  kms_key_arn: "", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  runtime: "python2.7", 
  timeout: 123, 
  version: "1", 
  vpc_config: {
  }, 
}

Request syntax with placeholder values


resp = client.get_function_configuration({
  function_name: "NamespacedFunctionName", # required
  qualifier: "Qualifier",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String

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.

    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 characters in length.

  • :qualifier (String) —

    Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.

    If you don’t specify this parameter, the API uses unqualified function ARN, and returns information about the ‘$LATEST` function version.

Returns:

See Also:



1468
1469
1470
1471
 
# File 'lib/aws-sdk-lambda/client.rb', line 1468

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

#get_policy(params = {}) ⇒ Types::GetPolicyResponse

Returns the resource policy associated with the specified Lambda function.

If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the ‘Qualifier` parameter. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

You need permission for the ‘lambda:GetPolicy action.`

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To retrieve a Lambda function policy


# This operation retrieves a Lambda function policy

resp = client.get_policy({
  function_name: "myFunction", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  policy: "", 
}

Request syntax with placeholder values


resp = client.get_policy({
  function_name: "NamespacedFunctionName", # required
  qualifier: "Qualifier",
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Function name whose resource policy you want to retrieve.

    You can specify the 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`). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (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 characters in length.

  • :qualifier (String) —

    You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don’t provide this parameter, the API will return permissions that apply to the unqualified function ARN.

Returns:

See Also:



1544
1545
1546
1547
 
# File 'lib/aws-sdk-lambda/client.rb', line 1544

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

#invoke(params = {}) ⇒ Types::InvocationResponse

Invokes a specific Lambda function. For an example, see [Create the Lambda Function and Test It Manually].

If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the ‘Qualifier` parameter in the request. If you don’t provide the ‘Qualifier` parameter, the `$LATEST` version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:InvokeFunction` action.

<note markdown=“1”> The ‘TooManyRequestsException` noted below will return the following: `ConcurrentInvocationLimitExceeded` will be returned if you have no functions with reserved concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds the account’s unreserved concurrency limit. ‘ReservedFunctionConcurrentInvocationLimitExceeded` will be returned when a function with reserved concurrency exceeds its configured concurrency limit.

</note>

[1]: docs.aws.amazon.com/lambda/latest/dg/with-dynamodb-create-function.html#with-dbb-invoke-manually [2]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To invoke a Lambda function


# This operation invokes a Lambda function

resp = client.invoke({
  client_context: "MyApp", 
  function_name: "MyFunction", 
  invocation_type: "Event", 
  log_type: "Tail", 
  payload: "fileb://file-path/input.json", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  function_error: "", 
  log_result: "", 
  payload: "?", 
  status_code: 123, 
}

Request syntax with placeholder values


resp = client.invoke({
  function_name: "NamespacedFunctionName", # required
  invocation_type: "Event", # accepts Event, RequestResponse, DryRun
  log_type: "None", # accepts None, Tail
  client_context: "String",
  payload: "data",
  qualifier: "Qualifier",
})

Response structure


resp.status_code #=> Integer
resp.function_error #=> String
resp.log_result #=> String
resp.payload #=> String
resp.executed_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    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 characters in length.

  • :invocation_type (String) —

    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.

  • :log_type (String) —

    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-result` header.

  • :client_context (String) —

    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 and has a maximum size of 3583 bytes.

    [1]: docs.aws.amazon.com/mobileanalytics/latest/ug/PutEvents.html

  • :payload (String, IO) —

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

  • :qualifier (String) —

    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.

Returns:

See Also:



1689
1690
1691
1692
 
# File 'lib/aws-sdk-lambda/client.rb', line 1689

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

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

This API is deprecated. We recommend you use ‘Invoke` API (see Invoke).

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:

Example: To invoke a Lambda function asynchronously


# This operation invokes a Lambda function asynchronously

resp = client.invoke_async({
  function_name: "myFunction", 
  invoke_args: "fileb://file-path/input.json", 
})

resp.to_h outputs the following:
{
  status: 123, 
}

Request syntax with placeholder values


resp = client.invoke_async({
  function_name: "NamespacedFunctionName", # 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. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :invoke_args (required, String, IO) —

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

Returns:

See Also:



1747
1748
1749
1750
 
# File 'lib/aws-sdk-lambda/client.rb', line 1747

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

#list_aliases(params = {}) ⇒ Types::ListAliasesResponse

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see [Introduction to AWS Lambda Aliases].

This requires permission for the lambda:ListAliases action.

[1]: docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html

Examples:

Example: To retrieve a Lambda function aliases


# This operation retrieves a Lambda function's aliases

resp = client.list_aliases({
  function_name: "myFunction", 
  function_version: "1", 
  marker: "", 
  max_items: 123, 
})

resp.to_h outputs the following:
{
  aliases: [
  ], 
  next_marker: "", 
}

Request syntax with placeholder values


resp = client.list_aliases({
  function_name: "FunctionName", # required
  function_version: "Version",
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.aliases #=> Array
resp.aliases[0].alias_arn #=> String
resp.aliases[0].name #=> String
resp.aliases[0].function_version #=> String
resp.aliases[0].description #=> String
resp.aliases[0].routing_config.additional_version_weights #=> Hash
resp.aliases[0].routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.aliases[0].revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Lambda function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :function_version (String) —

    If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.

  • :marker (String) —

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

  • :max_items (Integer) —

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

Returns:

See Also:



1832
1833
1834
1835
 
# File 'lib/aws-sdk-lambda/client.rb', line 1832

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

#list_event_source_mappings(params = {}) ⇒ Types::ListEventSourceMappingsResponse

Returns a list of event source mappings you created using the ‘CreateEventSourceMapping` (see CreateEventSourceMapping).

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

If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the ‘FunctionName` parameter. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:ListEventSourceMappings` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_marker #=> String
resp.event_source_mappings #=> Array
resp.event_source_mappings[0].uuid #=> String
resp.event_source_mappings[0].batch_size #=> Integer
resp.event_source_mappings[0].event_source_arn #=> String
resp.event_source_mappings[0].function_arn #=> String
resp.event_source_mappings[0].last_modified #=> Time
resp.event_source_mappings[0].last_processing_result #=> String
resp.event_source_mappings[0].state #=> String
resp.event_source_mappings[0].state_transition_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_source_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream, or an SQS queue. (This parameter is optional.)

  • :function_name (String) —

    The name of the Lambda function.

    You can specify the 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`). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (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 characters in length.

  • :marker (String) —

    Optional string. An opaque pagination token returned from a previous ‘ListEventSourceMappings` 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:



1913
1914
1915
1916
 
# File 'lib/aws-sdk-lambda/client.rb', line 1913

def list_event_source_mappings(params = {}, options = {})
  req = build_request(:list_event_source_mappings, 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.

If you are using the versioning feature, you can list all of your functions or only ‘$LATEST` versions. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To retrieve a list of Lambda functions


# This operation retrieves a Lambda functions

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

resp.to_h outputs the following:
{
  functions: [
  ], 
  next_marker: "", 
}

Request syntax with placeholder values


resp = client.list_functions({
  master_region: "MasterRegion",
  function_version: "ALL", # accepts ALL
  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].runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.functions[0].role #=> String
resp.functions[0].handler #=> String
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
resp.functions[0].code_sha_256 #=> String
resp.functions[0].version #=> String
resp.functions[0].vpc_config.subnet_ids #=> Array
resp.functions[0].vpc_config.subnet_ids[0] #=> String
resp.functions[0].vpc_config.security_group_ids #=> Array
resp.functions[0].vpc_config.security_group_ids[0] #=> String
resp.functions[0].vpc_config.vpc_id #=> String
resp.functions[0].dead_letter_config.target_arn #=> String
resp.functions[0].environment.variables #=> Hash
resp.functions[0].environment.variables["EnvironmentVariableName"] #=> String
resp.functions[0].environment.error.error_code #=> String
resp.functions[0].environment.error.message #=> String
resp.functions[0].kms_key_arn #=> String
resp.functions[0].tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.functions[0].master_arn #=> String
resp.functions[0].revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :master_region (String) —

    Optional string. If not specified, will return only regular function versions (i.e., non-replicated versions).

    Valid values are:

    The region from which the functions are replicated. For example, if you specify ‘us-east-1`, only functions replicated from that region will be returned.

    ‘ALL`: Will return all functions from any region. If specified, you also must specify a valid FunctionVersion parameter.

  • :function_version (String) —

    Optional string. If not specified, only the unqualified functions ARNs (Amazon Resource Names) will be returned.

    Valid value:

    ‘ALL`: Will return all versions, including `$LATEST` which will have fully qualified ARNs (Amazon Resource Names).

  • :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:



2031
2032
2033
2034
 
# File 'lib/aws-sdk-lambda/client.rb', line 2031

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

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see [Tagging Lambda Functions] in the **AWS Lambda Developer Guide**.

[1]: docs.aws.amazon.com/lambda/latest/dg/tagging.html

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource: "FunctionArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2073
2074
2075
2076
 
# File 'lib/aws-sdk-lambda/client.rb', line 2073

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

#list_versions_by_function(params = {}) ⇒ Types::ListVersionsByFunctionResponse

List all versions of a function. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To retrieve a list of Lambda function versions


# This operation retrieves a Lambda function versions

resp = client.list_versions_by_function({
  function_name: "myFunction", 
  marker: "", 
  max_items: 123, 
})

resp.to_h outputs the following:
{
  next_marker: "", 
  versions: [
  ], 
}

Request syntax with placeholder values


resp = client.list_versions_by_function({
  function_name: "NamespacedFunctionName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.versions #=> Array
resp.versions[0].function_name #=> String
resp.versions[0].function_arn #=> String
resp.versions[0].runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.versions[0].role #=> String
resp.versions[0].handler #=> String
resp.versions[0].code_size #=> Integer
resp.versions[0].description #=> String
resp.versions[0].timeout #=> Integer
resp.versions[0].memory_size #=> Integer
resp.versions[0].last_modified #=> Time
resp.versions[0].code_sha_256 #=> String
resp.versions[0].version #=> String
resp.versions[0].vpc_config.subnet_ids #=> Array
resp.versions[0].vpc_config.subnet_ids[0] #=> String
resp.versions[0].vpc_config.security_group_ids #=> Array
resp.versions[0].vpc_config.security_group_ids[0] #=> String
resp.versions[0].vpc_config.vpc_id #=> String
resp.versions[0].dead_letter_config.target_arn #=> String
resp.versions[0].environment.variables #=> Hash
resp.versions[0].environment.variables["EnvironmentVariableName"] #=> String
resp.versions[0].environment.error.error_code #=> String
resp.versions[0].environment.error.message #=> String
resp.versions[0].kms_key_arn #=> String
resp.versions[0].tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.versions[0].master_arn #=> String
resp.versions[0].revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Function name whose versions to list. 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 characters in length.

  • :marker (String) —

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

  • :max_items (Integer) —

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

Returns:

See Also:



2171
2172
2173
2174
 
# File 'lib/aws-sdk-lambda/client.rb', line 2171

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

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

Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To publish a version of a Lambda function


# This operation publishes a version of a Lambda function

resp = client.publish_version({
  code_sha_256: "", 
  description: "", 
  function_name: "myFunction", 
})

resp.to_h outputs the following:
{
  code_sha_256: "", 
  code_size: 123, 
  description: "", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  function_name: "myFunction", 
  handler: "index.handler", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  runtime: "python2.7", 
  timeout: 123, 
  version: "1", 
  vpc_config: {
  }, 
}

Request syntax with placeholder values


resp = client.publish_version({
  function_name: "FunctionName", # required
  code_sha_256: "String",
  description: "Description",
  revision_id: "String",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    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 characters in length.

  • :code_sha_256 (String) —

    The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.

  • :description (String) —

    The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

See Also:



2309
2310
2311
2312
 
# File 'lib/aws-sdk-lambda/client.rb', line 2309

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

#put_function_concurrency(params = {}) ⇒ Types::Concurrency

Sets a limit on the number of concurrent executions available to this function. It is a subset of your account’s total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see concurrent-executions.

Examples:

Request syntax with placeholder values


resp = client.put_function_concurrency({
  function_name: "FunctionName", # required
  reserved_concurrent_executions: 1, # required
})

Response structure


resp.reserved_concurrent_executions #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the function you are setting concurrent execution limits on. For more information, see concurrent-executions.

  • :reserved_concurrent_executions (required, Integer) —

    The concurrent execution limit reserved for this function. For more information, see concurrent-executions.

Returns:

See Also:



2349
2350
2351
2352
 
# File 'lib/aws-sdk-lambda/client.rb', line 2349

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

#remove_permission(params = {}) ⇒ Struct

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.

If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the ‘AddPermission` request via the `Qualifier` parameter. For more information about versioning, see [AWS Lambda Function Versioning and Aliases].

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the ‘lambda:RemovePermission` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To remove a Lambda function’s permissions


# This operation removes a Lambda function's permissions

resp = client.remove_permission({
  function_name: "myFunction", 
  qualifier: "1", 
  statement_id: "role-statement-id", 
})

Request syntax with placeholder values


resp = client.remove_permission({
  function_name: "FunctionName", # required
  statement_id: "NamespacedStatementId", # required
  qualifier: "Qualifier",
  revision_id: "String",
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    Lambda function whose resource policy you want to remove a permission from.

    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 characters in length.

  • :statement_id (required, String) —

    Statement ID of the permission to remove.

  • :qualifier (String) —

    You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don’t specify this parameter, the API removes permission associated with the unqualified function ARN.

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2427
2428
2429
2430
 
# File 'lib/aws-sdk-lambda/client.rb', line 2427

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

#tag_resource(params = {}) ⇒ Struct

Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see [Tagging Lambda Functions] in the **AWS Lambda Developer Guide**.

[1]: docs.aws.amazon.com/lambda/latest/dg/tagging.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource: "FunctionArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2475
2476
2477
2478
 
# File 'lib/aws-sdk-lambda/client.rb', line 2475

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see [Tagging Lambda Functions] in the **AWS Lambda Developer Guide**.

[1]: docs.aws.amazon.com/lambda/latest/dg/tagging.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource: "FunctionArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2519
2520
2521
2522
 
# File 'lib/aws-sdk-lambda/client.rb', line 2519

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

#update_alias(params = {}) ⇒ Types::AliasConfiguration

Using this API you can update the function version to which the alias points and the alias description. For more information, see [Introduction to AWS Lambda Aliases].

This requires permission for the lambda:UpdateAlias action.

[1]: docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html

Examples:

Example: To update a Lambda function alias


# This operation updates a Lambda function alias

resp = client.update_alias({
  description: "", 
  function_name: "myFunction", 
  function_version: "1", 
  name: "functionAlias", 
})

resp.to_h outputs the following:
{
  alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:functionAlias", 
  description: "", 
  function_version: "1", 
  name: "functionAlias", 
}

Request syntax with placeholder values


resp = client.update_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
  function_version: "Version",
  description: "Description",
  routing_config: {
    additional_version_weights: {
      "AdditionalVersion" => 1.0,
    },
  },
  revision_id: "String",
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :name (required, String) —

    The alias name.

  • :function_version (String) —

    Using this parameter you can change the Lambda function version to which the alias points.

  • :description (String) —

    You can change the description of the alias using this parameter.

  • :routing_config (Types::AliasRoutingConfiguration) —

    Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

See Also:



2619
2620
2621
2622
 
# File 'lib/aws-sdk-lambda/client.rb', line 2619

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

#update_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the ‘FunctionName` parameter. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don’t lose processing of any records. However, if you delete event source mapping and create it again, it will reset.

This operation requires permission for the ‘lambda:UpdateEventSourceMapping` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To update a Lambda function event source mapping


# This operation updates a Lambda function event source mapping

resp = client.update_event_source_mapping({
  batch_size: 123, 
  enabled: true, 
  function_name: "myFunction", 
  uuid: "1234xCy789012", 
})

resp.to_h outputs the following:
{
  batch_size: 123, 
  event_source_arn: "arn:aws:s3:::examplebucket/*", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  last_processing_result: "", 
  state: "", 
  state_transition_reason: "", 
  uuid: "1234xCy789012", 
}

Request syntax with placeholder values


resp = client.update_event_source_mapping({
  uuid: "String", # required
  function_name: "FunctionName",
  enabled: false,
  batch_size: 1,
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source_arn #=> String
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The event source mapping identifier.

  • :function_name (String) —

    The Lambda function to which you want the stream records sent.

    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 characters in length.

    If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see [AWS Lambda Function Versioning and Aliases]

    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.

    [1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

  • :enabled (Boolean) —

    Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

  • :batch_size (Integer) —

    The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Returns:

See Also:



2742
2743
2744
2745
 
# File 'lib/aws-sdk-lambda/client.rb', line 2742

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

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

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:UpdateFunctionCode` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To update a Lambda function’s code


# This operation updates a Lambda function's code

resp = client.update_function_code({
  function_name: "myFunction", 
  publish: true, 
  s3_bucket: "myBucket", 
  s3_key: "myKey", 
  s3_object_version: "1", 
  zip_file: "fileb://file-path/file.zip", 
})

resp.to_h outputs the following:
{
  code_sha_256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
  code_size: 123, 
  description: "", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  function_name: "myFunction", 
  handler: "index.handler", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  runtime: "python2.7", 
  timeout: 123, 
  version: "1", 
  vpc_config: {
  }, 
}

Request syntax with placeholder values


resp = client.update_function_code({
  function_name: "FunctionName", # required
  zip_file: "data",
  s3_bucket: "S3Bucket",
  s3_key: "S3Key",
  s3_object_version: "S3ObjectVersion",
  publish: false,
  dry_run: false,
  revision_id: "String",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The existing Lambda function name whose code you want to replace.

    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 characters in length.

  • :zip_file (String, IO) —

    The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see [Execution Permissions].

    [1]: docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role.html

  • :s3_bucket (String) —

    Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.

  • :s3_key (String) —

    The Amazon S3 object (the deployment package) key name you want to upload.

  • :s3_object_version (String) —

    The Amazon S3 object (the deployment package) version you want to upload.

  • :publish (Boolean) —

    This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

  • :dry_run (Boolean) —

    This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the ‘CodeSha256` hash value of the provided code will also be computed and returned in the response.

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

See Also:



2917
2918
2919
2920
 
# File 'lib/aws-sdk-lambda/client.rb', line 2917

def update_function_code(params = {}, options = {})
  req = build_request(:update_function_code, 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.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see [AWS Lambda Function Versioning and Aliases].

This operation requires permission for the ‘lambda:UpdateFunctionConfiguration` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html

Examples:

Example: To update a Lambda function’s configuration


# This operation updates a Lambda function's configuration

resp = client.update_function_configuration({
  description: "", 
  function_name: "myFunction", 
  handler: "index.handler", 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  runtime: "python2.7", 
  timeout: 123, 
  vpc_config: {
  }, 
})

resp.to_h outputs the following:
{
  code_sha_256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
  code_size: 123, 
  description: "", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  function_name: "myFunction", 
  handler: "index.handler", 
  last_modified: Time.parse("2016-11-21T19:49:20.006+0000"), 
  memory_size: 128, 
  role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  runtime: "python2.7", 
  timeout: 123, 
  version: "1", 
  vpc_config: {
  }, 
}

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,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, java8, python2.7, python3.6, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, nodejs4.3-edge, go1.x
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  revision_id: "String",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "java8", "python2.7", "python3.6", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "nodejs4.3-edge", "go1.x"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the Lambda function.

    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.

  • :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. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

  • :timeout (Integer) —

    The function execution time at which AWS 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. AWS 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.

  • :vpc_config (Types::VpcConfig) —

    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

  • :environment (Types::Environment) —

    The parent object that contains your environment’s configuration settings.

  • :runtime (String) —

    The runtime environment for the Lambda function.

    To use the Python runtime v3.6, set the value to “python3.6”. To use the Python runtime v2.7, set the value to “python2.7”. To use the Node.js runtime v6.10, set the value to “nodejs6.10”. To use the Node.js runtime v4.3, set the value to “nodejs4.3”. To use the .NET Core runtime v1.0, set the value to “dotnetcore1.0”. To use the .NET Core runtime v2.0, set the value to “dotnetcore2.0”.

    <note markdown=“1”> Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

    </note>
  • :dead_letter_config (Types::DeadLetterConfig) —

    The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the KMS key used to encrypt your function’s environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string (“”) for this parameter.

  • :tracing_config (Types::TracingConfig) —

    The parent object that contains your function’s tracing settings.

  • :revision_id (String) —

    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the ‘RevisionID` you pass doesn’t match the latest ‘RevisionId` of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

See Also:



3146
3147
3148
3149
 
# File 'lib/aws-sdk-lambda/client.rb', line 3146

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


3170
3171
3172
 
# File 'lib/aws-sdk-lambda/client.rb', line 3170

def waiter_names
  []
end