Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

обновить-группу-работы

Описание

Обновляет группу работы с указанным именем. Имя группы работы изменить нельзя. Можно указать только ConfigurationUpdates.

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

Синтаксис

  update-work-group
--work-group <value>
[--description <value>]
[--configuration-updates <value>]
[--state <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 (строка)

Указывается группа работы, которую необходимо обновить.

--description (строка)

Описание группы работы.

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

Содержит конфигурационные обновления для группы работы Athena SQL.

EnforceWorkGroupConfiguration -> (булево)

Если установлено в «истина», настройки группы работы переопределяют клиентские настройки. Если установлено в «ложь», используются клиентские настройки. Дополнительные сведения см. в разделе Переопределение настроек группы работы клиентскими настройками.

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

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

OutputLocation -> (строка)

Расположение в Amazon S3, где хранятся результаты ваших запросов и расчетов, например, s3://path/to/query/bucket/ . Если настройки группы работы переопределяют клиентские настройки, запрос использует расположение для результатов запроса и конфигурацию шифрования, указанные для группы работы. Переопределение настроек группы работы указывается в EnforceWorkGroupConfiguration (истина/ложь) в WorkGroupConfiguration. См. WorkGroupConfiguration$EnforceWorkGroupConfiguration.

RemoveOutputLocation -> (булево)

Если установлено в «истина», это указывает, что ранее указанное расположение результатов запросов (также известное как клиентская настройка) для запросов в этой группе работы должно быть проигнорировано и установлено в значение null. Если установлено в «ложь» или не задано, и значение присутствует в OutputLocation в ResultConfigurationUpdates (клиентская настройка), OutputLocation в группе работы ResultConfiguration будет обновлено новым значением. Дополнительные сведения см. в разделе Переопределение настроек группы работы клиентскими настройками.

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

Конфигурация шифрования результатов запросов и расчетов.

EncryptionOption -> (строка)

Указывает, используется ли шифрование Amazon S3 на сервере с ключами, управляемыми Amazon S3 (SSE_S3), шифрование на сервере с ключами, управляемыми KMS (SSE_KMS), или клиентское шифрование с ключами, управляемыми KMS (CSE_KMS).

Если запрос выполняется в группе работы, и группа работы переопределяет клиентские настройки, то используется настройка шифрования группы работы. Она определяет, должны ли результаты запросов шифроваться для всех запросов, выполняемых в этой группе работы.

KmsKey -> (строка)

Для SSE_KMS и CSE_KMS это ARN или ID ключа KMS.

RemoveEncryptionConfiguration -> (булево)

Если установлено в «истина», это указывает, что ранее указанная конфигурация шифрования (также известная как клиентская настройка) для запросов в этой группе работы должна быть проигнорирована и установлена в значение null. Если установлено в «ложь» или не задано, и значение присутствует в EncryptionConfiguration в ResultConfigurationUpdates (клиентская настройка), EncryptionConfiguration в группе работы ResultConfiguration будет обновлено новым значением. Дополнительные сведения см. в разделе Переопределение настроек группы работы клиентскими настройками.

ExpectedBucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services, который вы ожидаете как владельца ведра Amazon S3, указанного в ResultConfiguration$OutputLocation. Если задано, Athena использует значение для ExpectedBucketOwner при выполнении вызовов Amazon S3 к вашему указанному расположению вывода. Если ExpectedBucketOwner идентификатор учетной записи Amazon Web Services не соответствует фактическому владельцу ведра Amazon S3, вызов завершается ошибкой с ошибкой разрешения.

Если настройки группы работы переопределяют клиентские настройки, запрос использует ExpectedBucketOwner настройку, указанную для группы работы, а также использует расположение для хранения результатов запросов, указанное в группе работы. См. WorkGroupConfiguration$EnforceWorkGroupConfiguration и Переопределение настроек группы работы клиентскими настройками.

RemoveExpectedBucketOwner -> (булево)

Если установлено в «истина», удаляет идентификатор учетной записи Amazon Web Services, ранее указанный для ResultConfiguration$ExpectedBucketOwner. Если установлено в «ложь» или не задано, и значение присутствует в ExpectedBucketOwner в ResultConfigurationUpdates (клиентская настройка), ExpectedBucketOwner в группе работы ResultConfiguration обновляется новым значением. Дополнительные сведения см. в разделе Переопределение настроек группы работы клиентскими настройками.

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

Конфигурация ACL для результатов запросов.

S3AclOption -> (строка)

Стандартная ACL Amazon S3, которую Athena должна указать при хранении результатов запросов, включая файлы данных, вставленные Athena в результате операторов, таких как CTAS или INSERT INTO. В настоящее время поддерживается только стандартная ACL BUCKET_OWNER_FULL_CONTROL. Если запрос выполняется в группе работы, и группа работы переопределяет клиентские настройки, то стандартная ACL Amazon S3, указанная в настройках группы работы, используется для всех запросов, выполняемых в группе работы. Дополнительные сведения о стандартных ACL Amazon S3 см. в разделе Canned ACL в руководстве пользователя Amazon S3.

RemoveAclConfiguration -> (булево)

Если установлено в true, указывает, что ранее указанная конфигурация ACL для запросов в этой группе работы должна быть проигнорирована и установлена в значение null. Если установлено в false или не задано, и значение присутствует в AclConfiguration в ResultConfigurationUpdates, AclConfiguration в группе работы ResultConfiguration обновляется новым значением. Дополнительные сведения см. в разделе Переопределение настроек группы работы клиентскими настройками.

PublishCloudWatchMetricsEnabled -> (булево)

Указывает, включено ли в этой группе работы публикование метрик в Amazon CloudWatch.

BytesScannedCutoffPerQuery -> (длинное целое число)

Верхний предел (порог) для объема байтов, которые может сканировать один запрос в группе работы.

RemoveBytesScannedCutoffPerQuery -> (булево)

Указывает, что предел использования данных на запрос удален. WorkGroupConfiguration$BytesScannedCutoffPerQuery

RequesterPaysEnabled -> (булево)

Если установлено в true, позволяет членам, назначенным в группу работы, указывать ведра Amazon S3 Requester Pays в запросах. Если установлено в false, члены группы работы не могут запрашивать данные из ведер Requester Pays, и запросы, которые извлекают данные из ведер Requester Pays, вызывают ошибку. По умолчанию установлено в false. Дополнительные сведения о ведрах Requester Pays см. в разделе Ведра Requester Pays в руководстве разработчика Amazon Simple Storage Service.

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

Версия движка, запрошенная при обновлении группы работы. После обновления все запросы в группе работы выполняются с запрошенной версией движка. Если ранее значение не было задано, по умолчанию используется Авто. Запросы в группе работы AmazonAthenaPreviewFunctionality выполняются в предварительной версии движка независимо от этого параметра.

SelectedEngineVersion -> (строка)

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

EffectiveEngineVersion -> (строка)

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

RemoveCustomerContentEncryptionConfiguration -> (булево)

Удаляет конфигурацию шифрования содержимого из группы работы Athena, поддерживающей Apache Spark.

AdditionalConfiguration -> (строка)

Содержит строку, определенную пользователем, в формате JSON, для группы работы, поддерживающей Spark.

ExecutionRole -> (строка)

ARN роли выполнения, используемой для доступа к ресурсам пользователя для сессий Spark и групп работы с включенной функцией Identity Center. Этот параметр применяется только к группам работы, поддерживающим Spark, и группам работы с включенной функцией Identity Center.

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

Указывает управляемый пользователем ключ KMS, используемый для шифрования хранилищ данных пользователя в Athena. При использовании управляемого Amazon Web Services ключа это значение равно null. Этот параметр не применяется к группам работы Athena SQL.

KmsKey -> (строка)

Управляемый пользователем ключ KMS, используемый для шифрования хранилищ данных пользователя в Athena.

EnableMinimumEncryptionConfiguration -> (булево)

Требует минимальный уровень шифрования для группы работы для результатов запросов и расчетов, которые записываются в Amazon S3. При включении пользователи группы работы могут устанавливать шифрование только до минимального уровня, заданного администратором, или выше, при отправке запросов. Этот параметр не применяется к группам работы, поддерживающим Spark.

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

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

Указывает, включены ли для результатов запросов предоставления доступа Amazon S3.

EnableS3AccessGrants -> (булево)

Указывает, включены ли для результатов запросов предоставления доступа Amazon S3.

CreateUserLevelPrefix -> (булево)

При включении добавляет идентификатор пользователя в качестве префикса пути Amazon S3 к расположению вывода результатов запроса.

AuthenticationType -> (строка)

Тип аутентификации, используемый для предоставления доступа Amazon S3. В настоящее время поддерживается только DIRECTORY_IDENTITY.

Укороченный синтаксис:

EnforceWorkGroupConfiguration=boolean,ResultConfigurationUpdates={OutputLocation=string,RemoveOutputLocation=boolean,EncryptionConfiguration={EncryptionOption=string,KmsKey=string},RemoveEncryptionConfiguration=boolean,ExpectedBucketOwner=string,RemoveExpectedBucketOwner=boolean,AclConfiguration={S3AclOption=string},RemoveAclConfiguration=boolean},PublishCloudWatchMetricsEnabled=boolean,BytesScannedCutoffPerQuery=long,RemoveBytesScannedCutoffPerQuery=boolean,RequesterPaysEnabled=boolean,EngineVersion={SelectedEngineVersion=string,EffectiveEngineVersion=string},RemoveCustomerContentEncryptionConfiguration=boolean,AdditionalConfiguration=string,ExecutionRole=string,CustomerContentEncryptionConfiguration={KmsKey=string},EnableMinimumEncryptionConfiguration=boolean,QueryResultsS3AccessGrantsConfiguration={EnableS3AccessGrants=boolean,CreateUserLevelPrefix=boolean,AuthenticationType=string}

Синтаксис JSON:

{
  "EnforceWorkGroupConfiguration": true|false,
  "ResultConfigurationUpdates": {
    "OutputLocation": "string",
    "RemoveOutputLocation": true|false,
    "EncryptionConfiguration": {
      "EncryptionOption": "SSE_S3"|"SSE_KMS"|"CSE_KMS",
      "KmsKey": "string"
    },
    "RemoveEncryptionConfiguration": true|false,
    "ExpectedBucketOwner": "string",
    "RemoveExpectedBucketOwner": true|false,
    "AclConfiguration": {
      "S3AclOption": "BUCKET_OWNER_FULL_CONTROL"
    },
    "RemoveAclConfiguration": true|false
  },
  "PublishCloudWatchMetricsEnabled": true|false,
  "BytesScannedCutoffPerQuery": long,
  "RemoveBytesScannedCutoffPerQuery": true|false,
  "RequesterPaysEnabled": true|false,
  "EngineVersion": {
    "SelectedEngineVersion": "string",
    "EffectiveEngineVersion": "string"
  },
  "RemoveCustomerContentEncryptionConfiguration": true|false,
  "AdditionalConfiguration": "string",
  "ExecutionRole": "string",
  "CustomerContentEncryptionConfiguration": {
    "KmsKey": "string"
  },
  "EnableMinimumEncryptionConfiguration": true|false,
  "QueryResultsS3AccessGrantsConfiguration": {
    "EnableS3AccessGrants": true|false,
    "CreateUserLevelPrefix": true|false,
    "AuthenticationType": "DIRECTORY_IDENTITY"
  }
}

--state (строка)

Состояние группы работы, которое будет обновлено для данной группы работы.

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

  • ENABLED
  • DISABLED

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

Для обновления рабочей группы

Следующий пример update-work-group отключает рабочую группу Data_Analyst_Group. Пользователи не могут запускать или создавать запросы в отключенной рабочей группе, но по-прежнему могут просматривать метрики, ограничения использования данных, настройки рабочей группы, историю запросов и сохраненные запросы.

aws athena update-work-group \
    --work-group Data_Analyst_Group \
    --state DISABLED

Эта команда не выводит ничего. Чтобы проверить изменение состояния, используйте aws athena get-work-group --work-group Data_Analyst_Group и проверьте свойство State в выводе.

Дополнительная информация доступна в руководстве Amazon Athena User Guide по управлению рабочими группами.

Вывод

Нет

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

Spec-Zone.ru

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