list-workforces
Описание
Используйте эту операцию для перечисления всех частных и сторонних рабочих сил в регионе Amazon Web Services. Обратите внимание, что в каждом регионе Amazon Web Services может быть только одна частная рабочая сила.
См. также: Документацию API AWS
list-workforces является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Workforces
Синтаксис
list-workforces
[--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 (строка)
Сортировка рабочих сил по имени рабочей силы или дате создания.
Возможные значения:
NameCreateDate
--sort-order (строка)
Сортировка рабочих сил по возрастанию или убыванию.
Возможные значения:
AscendingDescending
--name-contains (строка)
--cli-input-json | --cli-input-yaml (строка) Чтение аргументов из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перепишут значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания, где начать постраничный вывод. Это NextToken из предыдущего усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--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 (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификата корневого центра для проверки 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.
Вывод
Рабочие силы -> (список)
Список, содержащий информацию о вашей рабочей силе.
(структура)
Одна частная рабочая сила, которая автоматически создается при создании вашей первой частной команды. Вы можете создать одну частную рабочую силу в каждом регионе Amazon Web Services. По умолчанию любая операция API, связанная с рабочей силой, используемая в определенном регионе, будет применяться к рабочей силе, созданной в этом регионе. Чтобы узнать, как создать частную рабочую силу, см. Создать частную рабочую силу.
WorkforceName -> (строка)
WorkforceArn -> (строка)
LastUpdatedDate -> (метка времени)
SourceIpConfig -> (структура)
Список из одного до десяти диапазонов IP-адресов (CIDR) для добавления в список разрешенных значений рабочей силы. По умолчанию рабочая сила не ограничена определенными IP-адресами.
Cidrs -> (список)
Список из одного до десяти значений CIDR (Classless Inter-Domain Routing).
Максимум: десять значений CIDR
Примечание
Следующие ограничения длины применяются к отдельным значениям CIDR в списке значений CIDR.(строка)
SubDomain -> (строка)
CognitoConfig -> (структура)
Настройка рабочей силы Amazon Cognito. Одна рабочая сила Cognito создается с использованием и соответствует одному пулу пользователей Amazon Cognito.
UserPool -> (строка)
ClientId -> (строка)
OidcConfig -> (структура)
Настройка частной рабочей силы поставщика удостоверений OIDC (IdP).
ClientId -> (строка)
Issuer -> (строка)
AuthorizationEndpoint -> (строка)
TokenEndpoint -> (строка)
UserInfoEndpoint -> (строка)
LogoutEndpoint -> (строка)
JwksUri -> (строка)
Scope -> (строка)
AuthenticationRequestExtraParams -> (отображение)
Строка для отображения идентификаторов, специфичных для используемого пользовательского поставщика удостоверений (IdP).
ключ -> (строка)
значение -> (строка)
CreateDate -> (метка времени)
WorkforceVpcConfig -> (структура)
Настройка рабочей силы VPC.
VpcId -> (строка)
SecurityGroupIds -> (список)
Идентификаторы групп безопасности VPC в формате sg-xxxxxxxx. Группы безопасности должны быть для той же VPC, что и указано в подсети.
(строка)
Subnets -> (список)
Идентификатор подсетей в VPC, к которым вы хотите подключиться.
(строка)
VpcEndpointId -> (строка)
Status -> (строка)
FailureReason -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.