Spec-Zone.ru › AWS CLI v2

[ aws . lambda ]

list-event-source-mappings

Описание

Отображает отображения источников событий. Укажите EventSourceArn, чтобы отобразить только отображения источников событий для одного источника событий.

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

list-event-source-mappings — это операция с постраничной передачей. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: EventSourceMappings

Синтаксис

  list-event-source-mappings
[--event-source-arn <value>]
[--function-name <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--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]

Параметры

--event-source-arn (строка)

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

  • Amazon Kinesis — ARN потока данных или потребителя потока.
  • Amazon DynamoDB Streams — ARN потока.
  • Amazon Simple Queue Service — ARN очереди.
  • Amazon Managed Streaming for Apache Kafka — ARN кластера или ARN подключения VPC (для отображений источников событий между учётными записями).
  • Amazon MQ — ARN брокера.
  • Amazon DocumentDB — ARN потока изменений DocumentDB.

--function-name (строка)

Имя или ARN функции Lambda.

Форматы имён
  • Имя функции — MyFunction.
  • ARN функции — arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
  • ARN версии или псевдонима — arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
  • Частичный ARN — 123456789012:function:MyFunction.

Ограничение длины применяется только к полному ARN. Если вы указываете только имя функции, его длина ограничена 64 символами.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной передачи предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS Command Line Interface.

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

--starting-token (строка)

Токен для указания места начала постраничной передачи. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS Command Line Interface.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

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

Следующий list-event-source-mappings пример отображает список отображений источников событий для функции my-function Lambda.

aws lambda list-event-source-mappings \
    --function-name my-function

Вывод:

{
    "EventSourceMappings": [
        {
            "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.

Вывод

NextMarker -> (строка)

Маркер постраничной навигации, возвращаемый, когда ответ не содержит все отображения источников событий.

EventSourceMappings -> (список)

Список отображений источников событий.

(структура)

Сопоставление между ресурсом Amazon Web Services и функцией Lambda. Подробнее см. CreateEventSourceMapping .

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 event filtering .

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

Filters -> (список)

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

(структура)

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

Pattern -> (строка)

Шаблон фильтрации. Дополнительная информация о синтаксисе шаблона фильтрации см. в Filter rule syntax .

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, очередь Amazon SQS, ведро Amazon S3, функцию Lambda или шину событий Amazon EventBridge в качестве места назначения.

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

Topics -> (список)

Имя темы Kafka.

(строка)

Queues -> (список)

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

(строка)

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 ваших брокеров Amazon MSK/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) При ошибке функции разделить группу на две части и повторить попытку. Значение по умолчанию - false.

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

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи после указанного количества попыток. Значение по умолчанию - -1, что устанавливает максимальное количество попыток в бесконечность. При максимальном количестве попыток в бесконечности 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 с указанным идентификатором группы потребителей вы не можете обновить это значение. Дополнительная информация см. в Customizable consumer group ID .

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

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

ConsumerGroupId -> (строка)

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

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

(Только Amazon SQS) Настройки масштабирования для источника событий. Дополнительная информация см. в Configuring maximum concurrency for Amazon SQS event sources .

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

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

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

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

DatabaseName -> (строка)

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

CollectionName -> (строка)

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

FullDocument -> (строка)

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

KMSKeyArn -> (строка)

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

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

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

ErrorCode -> (строка)

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

Message -> (строка)

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

EventSourceMappingArn -> (строка)

Amazon Resource Name (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