[ aws . lambda ]

get-event-source-mapping

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-event-source-mapping
--uuid <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--uuid (string)

The identifier of the event source mapping.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve details about an event source mapping

The following get-event-source-mapping example displays the details for the mapping between an SQS queue and the my-function Lambda function.

aws lambda get-event-source-mapping \
    --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"

Output:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569284520.333,
    "BatchSize": 5,
    "State": "Enabled",
    "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue"
}

For more information, see AWS Lambda Event Source Mapping in the AWS Lambda Developer Guide.

Output

UUID -> (string)

The identifier of the event source mapping.

BatchSize -> (integer)

The maximum number of items to retrieve in a single batch.

MaximumBatchingWindowInSeconds -> (integer)

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

ParallelizationFactor -> (integer)

(Streams) The number of batches to process from each shard concurrently.

EventSourceArn -> (string)

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

FunctionArn -> (string)

The ARN of the Lambda function.

LastModified -> (timestamp)

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

LastProcessingResult -> (string)

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

State -> (string)

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

StateTransitionReason -> (string)

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

DestinationConfig -> (structure)

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

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

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

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

Topics -> (list)

(MSK) The name of the Kafka topic.

(string)

MaximumRecordAgeInSeconds -> (integer)

(Streams) The maximum age of a record that Lambda sends to a function for processing.

BisectBatchOnFunctionError -> (boolean)

(Streams) If the function returns an error, split the batch in two and retry.

MaximumRetryAttempts -> (integer)

(Streams) The maximum number of times to retry when the function returns an error.