Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

list-sessions

Описание

Выводит список сессий в рабочей группе, которые находятся в активном состоянии, таком как CREATING , CREATED , IDLE или BUSY. Более новые сессии отображаются первыми, более старые — позже.

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

Синтаксис

  list-sessions
--work-group <value>
[--state-filter <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--work-group (строка)

Рабочая группа, к которой принадлежит сессия.

--state-filter (строка)

Фильтр для конкретного состояния сессии. Ниже приведено описание каждого состояния.

CREATING — сессия запускается, включая получение ресурсов.

CREATED — сессия запущена.

IDLE — сессия может принять вычисление.

BUSY — сессия обрабатывает другую задачу и не может принять вычисление.

TERMINATING — сессия закрывается.

TERMINATED — сессия и ее ресурсы больше не работают.

DEGRADED — сессия не имеет здоровых координаторов.

FAILED — из-за ошибки сессия и ее ресурсы больше не работают.

Возможные значения:

  • CREATING
  • CREATED
  • IDLE
  • BUSY
  • TERMINATING
  • TERMINATED
  • DEGRADED
  • FAILED

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

Максимальное количество сессий для возврата.

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

Токен, сгенерированный службой Athena, который указывает, где продолжить постраничную навигацию, если предыдущий запрос был усечен. Чтобы получить следующий набор страниц, передайте NextToken из объекта ответа предыдущей страницы.

--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
  • 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 для ввода.

Вывод

NextToken -> (строка)

Токен, сгенерированный службой Athena, который указывает, где продолжить постраничную навигацию, если предыдущий запрос был усечен. Чтобы получить следующий набор страниц, передайте NextToken из объекта ответа предыдущей страницы.

Sessions -> (список)

Список сессий.

(структура)

Содержит сводную информацию о сессии.

SessionId -> (строка)

Идентификатор сессии.

Description -> (строка)

Описание сессии.

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

Версия движка, используемая сессией (например, PySpark engine version 3).

SelectedEngineVersion -> (строка)

Версия движка, запрошенная пользователем. Возможные значения определяются выводом ListEngineVersions, включая AUTO. По умолчанию AUTO.

EffectiveEngineVersion -> (строка)

Только для чтения. Версия движка, на которой выполняется запрос. Если пользователь запрашивает действительную версию движка, отличную от Auto, эффективная версия движка совпадает с запрошенной пользователем версией. Если пользователь запрашивает Auto, эффективная версия движка выбирается Athena. При запросе обновления версии движка с помощью операции CreateWorkGroup или UpdateWorkGroup поле EffectiveEngineVersion игнорируется.

NotebookVersion -> (строка)

Версия блокнота.

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

Содержит информацию о состоянии сессии.

StartDateTime -> (метка времени)

Дата и время начала сессии.

LastModifiedDateTime -> (метка времени)

Самая последняя дата и время изменения сессии.

EndDateTime -> (метка времени)

Дата и время окончания сессии.

IdleSinceDateTime -> (метка времени)

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

State -> (строка)

Состояние сессии. Ниже приведено описание каждого состояния.

CREATING — сессия запускается, включая получение ресурсов.

CREATED — сессия запущена.

IDLE — сессия может принять вычисление.

BUSY — сессия обрабатывает другую задачу и не может принять вычисление.

TERMINATING — сессия закрывается.

TERMINATED — сессия и ее ресурсы больше не работают.

DEGRADED — сессия не имеет здоровых координаторов.

FAILED — из-за ошибки сессия и ее ресурсы больше не работают.

StateChangeReason -> (строка)

Причина изменения состояния сессии (например, отменена, потому что сессия была завершена).

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

Spec-Zone.ru

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