обновить-группу-рабочих
Описание
Обновляет существующую группу рабочих новыми определениями участников или описанием.
См. также: Документацию API AWS
Синтаксис
update-workteam
--workteam-name <value>
[--member-definitions <value>]
[--description <value>]
[--notification-configuration <value>]
[--worker-access-configuration <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]
Параметры
--workteam-name (строка)
--member-definitions (список)
Список объектов MemberDefinition, содержащих объекты, определяющие работников, составляющих группу рабочих.
Рабочие группы могут быть созданы с использованием Amazon Cognito или вашего собственного поставщика идентификации OIDC (IdP). Для частных рабочих групп, созданных с использованием Amazon Cognito, используйте CognitoMemberDefinition. Для рабочих групп, созданных с использованием собственного поставщика идентификации OIDC (IdP), используйте OidcMemberDefinition. Вы не должны предоставлять входные данные для обоих этих параметров в одном запросе.
Для рабочих групп, созданных с использованием Amazon Cognito, частные группы рабочих соответствуют группам пользователей Amazon Cognito в пользовательском пуле, используемом для создания рабочей группы. Все объекты CognitoMemberDefinition, составляющие определение участника, должны иметь одинаковые значения ClientId и UserPool. Чтобы добавить группу пользователей Amazon Cognito в существующий пул рабочих, см. Добавление групп в пользовательский пул. Дополнительную информацию о пользовательских пулах см. в разделе `Пользовательские пулы Amazon Cognito`.
Для рабочих групп, созданных с использованием собственного поставщика OIDC IdP, укажите группы пользователей, которые вы хотите включить в свою частную группу рабочих в OidcMemberDefinition, перечислив эти группы в Groups. Имейте в виду, что группы пользователей, которые уже находятся в группе рабочих, также должны быть перечислены в Groups при выполнении этого запроса, чтобы остаться в группе рабочих. Если вы не включите эти группы пользователей, они больше не будут связаны с обновляемой вами группой рабочих.
(структура)
Определяет группу пользователей Amazon Cognito или собственную группу пользователей OIDC IdP, которая является частью группы рабочих.
CognitoMemberDefinition -> (структура)
Группа пользователей Amazon Cognito, которая является частью группы рабочих.
UserPool -> (строка)
UserGroup -> (строка)
ClientId -> (строка)
OidcMemberDefinition -> (структура)
Список групп пользователей, существующих в вашем поставщике идентификации OIDC (IdP). Для создания одной частной группы рабочих можно использовать от одного до десяти групп. При добавлении группы пользователей в список Groups вы можете добавить эту группу пользователей к одной или нескольким частным группам рабочих. Если вы добавите группу пользователей в частную группу рабочих, все работники в этой группе пользователей будут добавлены в группу рабочих.
Groups -> (список)
Список строк, разделенных запятыми, определяющих группы пользователей в вашем поставщике идентификации OIDC IdP. Каждая группа пользователей состоит из группы частных работников.
(строка)
Сокращенный синтаксис:
CognitoMemberDefinition={UserPool=string,UserGroup=string,ClientId=string},OidcMemberDefinition={Groups=[string,string]} ...
Синтаксис JSON:
[
{
"CognitoMemberDefinition": {
"UserPool": "string",
"UserGroup": "string",
"ClientId": "string"
},
"OidcMemberDefinition": {
"Groups": ["string", ...]
}
}
...
]
--description (строка)
--notification-configuration (структура)
Настраивает уведомления темы SNS для доступных или истекающих рабочих элементов
NotificationTopicArn -> (строка)
Сокращенный синтаксис:
NotificationTopicArn=string
Синтаксис JSON:
{
"NotificationTopicArn": "string"
}
--worker-access-configuration (структура)
Используйте этот необязательный параметр, чтобы ограничить доступ к ресурсу Amazon S3 на основе IP-адреса, используя поддерживаемые глобальные ключи условий IAM. К ресурсу Amazon S3 обращаются в портале для рабочих с помощью предварительно подписанной URL-адреса Amazon S3.
S3Presign -> (структура)
Определяет любые ограничения ресурсов Amazon S3.
IamPolicyConstraints -> (структура)
Используйте этот параметр для указания разрешенного источника запроса. Возможные источники — это SourceIp или VpcSourceIp.
SourceIp -> (строка)
SourceIp является Enabled, IP-адрес работника при выполнении задачи в портале для работников добавляется в политику IAM в качестве Condition, используемого для создания предварительно подписанной URL-адреса Amazon S3. Этот IP-адрес проверяется Amazon S3, и он должен совпадать, чтобы ресурс Amazon S3 отображался в портале для работников.VpcSourceIp -> (строка)
VpcSourceIp является Enabled, IP-адрес работника при выполнении задачи в частном портале для работников внутри VPC добавляется в политику IAM в качестве Condition, используемого для создания предварительно подписанной URL-адреса Amazon S3. Для успешного выполнения задачи Amazon S3 проверяет, что к предварительно подписанной URL-адресу обращаются через конечную точку VPC Amazon S3 и что IP-адрес работника совпадает с IP-адресом в политике IAM. Чтобы узнать больше о настройке частного портала для работников, см. Использование режима Amazon VPC из частного портала для работников.Сокращенный синтаксис:
S3Presign={IamPolicyConstraints={SourceIp=string,VpcSourceIp=string}}
Синтаксис JSON:
{
"S3Presign": {
"IamPolicyConstraints": {
"SourceIp": "Enabled"|"Disabled",
"VpcSourceIp": "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.
Вывод
Группа_работ -> (структура)
Объект Workteam, описывающий обновлённую группу_работ.
Название_группы_работ -> (строка)
Определения_участников -> (список)
Список объектов MemberDefinition, содержащих объекты, идентифицирующие работников, составляющих группу_работ.
Рабочие_группы могут быть созданы с использованием Amazon Cognito или вашего собственного поставщика удостоверений OIDC (IdP). Для частных рабочих_групп, созданных с помощью Amazon Cognito, используйте CognitoMemberDefinition. Для рабочих_групп, созданных с использованием собственного поставщика удостоверений OIDC (IdP), используйте OidcMemberDefinition.
(структура)
Определяет группу пользователей Amazon Cognito или вашего собственного поставщика удостоверений OIDC, которая входит в состав группы_работ.
Определение_участника_Cognito -> (структура)
Группа пользователей Amazon Cognito, которая входит в состав группы_работ.
Бассейн_пользователей -> (строка)
Группа_пользователей -> (строка)
Идентификатор_клиента -> (строка)
Определение_участника_Oidc -> (структура)
Список групп пользователей, которые существуют в вашем поставщике удостоверений OIDC (IdP). Для создания одной частной группы_работ можно использовать от одного до десяти групп. При добавлении группы пользователей в список Groups, вы можете добавить эту группу пользователей к одной или нескольким частным группам_работ. Если вы добавите группу пользователей в частную группу_работ, все работники в этой группе пользователей будут добавлены в группу_работ.
Группы -> (список)
Список строк, разделённых запятыми, идентифицирующих группы пользователей в вашем поставщике удостоверений OIDC (IdP). Каждая группа пользователей состоит из группы частных работников.
(строка)
Arn_группы_работ -> (строка)
Arn_рабочей_группы -> (строка)
Идентификаторы_списков_продуктов -> (список)
Идентификатор Amazon Marketplace для группы_работ поставщика.
(строка)
Описание -> (строка)
Поддомен -> (строка)
Дата_создания -> (временная_метка)
Дата_последнего_обновления -> (временная_метка)
Настройка_уведомлений -> (структура)
Настройка уведомлений SNS о доступности или истечении срока действия элементов работы для групп_работ.
Arn_темы_уведомлений -> (строка)
Настройка_доступа_работников -> (структура)
Описывает любые ограничения доступа, определённые для ресурсов Amazon S3.
Предварительная_подпись_S3 -> (структура)
Определяет любые ограничения ресурсов Amazon S3.
Ограничения_политики_IAM -> (структура)
Используйте этот параметр для указания разрешённого источника запроса. Возможные источники — SourceIp или VpcSourceIp.
IP_адрес_источника -> (строка)
SourceIp — Enabled, IP-адрес работника при отображении задачи в портале работника добавляется в политику IAM в качестве Condition, используемого для генерации предварительно подписанной URL-адреса Amazon S3. Этот IP-адрес проверяется Amazon S3, и он должен совпадать, чтобы ресурс Amazon S3 отображался в портале работника.IP_адрес_источника_сети_виртуальных_машин -> (строка)
VpcSourceIp — Enabled, IP-адрес работника при отображении задачи в частном портале работника внутри сети виртуальных машин (ВМ) добавляется в политику IAM в качестве Condition, используемого для генерации предварительно подписанной URL-адреса Amazon S3. Для успешного отображения задачи Amazon S3 проверяет, что к предварительно подписанной URL-адресу осуществляется доступ через конечную точку VPC Amazon S3 и что IP-адрес работника соответствует IP-адресу в политике IAM. Чтобы узнать больше о настройке частного портала работника, см. Использование режима Amazon VPC из частного портала работника.
© Copyright 2025, Amazon Web Services. Created using Sphinx.