Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

describe-workteam

Описание

Получает информацию о конкретной рабочей группе. Вы можете увидеть информацию, такую как дата создания, последняя дата обновления, информацию о членстве и Amazon Resource Name (ARN) рабочей группы.

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

Синтаксис

  describe-workteam
--workteam-name <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 (строка)

Название рабочей группы, описание которой требуется вернуть.

--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
  • text
  • table
  • yaml
  • yaml-stream

--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, содержащий информацию о рабочей группе.

Название рабочей группы -> (строка)

Название рабочей группы.

MemberDefinitions -> (список)

Список объектов MemberDefinition, содержащих объекты, идентифицирующие сотрудников, составляющих рабочую группу.

Рабочие группы могут создаваться с использованием Amazon Cognito или вашего собственного поставщика удостоверений OIDC (IdP). Для частных рабочих групп, созданных с помощью Amazon Cognito, используйте CognitoMemberDefinition. Для рабочих групп, созданных с использованием вашего собственного поставщика удостоверений OIDC (IdP), используйте OidcMemberDefinition.

(структура)

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

CognitoMemberDefinition -> (структура)

Группа пользователей Amazon Cognito, которая входит в состав рабочей группы.

UserPool -> (строка)

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

UserGroup -> (строка)

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

ClientId -> (строка)

Идентификатор клиента приложения. Вы должны создать идентификатор клиента приложения с помощью Amazon Cognito.

OidcMemberDefinition -> (структура)

Список групп пользователей, существующих в вашем поставщике удостоверений OIDC (IdP). Для создания одной частной рабочей группы можно использовать от одного до десяти групп. При добавлении группы пользователей в список Groups вы можете добавить эту группу пользователей к одной или нескольким частным рабочим группам. Если вы добавите группу пользователей к частной рабочей группе, все сотрудники этой группы пользователей будут добавлены в рабочую группу.

Groups -> (список)

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

(строка)

WorkteamArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий рабочую группу.

WorkforceArn -> (строка)

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

ProductListingIds -> (список)

Идентификатор Amazon Marketplace для рабочей группы поставщика.

(строка)

Описание -> (строка)

Описание рабочей группы.

SubDomain -> (строка)

URI пользовательского интерфейса задачи маркировки. Сотрудники открывают этот URI, чтобы начать маркировку ваших объектов данных.

CreateDate -> (временная метка)

Дата и время создания рабочей группы (временная метка).

LastUpdatedDate -> (временная метка)

Дата и время последнего обновления рабочей группы (временная метка).

NotificationConfiguration -> (структура)

Настройка уведомлений SNS о доступности или истечении срока действия задач для рабочих групп.

NotificationTopicArn -> (строка)

ARN темы Amazon SNS, в которую должны публиковаться уведомления.

WorkerAccessConfiguration -> (структура)

Описание любых ограничений доступа, определенных для ресурсов 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 из частного портала сотрудника.

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

Spec-Zone.ru

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