Spec-Zone.ru › AWS CLI v2

[ aws . lambda ]

удалить-отображение-источника-событий

Описание

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

При удалении отображения источника событий, оно переходит в состояние Deleting и может не быть полностью удалено в течение нескольких секунд.

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

Синтаксис

  delete-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 о использовании кавычек с строками.

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

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

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

Вывод:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569285870.271,
    "BatchSize": 5,
    "State": "Deleting",
    "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, очередь 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 ваших брокеров самонастраиваемого 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, что устанавливает максимальное количество попыток повтора в бесконечность. При бесконечном значении 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 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