Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

Поиск часов работы

Описание

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

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

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

Синтаксис

  search-hours-of-operations
--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. Вы можете найти идентификатор экземпляра в 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 -> (строка)

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

Синтаксис JSON:

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

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

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

OrConditions -> (список)

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

(структура)

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

OrConditions -> (список)

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

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

AndConditions -> (список)

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

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

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

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

Примечание

В настоящее время поддерживаются следующие значения для FieldName: name, description, timezone и resourceID.

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

AndConditions -> (список)

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

(структура)

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

OrConditions -> (список)

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

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

AndConditions -> (список)

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

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

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

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

Примечание

В настоящее время поддерживаются следующие значения для FieldName: name, description, timezone и resourceID.

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

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

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

Примечание

В настоящее время поддерживаются следующие значения для FieldName: name, description, timezone и resourceID.

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

HoursOfOperations -> (список)

Информация о графике работы.

(структура)

Информация о графике работы.

HoursOfOperationId -> (строка)

Идентификатор графика работы.

HoursOfOperationArn -> (строка)

Amazon Resource Name (ARN) графика работы.

Name -> (строка)

Название графика работы.

Description -> (строка)

Описание графика работы.

TimeZone -> (строка)

Часовой пояс для графика работы.

Config -> (список)

Конфигурационная информация для графика работы.

(структура)

Содержит информацию о графике работы.

Day -> (строка)

День, на который распространяется график работы.

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

Время начала работы контактного центра.

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

Часы.

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

Минуты.

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

Время закрытия контактного центра.

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

Часы.

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

Минуты.

Tags -> (словарь)

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

key -> (строка)

value -> (строка)

LastModifiedTime -> (метка времени)

Дата и время последнего изменения этого ресурса.

LastModifiedRegion -> (строка)

Регион Amazon Web Services, в котором был изменён этот ресурс.

NextToken -> (строка)

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

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

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

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

Spec-Zone.ru

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