AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateEventSourceMapping operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.UpdateEventSourceMappingRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateEventSourceMappingRequest : AmazonLambdaRequest
         IAmazonWebServiceRequest

The UpdateEventSourceMappingRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BatchSize System.Int32

Gets and sets the property BatchSize.

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

Public Property Enabled System.Boolean

Gets and sets the property Enabled.

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

Public Property FunctionName System.String

Gets and sets the property FunctionName.

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.

Public Property UUID System.String

Gets and sets the property UUID.

The event source mapping identifier.

Examples

This operation updates a Lambda function event source mapping

To update a Lambda function event source mapping


var response = client.UpdateEventSourceMapping(new UpdateEventSourceMappingRequest 
{
    BatchSize = 123,
    Enabled = true,
    FunctionName = "myFunction",
    UUID = "1234xCy789012"
});

integer batchSize = response.BatchSize;
string eventSourceArn = response.EventSourceArn;
string functionArn = response.FunctionArn;
DateTime lastModified = response.LastModified;
string lastProcessingResult = response.LastProcessingResult;
string state = response.State;
string stateTransitionReason = response.StateTransitionReason;
string uuid = response.UUID;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone