Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

batch-execute-statement

Описание

Выполняет одну или несколько SQL-команд, которые могут быть командами языка манипулирования данными (DML) или командами языка определения данных (DDL). В зависимости от метода авторизации используйте одну из следующих комбинаций параметров запроса:

  • Secrets Manager — при подключении к кластеру предоставьте secret-arn секрета, хранящегося в Secrets Manager, который содержит username и password. Указанный секрет содержит учетные данные для подключения к database, который вы указываете. При подключении к кластеру вы также предоставляете имя базы данных. Если вы предоставляете идентификатор кластера (dbClusterIdentifier), он должен соответствовать идентификатору кластера, хранящемуся в секрете. При подключении к серверной группе без выделенных ресурсов вы также предоставляете имя базы данных.
  • Временные учетные данные — при подключении к хранилищу данных выберите один из следующих вариантов:
    • При подключении к серверной группе без выделенных ресурсов укажите имя группы и имя базы данных. Имя пользователя базы данных извлекается из идентификатора IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift-serverless:GetCredentials.
    • При подключении к кластеру как идентификатор IAM укажите идентификатор кластера и имя базы данных. Имя пользователя базы данных извлекается из идентификатора IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift:GetClusterCredentialsWithIAM.
    • При подключении к кластеру как пользователю базы данных укажите идентификатор кластера, имя базы данных и имя пользователя базы данных. Также требуется разрешение на вызов операции redshift:GetClusterCredentials.

Дополнительную информацию об API Amazon Redshift Data и примерах использования командной строки см. в руководстве Amazon Redshift Management Guide в разделе «Использование API Amazon Redshift Data».

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

Синтаксис

  batch-execute-statement
[--client-token <value>]
[--cluster-identifier <value>]
[--database <value>]
[--db-user <value>]
[--result-format <value>]
[--secret-arn <value>]
[--session-id <value>]
[--session-keep-alive-seconds <value>]
--sqls <value>
[--statement-name <value>]
[--with-event | --no-with-event]
[--workgroup-name <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]

Параметры

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

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

--cluster-identifier (строка)

Идентификатор кластера. Этот параметр требуется при подключении к кластеру и аутентификации с помощью Secrets Manager или временных учетных данных.

--database (строка)

Имя базы данных. Этот параметр требуется при аутентификации с помощью Secrets Manager или временных учетных данных.

--db-user (строка)

Имя пользователя базы данных. Этот параметр требуется при подключении к кластеру как пользователю базы данных и аутентификации с помощью временных учетных данных.

--result-format (строка)

Формат данных результата SQL-команды. Если формат не указан, используется по умолчанию — JSON.

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

  • JSON
  • CSV

--secret-arn (строка)

Имя или ARN секрета, обеспечивающего доступ к базе данных. Этот параметр требуется при аутентификации с помощью Secrets Manager.

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

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

--session-keep-alive-seconds (целое число)

Количество секунд для поддержания активности сеанса после завершения запроса. Максимальное время поддержания активности сеанса — 24 часа. По истечении 24 часов сеанс принудительно закрывается, и запрос прерывается.

--sqls (список)

Одна или несколько SQL-команд для выполнения. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>

(строка)

Синтаксис:

"string" "string" ...

--statement-name (строка)

Имя SQL-команд. Вы можете присвоить имена SQL-командам при их создании для идентификации запроса.

--with-event | --no-with-event (булево)

Значение, указывающее, следует ли отправлять событие в Amazon EventBridge event bus после выполнения SQL-команд.

--workgroup-name (строка)

Имя или Amazon Resource Name (ARN) группы без выделенных ресурсов. Этот параметр требуется при подключении к группе без выделенных ресурсов и аутентификации с помощью Secrets Manager или временных учетных данных.

--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 (булево)

Отключить тулбар AWS CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров входных данных CLI.

Вывод

ClusterIdentifier -> (строка)

Идентификатор кластера. Этот элемент не возвращается при подключении к группе без выделенных ресурсов.

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

Дата и время (UTC) создания запроса.

Database -> (строка)

Имя базы данных.

DbGroups -> (список)

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

(строка)

DbUser -> (строка)

Имя пользователя базы данных.

Id -> (строка)

Идентификатор SQL-запроса, результаты которого необходимо получить. Это значение — универсально уникальный идентификатор (UUID), сгенерированный API Amazon Redshift Data. Этот идентификатор возвращается BatchExecuteStatment.

SecretArn -> (строка)

Имя или ARN секрета, обеспечивающего доступ к базе данных.

SessionId -> (строка)

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

WorkgroupName -> (строка)

Имя или Amazon Resource Name (ARN) группы без выделенных ресурсов. Этот элемент не возвращается при подключении к выделенному кластеру.

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

Spec-Zone.ru

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