list_event_source_mappings¶
Operation¶
list_event_source_mappings
¶
list_event_source_mappings(request: ListEventSourceMappingsInput | ListEventSourceMappingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEventSourceMappingsInputDict]) -> ListEventSourceMappingsOutput
Lists event source mappings. Specify an EventSourceArn to show only
event source mappings for a single event source.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEventSourceMappingsInput | ListEventSourceMappingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListEventSourceMappingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEventSourceMappingsOutput
|
An instance of |
list_event_source_mappings
async
¶
list_event_source_mappings(request: ListEventSourceMappingsInput | ListEventSourceMappingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEventSourceMappingsInputDict]) -> ListEventSourceMappingsOutput
Lists event source mappings. Specify an EventSourceArn to show only
event source mappings for a single event source.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEventSourceMappingsInput | ListEventSourceMappingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListEventSourceMappingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEventSourceMappingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListEventSourceMappingsInputDict
¶
Bases: TypedDict
Dictionary form of ListEventSourceMappingsInput.
Attributes¶
event_source_arn
instance-attribute
¶
event_source_arn: str | 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
instance-attribute
¶
function_name: str | 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.
ListEventSourceMappingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListEventSourceMappingsInput structure.
Attributes¶
event_source_arn
class-attribute
instance-attribute
¶
event_source_arn: str | 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 = ...
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.
Output¶
ListEventSourceMappingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListEventSourceMappingsOutput structure.
Attributes¶
event_source_mappings
class-attribute
instance-attribute
¶
event_source_mappings: list[EventSourceMappingConfiguration] | None = ...
A list of event source mappings.
next_marker
class-attribute
instance-attribute
¶
next_marker: str | None = ...
A pagination token that's returned when the response doesn't contain all event source mappings.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.