Network.AWS.Lambda.UpdateEventSourceMapping

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.

Creating a Request

updateEventSourceMapping

Arguments

:: Text

uesmUUId

-> UpdateEventSourceMapping

Creates a value of UpdateEventSourceMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uesmEnabled - Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.
• uesmBatchSize - The maximum number of stream records that can be sent to your Lambda function for a single invocation.
• uesmFunctionName - 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.
• uesmUUId - The event source mapping identifier.

data UpdateEventSourceMapping

See: updateEventSourceMapping smart constructor.

Instances

Eq UpdateEventSourceMapping

Methods

(==) :: UpdateEventSourceMapping -> UpdateEventSourceMapping -> Bool

(/=) :: UpdateEventSourceMapping -> UpdateEventSourceMapping -> Bool

Data UpdateEventSourceMapping

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateEventSourceMapping -> c UpdateEventSourceMapping

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateEventSourceMapping

toConstr :: UpdateEventSourceMapping -> Constr

dataTypeOf :: UpdateEventSourceMapping -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateEventSourceMapping)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateEventSourceMapping)

gmapT :: (forall b. Data b => b -> b) -> UpdateEventSourceMapping -> UpdateEventSourceMapping

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateEventSourceMapping -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateEventSourceMapping -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateEventSourceMapping -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateEventSourceMapping -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateEventSourceMapping -> m UpdateEventSourceMapping

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateEventSourceMapping -> m UpdateEventSourceMapping

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateEventSourceMapping -> m UpdateEventSourceMapping

Read UpdateEventSourceMapping

Methods

readsPrec :: Int -> ReadS UpdateEventSourceMapping

readList :: ReadS [UpdateEventSourceMapping]

readPrec :: ReadPrec UpdateEventSourceMapping

readListPrec :: ReadPrec [UpdateEventSourceMapping]

Show UpdateEventSourceMapping

Methods

showsPrec :: Int -> UpdateEventSourceMapping -> ShowS

show :: UpdateEventSourceMapping -> String

showList :: [UpdateEventSourceMapping] -> ShowS

Generic UpdateEventSourceMapping

Associated Types

type Rep UpdateEventSourceMapping :: * -> *

Methods

from :: UpdateEventSourceMapping -> Rep UpdateEventSourceMapping x

to :: Rep UpdateEventSourceMapping x -> UpdateEventSourceMapping

Hashable UpdateEventSourceMapping

Methods

hashWithSalt :: Int -> UpdateEventSourceMapping -> Int

hash :: UpdateEventSourceMapping -> Int

ToJSON UpdateEventSourceMapping

Methods

toJSON :: UpdateEventSourceMapping -> Value

toEncoding :: UpdateEventSourceMapping -> Encoding

toJSONList :: [UpdateEventSourceMapping] -> Value

toEncodingList :: [UpdateEventSourceMapping] -> Encoding

NFData UpdateEventSourceMapping

Methods

rnf :: UpdateEventSourceMapping -> ()

AWSRequest UpdateEventSourceMapping

Associated Types

type Rs UpdateEventSourceMapping :: *

Methods

request :: UpdateEventSourceMapping -> Request UpdateEventSourceMapping

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateEventSourceMapping -> ClientResponse -> m (Response UpdateEventSourceMapping)

ToHeaders UpdateEventSourceMapping

Methods

toHeaders :: UpdateEventSourceMapping -> [Header]

ToPath UpdateEventSourceMapping

Methods

toPath :: UpdateEventSourceMapping -> ByteString

ToQuery UpdateEventSourceMapping

Methods

toQuery :: UpdateEventSourceMapping -> QueryString

type Rep UpdateEventSourceMapping

type Rep UpdateEventSourceMapping = D1 * (MetaData "UpdateEventSourceMapping" "Network.AWS.Lambda.UpdateEventSourceMapping" "amazonka-lambda-1.6.0-BCoVnxAqk5DEBm6Teqtlxw" False) (C1 * (MetaCons "UpdateEventSourceMapping'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uesmEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_uesmBatchSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uesmFunctionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uesmUUId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs UpdateEventSourceMapping

type Rs UpdateEventSourceMapping = EventSourceMappingConfiguration

Request Lenses

uesmEnabled :: Lens' UpdateEventSourceMapping (Maybe Bool)

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

uesmBatchSize :: Lens' UpdateEventSourceMapping (Maybe Natural)

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

uesmFunctionName :: Lens' UpdateEventSourceMapping (Maybe Text)

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.

uesmUUId :: Lens' UpdateEventSourceMapping Text

The event source mapping identifier.

Destructuring the Response

eventSourceMappingConfiguration :: EventSourceMappingConfiguration

Creates a value of EventSourceMappingConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esmcEventSourceARN - The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
• esmcState - The state of the event source mapping. It can be Creating , Enabled , Disabled , Enabling , Disabling , Updating , or Deleting .
• esmcFunctionARN - The Lambda function to invoke when AWS Lambda detects an event on the stream.
• esmcUUId - The AWS Lambda assigned opaque identifier for the mapping.
• esmcLastProcessingResult - The result of the last AWS Lambda invocation of your Lambda function.
• esmcBatchSize - The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
• esmcStateTransitionReason - The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
• esmcLastModified - The UTC time string indicating the last time the event mapping was updated.

data EventSourceMappingConfiguration

Describes mapping between an Amazon Kinesis stream and a Lambda function.

See: eventSourceMappingConfiguration smart constructor.

Instances

Eq EventSourceMappingConfiguration

Methods

(==) :: EventSourceMappingConfiguration -> EventSourceMappingConfiguration -> Bool

(/=) :: EventSourceMappingConfiguration -> EventSourceMappingConfiguration -> Bool

Data EventSourceMappingConfiguration

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EventSourceMappingConfiguration -> c EventSourceMappingConfiguration

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EventSourceMappingConfiguration

toConstr :: EventSourceMappingConfiguration -> Constr

dataTypeOf :: EventSourceMappingConfiguration -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EventSourceMappingConfiguration)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EventSourceMappingConfiguration)

gmapT :: (forall b. Data b => b -> b) -> EventSourceMappingConfiguration -> EventSourceMappingConfiguration

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EventSourceMappingConfiguration -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EventSourceMappingConfiguration -> r

gmapQ :: (forall d. Data d => d -> u) -> EventSourceMappingConfiguration -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EventSourceMappingConfiguration -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EventSourceMappingConfiguration -> m EventSourceMappingConfiguration

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EventSourceMappingConfiguration -> m EventSourceMappingConfiguration

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EventSourceMappingConfiguration -> m EventSourceMappingConfiguration

Read EventSourceMappingConfiguration

Methods

readsPrec :: Int -> ReadS EventSourceMappingConfiguration

readList :: ReadS [EventSourceMappingConfiguration]

readPrec :: ReadPrec EventSourceMappingConfiguration

readListPrec :: ReadPrec [EventSourceMappingConfiguration]

Show EventSourceMappingConfiguration

Methods

showsPrec :: Int -> EventSourceMappingConfiguration -> ShowS

show :: EventSourceMappingConfiguration -> String

showList :: [EventSourceMappingConfiguration] -> ShowS

Generic EventSourceMappingConfiguration

Associated Types

type Rep EventSourceMappingConfiguration :: * -> *

Methods

from :: EventSourceMappingConfiguration -> Rep EventSourceMappingConfiguration x

to :: Rep EventSourceMappingConfiguration x -> EventSourceMappingConfiguration

Hashable EventSourceMappingConfiguration

Methods

hashWithSalt :: Int -> EventSourceMappingConfiguration -> Int

hash :: EventSourceMappingConfiguration -> Int

FromJSON EventSourceMappingConfiguration

Methods

parseJSON :: Value -> Parser EventSourceMappingConfiguration

parseJSONList :: Value -> Parser [EventSourceMappingConfiguration]

NFData EventSourceMappingConfiguration

Methods

rnf :: EventSourceMappingConfiguration -> ()

type Rep EventSourceMappingConfiguration

type Rep EventSourceMappingConfiguration = D1 * (MetaData "EventSourceMappingConfiguration" "Network.AWS.Lambda.Types.Product" "amazonka-lambda-1.6.0-BCoVnxAqk5DEBm6Teqtlxw" False) (C1 * (MetaCons "EventSourceMappingConfiguration'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_esmcEventSourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esmcState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_esmcFunctionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esmcUUId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_esmcLastProcessingResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esmcBatchSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_esmcStateTransitionReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esmcLastModified") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))))))

Response Lenses

esmcEventSourceARN :: Lens' EventSourceMappingConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

esmcState :: Lens' EventSourceMappingConfiguration (Maybe Text)

The state of the event source mapping. It can be Creating , Enabled , Disabled , Enabling , Disabling , Updating , or Deleting .

esmcFunctionARN :: Lens' EventSourceMappingConfiguration (Maybe Text)

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

esmcUUId :: Lens' EventSourceMappingConfiguration (Maybe Text)

The AWS Lambda assigned opaque identifier for the mapping.

esmcLastProcessingResult :: Lens' EventSourceMappingConfiguration (Maybe Text)

The result of the last AWS Lambda invocation of your Lambda function.

esmcBatchSize :: Lens' EventSourceMappingConfiguration (Maybe Natural)

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

esmcStateTransitionReason :: Lens' EventSourceMappingConfiguration (Maybe Text)

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

esmcLastModified :: Lens' EventSourceMappingConfiguration (Maybe UTCTime)

The UTC time string indicating the last time the event mapping was updated.