Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

start-calculation-execution

Описание

Отправляет вычисления на выполнение в рамках сессии. Вы можете указать код для выполнения как блок кода внутри запроса.

Примечание

Синтаксис запроса требует параметра StartCalculationExecutionRequest$CodeBlock или CalculationConfiguration$CodeBlock, но не обоих. Поскольку CalculationConfiguration$CodeBlock устарел, используйте параметр StartCalculationExecutionRequest$CodeBlock вместо него.

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

Синтаксис

  start-calculation-execution
--session-id <value>
[--description <value>]
[--calculation-configuration <value>]
[--code-block <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]

Параметры

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

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

--description (строка)

Описание вычисления.

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

Содержит конфигурационную информацию для вычисления.

CodeBlock -> (строка)

Строка, содержащая код вычисления.

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

CodeBlock=string

Синтаксис JSON:

{
  "CodeBlock": "string"
}

--code-block (строка)

Строка, содержащая код вычисления. Используйте этот параметр вместо CalculationConfiguration$CodeBlock, который устарел.

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

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

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

Этот токен указан как необязательный, потому что SDK Amazon Web Services (например, 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
  • 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.

Вывод

CalculationExecutionId -> (строка)

UUID выполнения вычисления.

State -> (строка)

CREATING - Вычисление находится в процессе создания.

CREATED - Вычисление создано и готово к запуску.

QUEUED - Вычисление помещено в очередь для обработки.

RUNNING - Вычисление выполняется.

CANCELING - Получен запрос на отмену вычисления, и система работает над его остановкой.

CANCELED - Вычисление больше не выполняется в результате запроса на отмену.

COMPLETED - Вычисление завершено без ошибок.

FAILED - Вычисление завершилось с ошибкой и больше не выполняется.

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

Spec-Zone.ru

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