update-workforce
Описание
Используйте эту операцию для обновления вашей рабочей силы. Вы можете использовать эту операцию для требования, чтобы рабочие использовали определённые IP-адреса для работы над задачами и для обновления конфигурации поставщика удостоверений OpenID Connect (OIDC) для рабочей силы.
Портал для работников теперь поддерживается в VPC и в общедоступном интернете.
Используйте SourceIpConfig для ограничения доступа рабочих к задачам определённому диапазону IP-адресов. Вы указываете разрешённые IP-адреса, создавая список до десяти CIDR-диапазонов. По умолчанию рабочая сила не ограничена определёнными IP-адресами. Если вы указываете диапазон IP-адресов, рабочие, которые пытаются получить доступ к задачам с помощью любого IP-адреса вне указанного диапазона, получают отказ и получают сообщение об ошибке Not Found на портале для работников.
Чтобы ограничить доступ для всех рабочих в общедоступном интернете, добавьте значение SourceIpConfig CIDR как “10.0.0.0/16”.
Предупреждение
Amazon SageMaker не поддерживает ограничение по источнику IP для порталов работников в VPC.Используйте OidcConfig для обновления конфигурации рабочей силы, созданной с использованием собственного поставщика удостоверений OIDC.
Предупреждение
Вы можете обновить конфигурацию своего поставщика OIDC только в том случае, если с вашей рабочей силой не связаны никакие рабочие команды. Вы можете удалить рабочие команды с помощью операции DeleteWorkteam.После ограничения доступа к диапазону IP-адресов или обновления конфигурации своего поставщика OIDC с помощью этой операции вы можете просмотреть подробности о своей обновлённой рабочей силе с помощью операции DescribeWorkforce.
Предупреждение
Эта операция применяется только к частным рабочим силам.См. также: Документация API AWS
Синопсис
update-workforce
--workforce-name <value>
[--source-ip-config <value>]
[--oidc-config <value>]
[--workforce-vpc-config <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]
Параметры
--workforce-name (строка)
--source-ip-config (структура)
Список от одного до десяти диапазонов IP-адресов работников (CIDR), которые могут использоваться для доступа к задачам, назначенным этой рабочей силе.
Максимум: Десять значений CIDR
Cidrs -> (список)
Список от одного до десяти значений Classless Inter-Domain Routing (CIDR).
Максимум: Десять значений CIDR
Примечание
Следующие ограничения длины применяются к отдельным значениям CIDR в списке значений CIDR.(строка)
Сокращённый синтаксис:
Cidrs=string,string
Синтаксис JSON:
{
"Cidrs": ["string", ...]
}
--oidc-config (структура)
Используйте этот параметр для обновления конфигурации своего поставщика удостоверений OpenID Connect (OIDC) для рабочей силы, созданной с использованием вашего собственного поставщика удостоверений.
ClientId -> (строка)
ClientSecret -> (строка)
Issuer -> (строка)
AuthorizationEndpoint -> (строка)
TokenEndpoint -> (строка)
UserInfoEndpoint -> (строка)
LogoutEndpoint -> (строка)
JwksUri -> (строка)
Scope -> (строка)
AuthenticationRequestExtraParams -> (массив)
Строка-строковый массив идентификаторов, специфичных для используемого пользовательского поставщика удостоверений (IdP).
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
ClientId=string,ClientSecret=string,Issuer=string,AuthorizationEndpoint=string,TokenEndpoint=string,UserInfoEndpoint=string,LogoutEndpoint=string,JwksUri=string,Scope=string,AuthenticationRequestExtraParams={KeyName1=string,KeyName2=string}
Синтаксис JSON:
{
"ClientId": "string",
"ClientSecret": "string",
"Issuer": "string",
"AuthorizationEndpoint": "string",
"TokenEndpoint": "string",
"UserInfoEndpoint": "string",
"LogoutEndpoint": "string",
"JwksUri": "string",
"Scope": "string",
"AuthenticationRequestExtraParams": {"string": "string"
...}
}
--workforce-vpc-config (структура)
Используйте этот параметр для обновления вашей конфигурации VPC для рабочей силы.
VpcId -> (строка)
SecurityGroupIds -> (список)
Идентификаторы групп безопасности VPC в формате sg-xxxxxxxx. Группы безопасности должны быть для той же VPC, что и подсети.
(строка)
Subnets -> (список)
Идентификатор подсетей в VPC, которые вы хотите подключить.
(строка)
Сокращённый синтаксис:
VpcId=string,SecurityGroupIds=string,string,Subnets=string,string
Синтаксис JSON:
{
"VpcId": "string",
"SecurityGroupIds": ["string", ...],
"Subnets": ["string", ...]
}
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Рабочая сила -> (структура)
Одна частная рабочая сила. Вы можете создать одну частную рабочую силу в каждом регионе Amazon Web Services. По умолчанию любая операция API, связанная с рабочей силой, используемая в конкретном регионе, будет применяться к рабочей силе, созданной в этом регионе. Чтобы узнать, как создать частную рабочую силу, см. Создать частную рабочую силу.
Имя рабочей силы -> (строка)
Arn рабочей силы -> (строка)
Дата последнего обновления -> (отметка времени)
Настройка IP-источника -> (структура)
Список от одного до десяти диапазонов IP-адресов (CIDR), которые нужно добавить в список разрешенных IP-адресов для рабочей силы. По умолчанию рабочая сила не ограничена конкретными IP-адресами.
Cidrs -> (список)
Список от одного до десяти значений CIDR (Classless Inter-Domain Routing).
Максимум: Десять значений CIDR
Примечание
Следующие ограничения длины применяются к отдельным значениям CIDR в списке значений CIDR.(строка)
Поддомен -> (строка)
Настройка Cognito -> (структура)
Настройка рабочей силы Amazon Cognito. Одна рабочая сила Cognito создается с помощью и соответствует одному пользователю Amazon Cognito.
Пользовательский пул -> (строка)
Идентификатор клиента -> (строка)
Настройка Oidc -> (структура)
Настройка частной рабочей силы с поставщиком идентификации OIDC (IdP).
Идентификатор клиента -> (строка)
Издатель -> (строка)
Конечная точка авторизации -> (строка)
Конечная точка получения токенов -> (строка)
Конечная точка информации о пользователе -> (строка)
Конечная точка выхода -> (строка)
JwksUri -> (строка)
Диапазон -> (строка)
Дополнительные параметры запроса аутентификации -> (карта)
Строка-строковая карта идентификаторов, специфичных для используемого пользовательского поставщика (IdP).
ключ -> (строка)
значение -> (строка)
Дата создания -> (отметка времени)
Настройка рабочей силы VPC -> (структура)
Настройка рабочей силы VPC.
VpcId -> (строка)
SecurityGroupIds -> (список)
Идентификаторы групп безопасности VPC в формате sg-xxxxxxxx. Группы безопасности должны быть для той же VPC, что и указано в подсети.
(строка)
Подсети -> (список)
Идентификатор подсетей в VPC, которые вы хотите подключить.
(строка)
VpcEndpointId -> (строка)
Статус -> (строка)
Причина ошибки -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.