Spec-Zone.ru › AWS CLI v2

[ aws . lambda ]

get-event-source-mapping

Описание

Возвращает подробную информацию об источнике событий. Идентификатор отображения можно получить из вывода команды ListEventSourceMappings.

См. также: Документация API AWS

Синтаксис

  get-event-source-mapping
--uuid <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--uuid (строка)

Идентификатор источника событий.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос к API. Если предоставлено значение без значения или значение input, выводится пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяются входные данные команды и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную регистрацию.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI будет выполнять только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматический

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить выгрузку страниц cli.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила цитирования, подобные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения подробной информации об источнике событий

В следующем get-event-source-mapping примере отображаются данные для отображения между очередью SQS и my-function функцией Lambda.

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

Вывод:

{
    "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"
}

Дополнительную информацию можно найти в разделе AWS Lambda Event Source Mapping в Руководстве разработчика AWS Lambda.

Вывод

UUID -> (строка)

Идентификатор источника событий.

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение. Требуется для источников событий Amazon Kinesis и Amazon DynamoDB Stream. AT_TIMESTAMP поддерживается только для потоков Amazon Kinesis, Amazon DocumentDB, Amazon MSK и собственных Apache Kafka.

StartingPositionTimestamp -> (метка времени)

При значении StartingPosition, установленного в AT_TIMESTAMP, время, с которого начать чтение. StartingPositionTimestamp не может быть в будущем.

BatchSize -> (целое число)

Максимальное количество записей в каждой партии, которое Lambda извлекает из потока или очереди и отправляет вашей функции. Lambda передает все записи в партии функции в одном вызове, до предела полезной нагрузки для синхронного вызова (6 МБ).

Значение по умолчанию: варьируется в зависимости от службы. Для Amazon SQS значение по умолчанию равно 10. Для всех других служб значение по умолчанию равно 100.

Связанное значение: когда вы устанавливаете BatchSize на значение больше 10, вы должны установить MaximumBatchingWindowInSeconds по меньшей мере на 1.

MaximumBatchingWindowInSeconds -> (целое число)

Максимальное время в секундах, которое Lambda тратит на сбор записей перед вызовом функции. Вы можете настроить MaximumBatchingWindowInSeconds на любое значение от 0 до 300 секунд с шагом в секунды.

Для потоков и источников событий Amazon SQS значение по умолчанию для окна группировки — 0 секунд. Для источников событий Amazon MSK, собственного Apache Kafka, Amazon MQ и DocumentDB значение по умолчанию для окна группировки — 500 мс. Обратите внимание, что поскольку вы можете изменять MaximumBatchingWindowInSeconds только с шагом в секунды, вы не можете вернуться к значению по умолчанию 500 мс после его изменения. Чтобы восстановить значение по умолчанию для окна группировки, необходимо создать новое отображение источника событий.

Связанное значение: для потоков и источников событий Amazon SQS, когда вы устанавливаете BatchSize на значение больше 10, вы должны установить MaximumBatchingWindowInSeconds по меньшей мере на 1.

ParallelizationFactor -> (целое число)

(Только для Kinesis и DynamoDB Streams) Количество партий, которые обрабатываются параллельно из каждого фрагмента. Значение по умолчанию — 1.

EventSourceArn -> (строка)

Amazon Resource Name (ARN) источника событий.

FilterCriteria -> (структура)

Объект, определяющий критерии фильтрации, которые определяют, должна ли Lambda обрабатывать событие. Для получения дополнительной информации см. фильтрацию событий Lambda.

Если критерии фильтрации зашифрованы, в ответ на вызовы API ListEventSourceMapping отображается null. Вы можете просмотреть это поле в открытом виде в ответах вызовов GetEventSourceMapping и DeleteEventSourceMapping, если у вас есть kms:Decrypt разрешения на соответствующий ключ KMS.

Filters -> (список)

Список фильтров.

(структура)

Структура в объекте FilterCriteria, определяющая шаблон фильтрации событий.

Pattern -> (строка)

Шаблон фильтра. Для получения дополнительной информации о синтаксисе шаблона фильтра см. синтаксис правила фильтрации.

FunctionArn -> (строка)

ARN функции Lambda.

LastModified -> (метка времени)

Дата последнего обновления или изменения состояния отображения источника событий.

LastProcessingResult -> (строка)

Результат последнего вызова функции Lambda.

State -> (строка)

Состояние отображения источника событий. Оно может быть одним из следующих: Creating , Enabling , Enabled , Disabling , Disabled , Updating или Deleting .

StateTransitionReason -> (строка)

Указывает, пользователь или Lambda произвели последнее изменение отображения источника событий.

DestinationConfig -> (структура)

(Только для источников событий Kinesis, DynamoDB Streams, Amazon MSK и собственного Apache Kafka) Объект конфигурации, определяющий пункт назначения события после обработки Lambda.

OnSuccess -> (структура)

Конфигурация пункта назначения для успешных вызовов.

Destination -> (строка)

Amazon Resource Name (ARN) ресурса назначения.

OnFailure -> (структура)

Конфигурация пункта назначения для неудачных вызовов.

Destination -> (строка)

Amazon Resource Name (ARN) ресурса назначения.

Для сохранения записей об неудачных асинхронных вызовах можно настроить Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function или Amazon EventBridge event bus в качестве пункта назначения.

Для сохранения записей об неудачных вызовах из Kinesis, DynamoDB, собственного Kafka или Amazon MSK можно настроить Amazon SNS topic, Amazon SQS queue или Amazon S3 bucket в качестве пункта назначения.

Topics -> (список)

Имя темы Kafka.

(строка)

Queues -> (список)

(Amazon MQ) Имя очереди пункта назначения Amazon MQ broker для потребления.

(строка)

SourceAccessConfigurations -> (список)

Массив протокола аутентификации, компонентов VPC или виртуального хоста для защиты и определения вашего источника событий.

(структура)

Для защиты и определения доступа к вашему источнику событий можно указать протокол аутентификации, компоненты VPC или виртуальный хост.

Type -> (строка)

Тип протокола аутентификации, компонентов VPC или виртуального хоста для вашего источника событий. Например: "Type":"SASL_SCRAM_512_AUTH" .

  • BASIC_AUTH – (Amazon MQ) Секрет Secrets Manager, хранящий ваши учетные данные брокера.
  • BASIC_AUTH – (Собственный Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL/PLAIN ваших брокеров Apache Kafka.
  • VPC_SUBNET – (Собственный Apache Kafka) Подсети, связанные с вашей VPC. Lambda подключается к этим подсетям для извлечения данных из вашего кластера собственного Apache Kafka.
  • VPC_SECURITY_GROUP – (Собственный Apache Kafka) Группа безопасности VPC, используемая для управления доступом к вашим брокерам собственного Apache Kafka.
  • SASL_SCRAM_256_AUTH – (Собственный Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-256 ваших брокеров собственного Apache Kafka.
  • SASL_SCRAM_512_AUTH – (Amazon MSK, Собственный Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-512 ваших брокеров собственного Apache Kafka.
  • VIRTUAL_HOST – (RabbitMQ) Имя виртуального хоста в вашем брокере RabbitMQ. Lambda использует этот хост RabbitMQ в качестве источника событий. Это свойство не может быть указано в вызове API UpdateEventSourceMapping.
  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, собственный Apache Kafka) ARN Secrets Manager вашего секретного ключа, содержащего цепочку сертификатов (X.509 PEM), закрытый ключ (PKCS#8 PEM) и пароль к закрытому ключу (необязательно), используемый для взаимной аутентификации TLS ваших брокеров MSK/Apache Kafka.
  • SERVER_ROOT_CA_CERTIFICATE – (Собственный Apache Kafka) ARN Secrets Manager вашего секретного ключа, содержащего корневой сертификат CA (X.509 PEM), используемый для шифрования TLS ваших брокеров Apache Kafka.

URI -> (строка)

Значение для выбранной конфигурации в Type. Например: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

SelfManagedEventSource -> (структура)

Кластер собственного Apache Kafka для вашего источника событий.

Endpoints -> (карта)

Список bootstrap-серверов для ваших брокеров Kafka в следующем формате: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .

key -> (строка)

value -> (список)

(строка)

MaximumRecordAgeInSeconds -> (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи старше указанного возраста. Значение по умолчанию — -1, что устанавливает максимальный возраст в бесконечность. Когда значение установлено в бесконечность, Lambda никогда не отбрасывает старые записи.

Примечание

Минимальное допустимое значение для максимального возраста записи — 60 секунд. Хотя значения меньше 60 и больше -1 находятся в абсолютном диапазоне параметра, они не допускаются.

BisectBatchOnFunctionError -> (булево)

(Только для Kinesis и DynamoDB Streams) Если функция возвращает ошибку, разделить партию на две части и повторить попытку. Значение по умолчанию — ложь.

MaximumRetryAttempts -> (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи после указанного количества попыток. Значение по умолчанию — -1, что устанавливает максимальное количество попыток в бесконечность. Когда MaximumRetryAttempts бесконечен, Lambda повторяет попытки обработки неудачных записей до тех пор, пока запись не истечет в источнике событий.

TumblingWindowInSeconds -> (целое число)

(Только для Kinesis и DynamoDB Streams) Длительность в секундах окна обработки для источников событий DynamoDB и Kinesis Streams. Значение 0 секунд означает отсутствие окна обработки.

FunctionResponseTypes -> (список)

(Kinesis, DynamoDB Streams и Amazon SQS) Список текущих типов ответов, применяемых к отображению источника событий.

(строка)

AmazonManagedKafkaEventSourceConfig -> (структура)

Настройки конфигурации для источника событий Amazon Managed Streaming for Apache Kafka (Amazon MSK).

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka. Идентификатор группы потребителей должен быть уникальным для всех ваших источников событий Kafka. После создания отображения источника событий Kafka с указанным идентификатором группы потребителей вы не можете обновить это значение. Для получения дополнительной информации см. Настраиваемый идентификатор группы потребителей.

SelfManagedKafkaEventSourceConfig -> (структура)

Настройки конфигурации для источника событий собственного Apache Kafka.

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka. Идентификатор группы потребителей должен быть уникальным для всех ваших источников событий Kafka. После создания отображения источника событий Kafka с указанным идентификатором группы потребителей вы не можете обновить это значение. Для получения дополнительной информации см. Настраиваемый идентификатор группы потребителей.

ScalingConfig -> (структура)

(Только для Amazon SQS) Конфигурация масштабирования для источника событий. Для получения дополнительной информации см. Настройка максимальной конкуретности для источников событий Amazon SQS.

MaximumConcurrency -> (целое число)

Ограничивает количество одновременных экземпляров, которые может вызывать источник событий Amazon SQS.

DocumentDBEventSourceConfig -> (структура)

Настройки конфигурации для источника событий DocumentDB.

DatabaseName -> (строка)

Имя базы данных для потребления в кластере DocumentDB.

CollectionName -> (строка)

Имя коллекции для потребления в базе данных. Если вы не указываете коллекцию, Lambda потребляет все коллекции.

FullDocument -> (строка)

Определяет, что DocumentDB отправляет в ваш поток событий во время операций обновления документов. Если установлено значение UpdateLookup, DocumentDB отправляет дельту, описывающую изменения, вместе с копией всего документа. В противном случае DocumentDB отправляет только частичный документ, содержащий изменения.

KMSKeyArn -> (строка)

Уникальный идентификатор (ARN) управляемого клиентом ключа Услуг управления ключами (KMS), используемого Lambda для шифрования критериев фильтра вашей функции.

FilterCriteriaError -> (структура)

Объект, содержащий сведения об ошибке, связанной с шифрованием критериев фильтра.

ErrorCode -> (строка)

Исключение KMS, возникшее при шифровании или дешифровании критериев фильтра.

Message -> (строка)

Сообщение об ошибке.

EventSourceMappingArn -> (строка)

Уникальный идентификатор ресурса Amazon (ARN) отображения источника событий.

MetricsConfig -> (структура)

Настройка метрик для вашего источника событий. Дополнительная информация представлена в разделе Метрики отображения источника событий.

Metrics -> (список)

Метрики, которые вы хотите получать от отображения источника событий. Включите EventCount, чтобы получать метрики отображения источника событий, связанные с количеством обработанных событий вашим отображением источника событий. Дополнительную информацию о метриках см. в разделе Метрики отображения источника событий.

(строка)

ProvisionedPollerConfig -> (структура)

(Только для Amazon MSK и собственно управляемого Apache Kafka) Настройка режима выделенных ресурсов для источника событий. Дополнительную информацию см. в разделе режим выделенных ресурсов.

MinimumPollers -> (целое число)

Минимальное количество обработчиков событий, до которого может уменьшиться масштаб этого источника событий.

MaximumPollers -> (целое число)

Максимальное количество обработчиков событий, до которого может увеличиться масштаб этого источника событий.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API