Поиск пользователей

Описание

Ищет пользователей в экземпляре Amazon Connect с опциональным фильтром.

Примечание

AfterContactWorkTimeLimit возвращается в миллисекундах.

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

search-users — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Users

Синтаксис

  search-users
--instance-id <value>
[--search-filter <value>]
[--search-criteria <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]

Параметры

--instance-id (строка)

Идентификатор экземпляра Amazon Connect. Вы можете найти ID экземпляра в имени Amazon Resource Name (ARN) экземпляра.

--search-filter (структура)

Фильтры для применения к результатам поиска.

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

Объект, который может быть использован для указания условий тегов внутри SearchFilter. Это принимает OR типа AND (Список списков) ввода, где:

Список верхнего уровня указывает условия, которые необходимо применить с оператором OR
Вложенный список указывает условия, которые необходимо применить с оператором AND.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(список)

(структура)

Условие узла листа, которое может быть использовано для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

AndConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое может быть использовано для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое может быть использовано для указания условия тега.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

Объект, который может быть использован для указания условий тегов или условий группы иерархии внутри SearchFilter.

Это принимает OR типа AND (Список списков) ввода, где:

Список верхнего уровня указывает условия, которые необходимо применить с оператором OR.
Вложенный список указывает условия, которые необходимо применить с оператором AND.

Примечание

Можно заполнить только одно поле. Этот объект не может быть использован вместе с TagFilter. Запрос может содержать TagFilter или UserAttributeFilter, если указан SearchFilter; комбинация обоих не поддерживается и приведет к ошибке AccessDeniedException.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(структура)

Список условий, которые будут применяться вместе с условием AND.

TagConditions -> (список)

Условие узла листа, которое может быть использовано для указания условия тега.

(структура)

Условие узла листа, которое может быть использовано для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое может быть использовано для указания условия группы иерархии.

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группы иерархии.

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

Список условий, которые будут применяться вместе с условием AND.

TagConditions -> (список)

Условие узла листа, которое может быть использовано для указания условия тега.

(структура)

Условие узла листа, которое может быть использовано для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое может быть использовано для указания условия группы иерархии.

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группы иерархии.

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

Условие узла листа, которое может быть использовано для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое может быть использовано для указания условия группы иерархии.

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группы иерархии.

Синтаксис JSON:

{
  "TagFilter": {
    "OrConditions": [
      [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ]
      ...
    ],
    "AndConditions": [
      {
        "TagKey": "string",
        "TagValue": "string"
      }
      ...
    ],
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "string"
    }
  },
  "UserAttributeFilter": {
    "OrConditions": [
      {
        "TagConditions": [
          {
            "TagKey": "string",
            "TagValue": "string"
          }
          ...
        ],
        "HierarchyGroupCondition": {
          "Value": "string",
          "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
        }
      }
      ...
    ],
    "AndCondition": {
      "TagConditions": [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ],
      "HierarchyGroupCondition": {
        "Value": "string",
        "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
      }
    },
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "string"
    },
    "HierarchyGroupCondition": {
      "Value": "string",
      "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
    }
  }
}

--search-criteria (структура)

Критерии поиска, используемые для возврата пользователей.

Примечание

Поля name и description поддерживают запросы «содержит» с минимальным количеством символов 2 и максимальным 25. Любые запросы с длиной символов вне этого диапазона приведут к недействительным результатам.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(структура)

Критерии поиска, используемые для возврата пользователей.

Примечание

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(… рекурсивно …)

AndConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(… рекурсивно …)

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

Условие узла листа, которое можно использовать для указания условия строки.

В настоящее время поддерживаемые значения для FieldName — Username , FirstName , LastName , RoutingProfileId , SecurityProfileId , ResourceId.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

Условие узла листа, которое можно использовать для указания условия списка для поиска пользователей с атрибутами, включенными в списки, такие как навыки.

TargetListType -> (строка)

Тип целевого списка, который будет использоваться для фильтрации пользователей.

Conditions -> (список)

Список объектов Condition, которые будут применяться вместе с условием И.

(структура)

Условие узла листа, которое можно использовать для указания ProficiencyName, ProficiencyValue и ProficiencyLimit.

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

Условие узла листа, которое можно использовать для указания условия строки.

Примечание

В настоящее время поддерживаемые значения для FieldName — name и value.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

Условие узла листа, которое можно использовать для указания числового условия.

FieldName -> (строка)

Имя поля в числовом условии.

MinValue -> (целое число)

Минимальное значение, используемое при оценке числового условия.

MaxValue -> (целое число)

Максимальное значение, используемое при оценке числового условия.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке числового условия.

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

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

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группе иерархии.

AndConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Критерии поиска, используемые для возврата пользователей.

Примечание

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(… рекурсивно …)

AndConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(… рекурсивно …)

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

Условие узла листа, которое можно использовать для указания условия строки.

В настоящее время поддерживаемые значения для FieldName — Username , FirstName , LastName , RoutingProfileId , SecurityProfileId , ResourceId.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

TargetListType -> (строка)

Тип целевого списка, который будет использоваться для фильтрации пользователей.

Conditions -> (список)

Список объектов Condition, которые будут применяться вместе с условием И.

(структура)

Условие узла листа, которое можно использовать для указания ProficiencyName, ProficiencyValue и ProficiencyLimit.

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

Условие узла листа, которое можно использовать для указания условия строки.

Примечание

В настоящее время поддерживаемые значения для FieldName — name и value.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

Условие узла листа, которое можно использовать для указания числового условия.

FieldName -> (строка)

Имя поля в числовом условии.

MinValue -> (целое число)

Минимальное значение, используемое при оценке числового условия.

MaxValue -> (целое число)

Максимальное значение, используемое при оценке числового условия.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке числового условия.

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

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

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группе иерархии.

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

Условие узла листа, которое можно использовать для указания условия строки.

В настоящее время поддерживаемые значения для FieldName — Username , FirstName , LastName , RoutingProfileId , SecurityProfileId , ResourceId.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

TargetListType -> (строка)

Тип целевого списка, который будет использоваться для фильтрации пользователей.

Conditions -> (список)

Список объектов Condition, которые будут применяться вместе с условием И.

(структура)

Условие узла листа, которое можно использовать для указания ProficiencyName, ProficiencyValue и ProficiencyLimit.

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

Условие узла листа, которое можно использовать для указания условия строки.

Примечание

В настоящее время поддерживаемые значения для FieldName — name и value.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке условия строки.

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

Условие узла листа, которое можно использовать для указания числового условия.

FieldName -> (строка)

Имя поля в числовом условии.

MinValue -> (целое число)

Минимальное значение, используемое при оценке числового условия.

MaxValue -> (целое число)

Максимальное значение, используемое при оценке числового условия.

ComparisonType -> (строка)

Тип сравнения, выполняемого при оценке числового условия.

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

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

Value -> (строка)

Значение в условии группы иерархии.

HierarchyGroupMatchType -> (строка)

Тип соответствия группе иерархии.

JSON Синтаксис:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "ListCondition": {
        "TargetListType": "PROFICIENCIES",
        "Conditions": [
          {
            "StringCondition": {
              "FieldName": "string",
              "Value": "string",
              "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
            },
            "NumberCondition": {
              "FieldName": "string",
              "MinValue": integer,
              "MaxValue": integer,
              "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
            }
          }
          ...
        ]
      },
      "HierarchyGroupCondition": {
        "Value": "string",
        "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "ListCondition": {
        "TargetListType": "PROFICIENCIES",
        "Conditions": [
          {
            "StringCondition": {
              "FieldName": "string",
              "Value": "string",
              "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
            },
            "NumberCondition": {
              "FieldName": "string",
              "MinValue": integer,
              "MaxValue": integer,
              "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
            }
          }
          ...
        ]
      },
      "HierarchyGroupCondition": {
        "Value": "string",
        "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  },
  "ListCondition": {
    "TargetListType": "PROFICIENCIES",
    "Conditions": [
      {
        "StringCondition": {
          "FieldName": "string",
          "Value": "string",
          "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
        },
        "NumberCondition": {
          "FieldName": "string",
          "MinValue": integer,
          "MaxValue": integer,
          "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
        }
      }
      ...
    ]
  },
  "HierarchyGroupCondition": {
    "Value": "string",
    "HierarchyGroupMatchType": "EXACT"|"WITH_CHILD_GROUPS"
  }
}

--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
текст
таблица
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.

Вывод

Пользователи -> (список)

Информация о пользователях.

(структура)

Информация о возвращенных пользователях.

Arn -> (строка)

Amazon Resource Name (ARN) пользователя.

DirectoryUserId -> (строка)

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

HierarchyGroupId -> (строка)

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

Id -> (строка)

Идентификатор сводки пользователя.

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

Имя и фамилия пользователя.

FirstName -> (строка)

Имя пользователя.

LastName -> (строка)

Фамилия пользователя.

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

Содержит информацию о настройках телефонной конфигурации для пользователя.

PhoneType -> (строка)

Тип телефона.

AutoAccept -> (логическое значение)

Настройка автоматического принятия.

AfterContactWorkTimeLimit -> (целое число)

Настройка таймаута After Call Work (ACW) в секундах. Этот параметр имеет минимальное значение 0 и максимальное значение 2 000 000 секунд (24 дня). Введите 0, если вы не хотите выделять определенное количество времени ACW. Это по сути означает неопределенное количество времени. Когда завершается разговор, ACW начинается; агент должен выбрать «Закрыть контакт», чтобы завершить ACW.

Примечание

При возвращении вызовом SearchUsers, AfterContactWorkTimeLimit возвращается в миллисекундах.

DeskPhoneNumber -> (строка)

Номер телефона рабочего телефона пользователя.

RoutingProfileId -> (строка)

Идентификатор профиля маршрутизации пользователя.

SecurityProfileIds -> (список)

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

(строка)

Tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Теги”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.

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

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

Username -> (строка)

Имя пользователя.

NextToken -> (строка)

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

ApproximateTotalCount -> (длинное целое число)

Общее количество пользователей, соответствующих вашему запросу поиска.