Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

list-work-groups

Описание

Выводит доступные группы работы для учетной записи.

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

Синтаксис

  list-work-groups
[--next-token <value>]
[--max-results <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]

Параметры

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

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

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

Максимальное количество групп работы, возвращаемых в этом запросе.

--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
  • таблица
  • 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для вывода групп работы

Следующий пример выводит группы работы в текущей учетной записи.

aws athena list-work-groups

Вывод:

{
    "WorkGroups": [
        {
            "Name": "Data_Analyst_Group",
            "State": "ENABLED",
            "Description": "",
            "CreationTime": 1578006683.016
        },
        {
            "Name": "AthenaAdmin",
            "State": "ENABLED",
            "Description": "",
            "CreationTime": 1573677174.105
        },
        {
            "Name": "primary",
            "State": "ENABLED",
            "Description": "",
            "CreationTime": 1567465222.723
        }
    ]
}

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

Вывод

WorkGroups -> (список)

Список объектов WorkGroupSummary, включающих имена, описания, времена создания и состояния каждой группы работы.

(структура)

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

Name -> (строка)

Имя группы работы.

State -> (строка)

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

Description -> (строка)

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

CreationTime -> (временная метка)

Дата и время создания группы работы.

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

Настройка версии движка для всех запросов в группе работы. Запросы в группе работы AmazonAthenaPreviewFunctionality выполняются на предварительном движке независимо от этой настройки.

SelectedEngineVersion -> (строка)

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

EffectiveEngineVersion -> (строка)

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

IdentityCenterApplicationArn -> (строка)

ARN приложения IAM Identity Center, включённого в группу работы.

NextToken -> (строка)

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

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

Spec-Zone.ru

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