Skip to content

Lambda  >  Operations  >  list_event_source_mappings

list_event_source_mappings

Operation

list_event_source_mappings async 

list_event_source_mappings(input: ListEventSourceMappingsInput, plugins: list[Plugin] | None = None) -> ListEventSourceMappingsOutput

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

Parameters:

Name Type Description Default
input ListEventSourceMappingsInput

An instance of ListEventSourceMappingsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListEventSourceMappingsOutput

An instance of ListEventSourceMappingsOutput.

Input

ListEventSourceMappingsInput dataclass

Dataclass for ListEventSourceMappingsInput structure.

Attributes

event_source_arn class-attribute instance-attribute 
event_source_arn: str | None = None

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis -- The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams -- The ARN of the stream.

  • Amazon Simple Queue Service -- The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka -- The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ -- The ARN of the broker.

  • Amazon DocumentDB -- The ARN of the DocumentDB change stream.

function_name class-attribute instance-attribute 
function_name: str | None = None

The name or ARN of the Lambda function.

Name formats

  • Function name -- MyFunction.

  • Function ARN -- arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN -- arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN -- 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

marker class-attribute instance-attribute 
marker: str | None = None

A pagination token returned by a previous call.

max_items class-attribute instance-attribute 
max_items: int | None = None

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

Output

ListEventSourceMappingsOutput dataclass

Dataclass for ListEventSourceMappingsOutput structure.

Attributes

event_source_mappings class-attribute instance-attribute 
event_source_mappings: list[EventSourceMappingConfiguration] | None = None

A list of event source mappings.

next_marker class-attribute instance-attribute 
next_marker: str | None = None

A pagination token that's returned when the response doesn't contain all event source mappings.