Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

создать-рабочую-группу

Описание

Используйте эту операцию для создания рабочей группы. Эта операция вернёт ошибку, если рабочая группа уже существует в указанном вами регионе Amazon Web Services. Вы можете создать только одну рабочую группу в каждом регионе Amazon Web Services для каждой учётной записи Amazon Web Services.

Если вы хотите создать новую рабочую группу в регионе Amazon Web Services, где уже существует рабочая группа, используйте операцию API DeleteWorkforce для удаления существующей рабочей группы, а затем CreateWorkforce для создания новой рабочей группы.

Для создания частной рабочей группы с использованием Amazon Cognito необходимо указать пул пользователей Cognito в CognitoConfig. Вы также можете создать рабочую группу Amazon Cognito с помощью консоли Amazon SageMaker. Дополнительная информация в разделе Создать частную рабочую группу (Amazon Cognito).

Для создания частной рабочей группы с использованием собственного поставщика удостоверений OIDC (IdP) укажите конфигурацию вашего IdP в OidcConfig. Ваш поставщик удостоверений OIDC IdP должен поддерживать группы, так как группы используются Ground Truth и Amazon A2I для создания команд. Дополнительная информация в разделе Создать частную рабочую группу (OIDC IdP).

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

Синтаксис

  create-workforce
[--cognito-config <value>]
[--oidc-config <value>]
[--source-ip-config <value>]
--workforce-name <value>
[--tags <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]

Параметры

--cognito-config (структура)

Используйте этот параметр для настройки частной рабочей группы Amazon Cognito. Одна рабочая группа Cognito создаётся с использованием и соответствует одному пулу пользователей Amazon Cognito.

Не используйте OidcConfig, если вы указываете значения для CognitoConfig.

UserPool -> (строка)

Пул пользователей — это каталог пользователей в Amazon Cognito. С помощью пула пользователей ваши пользователи могут входить в ваш веб- или мобильное приложение через Amazon Cognito. Ваши пользователи также могут войти через поставщиков социальных удостоверений, таких как Google, Facebook, Amazon или Apple, а также через поставщиков удостоверений SAML.

ClientId -> (строка)

Идентификатор клиента для вашего пула пользователей Amazon Cognito.

Упрощённый синтаксис:

UserPool=string,ClientId=string

Синтаксис JSON:

{
  "UserPool": "string",
  "ClientId": "string"
}

--oidc-config (структура)

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

Не используйте CognitoConfig, если вы указываете значения для OidcConfig.

ClientId -> (строка)

Идентификатор клиента OIDC IdP, используемый для настройки вашей частной рабочей группы.

ClientSecret -> (строка)

Секретный ключ клиента OIDC IdP, используемый для настройки вашей частной рабочей группы.

Issuer -> (строка)

Издатель OIDC IdP, используемый для настройки вашей частной рабочей группы.

AuthorizationEndpoint -> (строка)

Конечная точка авторизации OIDC IdP, используемая для настройки вашей частной рабочей группы.

TokenEndpoint -> (строка)

Конечная точка получения токена OIDC IdP, используемая для настройки вашей частной рабочей группы.

UserInfoEndpoint -> (строка)

Конечная точка информации о пользователе OIDC IdP, используемая для настройки вашей частной рабочей группы.

LogoutEndpoint -> (строка)

Конечная точка выхода OIDC IdP, используемая для настройки вашей частной рабочей группы.

JwksUri -> (строка)

URI набора ключей JSON Web (Jwks) OIDC IdP, используемый для настройки вашей частной рабочей группы.

Scope -> (строка)

Массив строковых идентификаторов, используемых для ссылки на конкретные фрагменты данных пользователя или утверждений, к которым приложение-клиент хочет получить доступ.

AuthenticationRequestExtraParams -> (карта)

Строка-строковая карта идентификаторов, специфичных для используемого пользовательского поставщика удостоверений (IdP).

ключ -> (строка)

значение -> (строка)

Упрощённый синтаксис:

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"
    ...}
}

--source-ip-config (структура)

Список диапазонов IP-адресов (CIDR). Используется для создания списка разрешенных IP-адресов для частной рабочей группы. Работники смогут входить в портал работников только с IP-адреса из этого диапазона. По умолчанию рабочая группа не ограничена определёнными IP-адресами.

Cidrs -> (список)

Список от одного до десяти значений CIDR (Classless Inter-Domain Routing).

Максимум: Десять значений CIDR

Примечание

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

(строка)

Упрощённый синтаксис:

Cidrs=string,string

Синтаксис JSON:

{
  "Cidrs": ["string", ...]
}

--workforce-name (строка)

Имя частной рабочей группы.

--tags (список)

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

(структура)

Объект тега, состоящий из ключа и необязательного значения, используется для управления метаданными ресурсов Amazon Web Services SageMaker.

Вы можете добавлять теги к экземплярам ноутбуков, задачам обучения, задачам настройки гиперпараметров, задачам пакетного преобразования, моделям, задачам разметки, командам, конфигурациям конечных точек и конечным точкам. Дополнительная информация о добавлении тегов к ресурсам SageMaker находится в разделе AddTags .

Дополнительную информацию о добавлении метаданных в ваши ресурсы Amazon Web Services с помощью тегов см. в разделе Тегирование ресурсов Amazon Web Services. Советы по лучшим практикам управления ресурсами Amazon Web Services с помощью тегов см. в разделе Практические рекомендации по тегам: Реализация эффективной стратегии тегирования ресурсов Amazon Web Services.

Key -> (строка)

Ключ тега. Ключи тегов должны быть уникальными для каждого ресурса.

Value -> (строка)

Значение тега.

Упрощённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--workforce-vpc-config (структура)

Используйте этот параметр для настройки рабочей группы с помощью VPC.

VpcId -> (строка)

Идентификатор VPC, который используется рабочей группой для связи.

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 для вывода.

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

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

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

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

Вывод

WorkforceArn -> (строка)

Amazon Resource Name (ARN) рабочей группы.

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

Spec-Zone.ru

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