Skip to content
AWS for Query.Farm

aws.lambda.get_event_source_mapping

Example SQL Queries

SELECT * FROM
aws.lambda.get_event_source_mapping
WHERE
"uuid" = 'VALUE';

Description

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

Table Definition

Column NameColumn Data Type
uuid Required Input Column

The identifier of the event source mapping.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
amazon_managed_kafka_event_source_config

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

STRUCT(
    "consumer_group_id" VARCHAR
)
Show child fields
amazon_managed_kafka_event_source_config.consumer_group_id

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

batch_size

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

BIGINT
bisect_batch_on_function_error

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

BOOLEAN
destination_config

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

STRUCT(
    "on_success" STRUCT(
        "destination" VARCHAR
    ),
    "on_failure" STRUCT(
        "destination" VARCHAR
    )
)
Show child fields
destination_config.on_failure

The destination configuration for failed invocations.

Show child fields
destination_config.on_failure.destination

The Amazon Resource Name (ARN) of the destination resource.

To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

destination_config.on_success

The destination configuration for successful invocations.

Show child fields
destination_config.on_success.destination

The Amazon Resource Name (ARN) of the destination resource.

document_db_event_source_config

Specific configuration settings for a DocumentDB event source.

STRUCT(
    "database_name" VARCHAR,
    "collection_name" VARCHAR,
    "full_document" VARCHAR
)
Show child fields
document_db_event_source_config.collection_name

The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

document_db_event_source_config.database_name

The name of the database to consume within the DocumentDB cluster.

document_db_event_source_config.full_document

Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

event_source_arn

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

VARCHAR
filter_criteria

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

STRUCT(
    "filters" STRUCT(
        "pattern" VARCHAR
    )[]
)
Show child fields
filter_criteria.filters[]
Show child fields
filter_criteria.filters[].pattern

A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

filter_criteria_error

An object that contains details about an error related to filter criteria encryption.

STRUCT(
    "error_code" VARCHAR,
    "message" VARCHAR
)
Show child fields
filter_criteria_error.error_code

The KMS exception that resulted from filter criteria encryption or decryption.

filter_criteria_error.message

The error message.

function_arn

The ARN of the Lambda function.

VARCHAR
function_response_types

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

VARCHAR[]
Show child fields
function_response_types[]
kms_key_arn

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

VARCHAR
last_modified

The date that the event source mapping was last updated or that its state changed.

TIMESTAMP_S
last_processing_result

The result of the last Lambda invocation of your function.

VARCHAR
maximum_batching_window_in_seconds

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

BIGINT
maximum_record_age_in_seconds

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

BIGINT
maximum_retry_attempts

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

BIGINT
parallelization_factor

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

BIGINT
queues

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

VARCHAR[]
Show child fields
queues[]
scaling_config

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

STRUCT(
    "maximum_concurrency" BIGINT
)
Show child fields
scaling_config.maximum_concurrency

Limits the number of concurrent instances that the Amazon SQS event source can invoke.

self_managed_event_source

The self-managed Apache Kafka cluster for your event source.

STRUCT(
    "endpoints" MAP(VARCHAR, VARCHAR[])
)
Show child fields
self_managed_event_source.endpoints

The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

self_managed_kafka_event_source_config

Specific configuration settings for a self-managed Apache Kafka event source.

STRUCT(
    "consumer_group_id" VARCHAR
)
Show child fields
self_managed_kafka_event_source_config.consumer_group_id

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

source_access_configurations

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

STRUCT(
    "type" VARCHAR,
    "uri" VARCHAR
)[]
Show child fields
source_access_configurations[]
Show child fields
source_access_configurations[].type

The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

  • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

  • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

  • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

  • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

  • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

  • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

  • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

  • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

source_access_configurations[].uri

The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

starting_position

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

VARCHAR
starting_position_timestamp

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

TIMESTAMP_S
state

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

VARCHAR
state_transition_reason

Indicates whether a user or Lambda made the last change to the event source mapping.

VARCHAR
topics

The name of the Kafka topic.

VARCHAR[]
Show child fields
topics[]
tumbling_window_in_seconds

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

BIGINT