[ aws . kinesis-video-archived-media ]
list-fragments
Описание
Возвращает список объектов Fragment из указанного потока и диапазона временных меток в архивированных данных.
Перечисление фрагментов имеет несинхронную согласованность. Это означает, что даже если производитель получит подтверждение о том, что фрагмент сохранён, результат запроса к ListFragments может не вернуться сразу. Однако результаты обычно доступны менее чем за секунду.
Примечание
Сначала необходимо вызвать APIGetDataEndpoint, чтобы получить конечную точку. Затем отправляйте запросы ListFragments к этой конечной точке, используя параметр –endpoint-url.Предупреждение
Если после вызова API Kinesis Video Streams archived media возникает ошибка, помимо кода HTTP-статуса и тела ответа, она включает в себя следующие сведения:
-
x-amz-ErrorTypeзаголовок HTTP — содержит более конкретный тип ошибки, помимо того, что предоставляет код HTTP-статуса. -
x-amz-RequestIdзаголовок HTTP — если вы хотите сообщить о проблеме в Amazon Web Services, команда поддержки сможет лучше диагностировать проблему, если получит идентификатор запроса.
И код HTTP-статуса, и заголовок ErrorType могут использоваться для принятия программных решений о том, можно ли повторить попытку при возникновении ошибок и в каких условиях, а также предоставить информацию о действиях, которые программист клиента может предпринять, чтобы успешно повторить попытку.
Дополнительную информацию см. в разделе Ошибки внизу этой темы, а также в разделе Общие ошибки.
См. также: Документацию API AWS
list-fragments — это постраничная операция. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: Fragments
Синтаксис
list-fragments
[--stream-name <value>]
[--stream-arn <value>]
[--fragment-selector <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]
Параметры
--stream-name (строка)
StreamARN.--stream-arn (строка)
StreamName.--fragment-selector (структура)
Описывает диапазон временных меток и источник временных меток для диапазона возвращаемых фрагментов.
Примечание
Это требуется только в том случае, еслиNextToken не передаётся в API.FragmentSelectorType -> (строка)
TimestampRange -> (структура)
Диапазон временных меток для возврата.
StartTimestamp -> (временная метка)
EndTimestamp -> (временная метка)
Сокращённый синтаксис:
FragmentSelectorType=string,TimestampRange={StartTimestamp=timestamp,EndTimestamp=timestamp}
Синтаксис JSON:
{
"FragmentSelectorType": "PRODUCER_TIMESTAMP"|"SERVER_TIMESTAMP",
"TimestampRange": {
"StartTimestamp": timestamp,
"EndTimestamp": timestamp
}
}
--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.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.
Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя 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
- текст
- таблица
- 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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Fragments -> (список)
Список объектов фрагментов архивированных данных из потока, которые соответствуют критериям селектора. Результаты не имеют определённого порядка, даже между страницами.
(структура)
Представляет сегмент видео или других данных с ограниченным по времени.
FragmentNumber -> (строка)
FragmentSizeInBytes -> (целое число)
ProducerTimestamp -> (временная метка)
ServerTimestamp -> (временная метка)
FragmentLengthInMilliseconds -> (целое число)
NextToken -> (строка)
null, когда больше результатов возвращать не нужно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.