list-workteams
Описание
Получает список частных рабочих команд, которые вы определили в регионе. Список может быть пустым, если ни одна рабочая команда не соответствует фильтру, указанному в параметре NameContains.
См. также: Документацию API AWS
list-workteams — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: Workteams
Синтаксис
list-workteams
[--sort-by <value>]
[--sort-order <value>]
[--name-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--sort-by (строка)
Поле для сортировки результатов. По умолчанию — CreationTime.
Возможные значения:
NameCreateDate
--sort-order (строка)
Порядок сортировки результатов. По умолчанию — Ascending.
Возможные значения:
AscendingDescending
--name-contains (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания места начала постраничной выдачи. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.
--max-items (целое число)
Общее количество элементов для возврата в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, в выходных данных команды предоставляется NextToken. Для возобновления постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Рабочие группы -> (список)
Массив объектов Workteam, каждый описывающий рабочую группу.
(структура)
Предоставляет подробности о рабочей группе для маркировки.
ИмяРабочейГруппы -> (строка)
ОпределенияУчастников -> (список)
Список объектов MemberDefinition, содержащих объекты, идентифицирующие работников, составляющих рабочую группу.
Рабочие группы могут быть созданы с использованием Amazon Cognito или вашего собственного поставщика удостоверений (IdP) OIDC. Для частных рабочих групп, созданных с использованием Amazon Cognito, используйте CognitoMemberDefinition . Для рабочих групп, созданных с использованием вашего собственного поставщика удостоверений OIDC (IdP), используйте OidcMemberDefinition .
(структура)
Определяет группу пользователей Amazon Cognito или вашего собственного IdP OIDC, которая является частью рабочей группы.
CognitoMemberDefinition -> (структура)
Группа пользователей Amazon Cognito, которая является частью рабочей группы.
UserPool -> (строка)
UserGroup -> (строка)
ClientId -> (строка)
OidcMemberDefinition -> (структура)
Список групп пользователей, которые существуют в вашем поставщике удостоверений OIDC (IdP). Для создания одной частной рабочей группы можно использовать от одного до десяти групп. При добавлении группы пользователей в список Groups, вы можете добавить эту группу пользователей к одной или нескольким частным рабочим группам. Если вы добавите группу пользователей в частную рабочую группу, все работники в этой группе пользователей будут добавлены в рабочую группу.
Groups -> (список)
Список строк, разделенных запятыми, которые идентифицируют группы пользователей в вашем IdP OIDC. Каждая группа пользователей состоит из группы частных работников.
(строка)
WorkteamArn -> (строка)
WorkforceArn -> (строка)
ProductListingIds -> (список)
Идентификатор Amazon Marketplace для рабочей группы поставщика.
(строка)
Описание -> (строка)
Поддомен -> (строка)
ДатаСоздания -> (отметка времени)
ДатаПоследнегоОбновления -> (отметка времени)
NotificationConfiguration -> (структура)
Настройка уведомлений SNS о доступных или истекающих элементах работы для рабочих групп.
NotificationTopicArn -> (строка)
WorkerAccessConfiguration -> (структура)
Описание любых ограничений доступа, определенных для ресурсов Amazon S3.
S3Presign -> (структура)
Определяет любые ограничения ресурсов Amazon S3.
IamPolicyConstraints -> (структура)
Используйте этот параметр для указания разрешенного источника запроса. Возможные источники — SourceIp или VpcSourceIp .
SourceIp -> (строка)
SourceIp является Enabled , адрес IP работника при отображении задания в портале работника добавляется в политику IAM в качестве Condition , используемой для генерации предварительно подписанной ссылки Amazon S3. Этот адрес IP проверяется Amazon S3 и должен совпадать, чтобы ресурс Amazon S3 был отображен в портале работника.VpcSourceIp -> (строка)
VpcSourceIp является Enabled , адрес IP работника при отображении задания в частном портале работника внутри VPC добавляется в политику IAM в качестве Condition , используемой для генерации предварительно подписанной ссылки Amazon S3. Для успешного отображения задания Amazon S3 проверяет, что к предварительно подписанной ссылке обращаются через Amazon S3 VPC Endpoint и что адрес IP работника соответствует адресу IP в политике IAM. Чтобы узнать больше о настройке частного портала работника, см. Использование режима Amazon VPC из частного портала работника.NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.