Spec-Zone.ru › AWS CLI v2

[ aws . socialmessaging ]

get-whatsapp-message-media

Описание

Получение файла мультимедиа из сервиса WhatsApp. При успешном завершении файл мультимедиа извлекается из Meta и сохраняется в указанном ведре Amazon S3. Используйте либо destinationS3File, либо destinationS3PresignedUrl для назначения. Если оба варианта используются, возвращается ошибка InvalidParameterException.

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

Синтаксис

  get-whatsapp-message-media
--media-id <value>
--origination-phone-number-id <value>
[--metadata-only | --no-metadata-only]
[--destination-s3-presigned-url <value>]
[--destination-s3-file <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]

Параметры

--media-id (строка)

Уникальный идентификатор файла мультимедиа.

--origination-phone-number-id (строка)

Уникальный идентификатор исходного номера телефона для мультимедиа сообщения WhatsApp. Идентификаторы номеров телефонов форматируются как phone-number-id-01234567890123456789012345678901. Используйте GetLinkedWhatsAppBusinessAccount для поиска идентификатора номера телефона.

--metadata-only | --no-metadata-only (логическое значение)

Установите в True, чтобы получить только метаданные файла.

--destination-s3-presigned-url (структура)

Презаданная ссылка на файл мультимедиа.

url -> (строка)

Презаданная ссылка на объект.

headers -> (карта)

Карта заголовков и их значений. Вы должны указать заголовок Content-Type при использовании PostWhatsAppMessageMedia. Список общих заголовков см. в разделе Общие заголовки запроса в Справочнике по API Amazon S3

key -> (строка)

value -> (строка)

Краткая форма:

url=string,headers={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "url": "string",
  "headers": {"string": "string"
    ...}
}

--destination-s3-file (структура)

Название ведра и ключ объекта S3 файла мультимедиа.

bucketName -> (строка)

Название ведра.

key -> (строка)

Ключ объекта файла мультимедиа.

Краткая форма:

bucketName=string,key=string

Синтаксис JSON:

{
  "bucketName": "string",
  "key": "string"
}

--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
  • текст
  • таблица
  • 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.

Вывод

mimeType -> (строка)

Тип MIME мультимедиа.

fileSize -> (целое число с длинной точностью)

Размер файла мультимедиа в КБ.

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

Spec-Zone.ru

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