Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

start-session

Описание

Создаёт сеанс для выполнения вычислений в рамках рабочей группы. Сеанс готов, когда он достигает состояния IDLE.

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

Синтаксис

  start-session
[--description <value>]
--work-group <value>
--engine-configuration <value>
[--notebook-version <value>]
[--session-idle-timeout-in-minutes <value>]
[--client-request-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]

Параметры

--description (строка)

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

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

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

--engine-configuration (структура)

Содержит настройки конфигурации процессорных модулей (DPU) для обработки данных и сопоставления параметров.

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

Количество DPU для координатора. Координатор — это специальный исполнитель, который организует работу по обработке и управляет другими исполнителями в сеансе ноутбука. По умолчанию 1.

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

Максимальное количество DPU, которые могут работать одновременно.

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

Стандартное количество DPU для исполнителей. Исполнитель — это наименьшая единица вычислительной мощности, которую сеанс ноутбука может запросить у Athena. По умолчанию 1.

AdditionalConfigs -> (карта)

Содержит дополнительные сопоставления параметров MAP<string, string> движка ноутбука в формате пар ключ-значение. Чтобы указать ноутбук Athena, который сервер Jupyter загрузит и предоставит, укажите значение для поля StartSessionRequest$NotebookVersion, а затем добавьте ключ, названный NotebookId, к AdditionalConfigs со значением идентификатора ноутбука Athena.

key -> (строка)

value -> (строка)

SparkProperties -> (карта)

Указывает пользовательские JAR-файлы и свойства Spark для таких случаев, как шифрование кластеров, форматы таблиц и общее настройка Spark.

key -> (строка)

value -> (строка)

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

CoordinatorDpuSize=integer,MaxConcurrentDpus=integer,DefaultExecutorDpuSize=integer,AdditionalConfigs={KeyName1=string,KeyName2=string},SparkProperties={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "CoordinatorDpuSize": integer,
  "MaxConcurrentDpus": integer,
  "DefaultExecutorDpuSize": integer,
  "AdditionalConfigs": {"string": "string"
    ...},
  "SparkProperties": {"string": "string"
    ...}
}

--notebook-version (строка)

Версия ноутбука. Это значение автоматически предоставляется для сеансов ноутбуков в консоли Athena и не требуется для программного доступа к сеансам. Единственная допустимая версия ноутбука — Athena notebook version 1. Если вы укажете значение для NotebookVersion, вы также должны указать значение для NotebookId. См. EngineConfiguration$AdditionalConfigs.

--session-idle-timeout-in-minutes (целое число)

Таймаут бездействия в минутах для сеанса.

--client-request-token (строка)

Уникальная строка, чувствительная к регистру, используемая для обеспечения идемпотентности запроса на создание сеанса (выполняется только один раз). Если поступает другой StartSessionRequest, возвращается тот же ответ, и новый сеанс не создаётся. Если параметр изменился, возвращается ошибка.

Предупреждение

Это маркер указан как необязательный, потому что Amazon Web Services SDK (например, Amazon Web Services SDK для Java) автоматически генерирует его для пользователей. Если вы не используете Amazon Web Services SDK или Amazon Web Services CLI, вы должны предоставить этот маркер, иначе действие завершится ошибкой.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичным данным, 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.

Вывод

SessionId -> (строка)

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

State -> (строка)

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

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

CREATED — Сеанс запущен.

IDLE — Сеанс готов к приёму вычисления.

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

TERMINATING — Сеанс завершается.

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

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

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

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

Spec-Zone.ru

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