Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

поиск-профилей-безопасности

Описание

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

Дополнительную информацию о профилях безопасности см. в разделе «Профили безопасности» в Руководстве администратора Amazon Connect . Сопоставление имени API и имени элемента пользовательского интерфейса разрешений профиля безопасности см. в разделе «Список разрешений профиля безопасности» .

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

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

Синтаксис

  search-security-profiles
--instance-id <value>
[--search-criteria <value>]
[--search-filter <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. Идентификатор экземпляра можно найти в имени Amazon Resource Name (ARN) экземпляра.

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

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

Примечание

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

Примечание

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

OrConditions -> (список)

Список условий, которые применяются вместе с условием ИЛИ.

(структура)

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

Примечание

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

OrConditions -> (список)

Список условий, которые применяются вместе с условием ИЛИ.

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

AndConditions -> (список)

Список условий, которые применяются вместе с условием И.

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

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

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

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

AndConditions -> (список)

Список условий, которые применяются вместе с условием И.

(структура)

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

Примечание

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

OrConditions -> (список)

Список условий, которые применяются вместе с условием ИЛИ.

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

AndConditions -> (список)

Список условий, которые применяются вместе с условием И.

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

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

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

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

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

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

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

Синтаксис JSON:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  }
}

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

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

Синтаксис JSON:

{
  "TagFilter": {
    "OrConditions": [
      [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ]
      ...
    ],
    "AndConditions": [
      {
        "TagKey": "string",
        "TagValue": "string"
      }
      ...
    ],
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "string"
    }
  }
}

--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 (boolean)

Включить отладовую запись журнала.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод в цвете.

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

SecurityProfiles -> (list)

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

(structure)

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

Id -> (string)

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

OrganizationResourceId -> (string)

Идентификатор ресурса организации.

Arn -> (string)

Amazon Resource Name (ARN) профиля безопасности.

SecurityProfileName -> (string)

Название профиля безопасности.

Description -> (string)

Описание профиля безопасности.

Tags -> (map)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

key -> (string)

value -> (string)

NextToken -> (string)

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

ApproximateTotalCount -> (long)

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

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

Spec-Zone.ru

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