AWS Lambda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWS Lambda Event Source Mappings API

6 actions 6 updates phrasing extends openapi/aws-lambda-event-source-mappings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AWS Lambda's API. It is a proposal applied on top of the contract, not a document AWS Lambda publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/2015-03-31/event-source-mappings'].get
$.paths['/2015-03-31/event-source-mappings'].post
$.paths['/2015-03-31/event-source-mappings/{UUID}'].get
$.paths['/2015-03-31/event-source-mappings/{UUID}'].put
$.paths['/2015-03-31/event-source-mappings/{UUID}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AWS Lambda Event Source Mappings API
  version: 1.0.0
extends: openapi/aws-lambda-event-source-mappings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/2015-03-31/event-source-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List event source mappings
      effect: read
      questions:
      - Which queues and streams are wired up to trigger my functions?
      - Can I see only the mappings for one SQS queue or Kinesis stream?
      - What event sources feed a particular Lambda function?
      instructions:
      - text: List the event source mappings for function {function}.
        slots:
          function: query.FunctionName
      - text: List mappings attached to event source {source_arn}.
        slots:
          source_arn: query.EventSourceArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2015-03-31/event-source-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a queue or stream to a function
      effect: write
      questions:
      - How do I make an SQS queue trigger my Lambda function?
      - Can I filter which stream records reach my function before it is invoked?
      - Where do I set batch size and starting position when wiring a Kinesis stream to a function?
      instructions:
      - text: Connect event source {source_arn} to function {function}.
        slots:
          source_arn: requestBody.EventSourceArn
          function: requestBody.FunctionName
      - text: Have {function} read stream {source_arn} from {starting_position} in batches of {batch_size}.
        slots:
          function: requestBody.FunctionName
          source_arn: requestBody.EventSourceArn
          starting_position: requestBody.StartingPosition
          batch_size: requestBody.BatchSize
      - text: Create a new trigger from {source_arn} to {function} that only passes records matching {filter}.
        slots:
          source_arn: requestBody.EventSourceArn
          function: requestBody.FunctionName
          filter: requestBody.FilterCriteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2015-03-31/event-source-mappings/{UUID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one event source mapping
      effect: read
      questions:
      - What is the current state and batch size of a specific event source mapping?
      - Is a given trigger mapping enabled or paused right now?
      instructions:
      - text: Show event source mapping {uuid}.
        slots:
          uuid: path.UUID
      - text: Tell me whether mapping {uuid} is enabled and which function it invokes.
        slots:
          uuid: path.UUID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2015-03-31/event-source-mappings/{UUID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause, resume or retune an event source mapping
      effect: write
      questions:
      - How do I pause a queue trigger and resume later from the same position?
      - Can I send failed batches from an existing mapping to an SQS queue or SNS topic?
      instructions:
      - text: Set enabled to {enabled} on event source mapping {uuid}.
        slots:
          uuid: path.UUID
          enabled: requestBody.Enabled
      - text: Point existing mapping {uuid} at function {function} with batch size {batch_size}.
        slots:
          uuid: path.UUID
          function: requestBody.FunctionName
          batch_size: requestBody.BatchSize
      - text: Send failed records from mapping {uuid} to destination {destination}.
        slots:
          uuid: path.UUID
          destination: requestBody.DestinationConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2015-03-31/event-source-mappings/{UUID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event source mapping
      effect: destructive
      questions:
      - How do I stop Lambda from polling a queue or stream for good?
      - Does removing a trigger mapping delete the underlying queue?
      instructions:
      - text: Delete event source mapping {uuid}.
        slots:
          uuid: path.UUID
      - text: Remove trigger {uuid} so Lambda stops polling its source.
        slots:
          uuid: path.UUID
      method: generated
      generated: '2026-10-01'