Spec-Zone.ru › AWS CLI v2

[ aws . ivs ]

блокировка-сеансов-просмотра-партИй

Описание

Выполняет StartViewerSessionRevocation для нескольких пар ARN канала и ID зрителя одновременно.

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

Синтаксис

  batch-start-viewer-session-revocation
--viewer-sessions <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]

Параметры

--viewer-sessions (список)

Массив сеансов просмотра, по одной паре ARN канала и ID зрителя.

(структура)

Сеанс просмотра, который нужно заблокировать при вызове BatchStartViewerSessionRevocation.

channelArn -> (строка)

ARN канала, связанного с сеансом просмотра, который нужно заблокировать.

viewerId -> (строка)

ID зрителя, связанного с сеансом просмотра, который нужно заблокировать. Не используйте этот параметр для идентификации физического лица, конфиденциальной или чувствительной информации.

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

Необязательный фильтр для выбора версий сеанса просмотра, которые нужно заблокировать. Все версии, меньшие или равные заданной версии, будут заблокированы. По умолчанию: 0.

Сокращённый синтаксис:

channelArn=string,viewerId=string,viewerSessionVersionsLessThanOrEqualTo=integer ...

Синтаксис JSON:

[
  {
    "channelArn": "string",
    "viewerId": "string",
    "viewerSessionVersionsLessThanOrEqualTo": integer
  }
  ...
]

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

Для блокировки сеансов просмотра для нескольких пар ARN канала и ID зрителя

Следующий batch-start-viewer-session-revocation пример выполняет блокировку сеансов просмотра для нескольких пар ARN канала и ID зрителя одновременно. Запрос может завершиться успешно, но значения в поле errors будут возвращены, если у вызывающего процесса нет разрешения на блокировку указанного сеанса.

aws ivs batch-start-viewer-session-revocation \
    --viewer-sessions '[{"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1","viewerId":"abcdefg1","viewerSessionVersionsLessThanOrEqualTo":1234567890}, \
      {"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2","viewerId":"abcdefg2","viewerSessionVersionsLessThanOrEqualTo":1234567890}]'

Вывод:

{
    "errors": [
        {
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1",
            "viewerId": "abcdefg1",
            "code": "403",
            "message": "not authorized",
        },
        {
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2",
            "viewerId": "abcdefg2",
            "code": "403",
            "message": "not authorized",
        }
    ]
}

Дополнительную информацию см. в разделе Настройка частных каналов в Руководстве пользователя Amazon Interactive Video Service.

Вывод

errors -> (список)

Каждый объект ошибки связан с определенной channelArn и viewerId парой в запросе.

(структура)

Ошибка для запроса в пачке для BatchStartViewerSessionRevocation. Каждая ошибка связана с определённой парой ARN канала и ID зрителя.

channelArn -> (строка)

ARN канала.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, определенное приложением.

viewerId -> (строка)

ID сеанса просмотра для блокировки.

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

Spec-Zone.ru

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