Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

Переопределения часов работы поиска

Описание

Ищет переопределения часов работы.

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

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

Синтаксис

  search-hours-of-operation-overrides
--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.

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

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

Value -> (строка)

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

ComparisonType -> (строка)

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

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

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

FieldName -> (строка)

Объект для указания поля даты переопределения часов работы.

Value -> (строка)

Объект для указания значения даты переопределения часов работы.

ComparisonType -> (строка)

Объект для указания условия даты переопределения часов работы comparisonType.

AndConditions -> (список)

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

(структура)

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

OrConditions -> (список)

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

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

AndConditions -> (список)

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

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

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

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

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

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

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

FieldName -> (строка)

Объект для указания поля даты переопределения часов работы.

Value -> (строка)

Объект для указания значения даты переопределения часов работы.

ComparisonType -> (строка)

Объект для указания условия даты переопределения часов работы comparisonType.

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

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

FieldName -> (строка)

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

Value -> (строка)

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

ComparisonType -> (строка)

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

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

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

FieldName -> (строка)

Объект для указания поля даты переопределения часов работы.

Value -> (строка)

Объект для указания значения даты переопределения часов работы.

ComparisonType -> (строка)

Объект для указания условия даты переопределения часов работы comparisonType.

Синтаксис JSON:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "DateCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "DateCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  },
  "DateCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"
  }
}

--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 версии 1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку 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.

Вывод

HoursOfOperationOverrides -> (список)

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

(структура)

Информация о переопределении времени работы.

HoursOfOperationOverrideId -> (строка)

Идентификатор переопределения времени работы.

HoursOfOperationId -> (строка)

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

HoursOfOperationArn -> (строка)

Amazon Resource Name (ARN) для времени работы.

Name -> (строка)

Название переопределения времени работы.

Description -> (строка)

Описание переопределения времени работы.

Config -> (список)

Конфигурация переопределения времени работы: день, время начала и время окончания.

(структура)

Информация о конфигурации переопределения времени работы: день, время начала и время окончания.

Day -> (строка)

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

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

Время начала работы контактного центра, если применяются переопределения.

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

Часы.

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

Минуты.

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

Время окончания работы контактного центра, если применяются переопределения.

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

Часы.

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

Минуты.

EffectiveFrom -> (строка)

Дата вступления в силу переопределения времени работы.

EffectiveTill -> (строка)

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

NextToken -> (строка)

Токен для следующего набора результатов. Используйте значение, возвращённое в предыдущем ответе, в следующем запросе, чтобы получить следующий набор результатов. Ограничения по длине: Минимальная длина 1. Максимальная длина 2500.

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

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

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

Spec-Zone.ru

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