Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

обновить-форму-оценки

Описание

Обновляет сведения о конкретной версии формы оценки в указанном экземпляре Amazon Connect. Идентификаторы вопросов и разделов не могут дублироваться в одной и той же форме оценки.

Данная операция не поддерживает частичные обновления. Вместо этого она выполняет полное обновление содержимого формы оценки.

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

Синтаксис

  update-evaluation-form
--instance-id <value>
--evaluation-form-id <value>
--evaluation-form-version <value>
[--create-new-version | --no-create-new-version]
--title <value>
[--description <value>]
--items <value>
[--scoring-strategy <value>]
[--client-token <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]

Параметры

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

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

--evaluation-form-id (строка)

Уникальный идентификатор формы оценки.

--evaluation-form-version (целое число)

Версия формы оценки для обновления.

--create-new-version | --no-create-new-version (булево)

Флаг, указывающий, требуется ли создание новой версии.

--title (строка)

Заголовок формы оценки.

--description (строка)

Описание формы оценки.

--items (список)

Элементы, являющиеся частью формы оценки. Общее количество разделов и вопросов не должно превышать 100. Вопросы должны быть размещены в разделе.

(структура помеченного объединения)

Информация об элементе из формы оценки. Элемент должен быть либо разделом, либо вопросом.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: Section, Question.

Раздел -> (структура)

Информация о разделе.

Заголовок -> (строка)

Заголовок раздела.

RefId -> (строка)

Идентификатор раздела. Идентификатор должен быть уникальным в рамках формы оценки.

Инструкции -> (строка)

Инструкции раздела.

Элементы -> (список)

Элементы раздела.

(структура помеченного объединения)

Информация об элементе из формы оценки. Элемент должен быть либо разделом, либо вопросом.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: Section, Question.

Раздел -> (структура)

Информация о разделе.

Заголовок -> (строка)

Заголовок раздела.

RefId -> (строка)

Идентификатор раздела. Идентификатор должен быть уникальным в рамках формы оценки.

Инструкции -> (строка)

Инструкции раздела.

Вес -> (вещественное число)

Весовой коэффициент оценки раздела.

Вопрос -> (структура)

Информация о вопросе.

Заголовок -> (строка)

Заголовок вопроса.

Инструкции -> (строка)

Инструкции раздела.

RefId -> (строка)

Идентификатор вопроса. Идентификатор должен быть уникальным в рамках формы оценки.

NotApplicableEnabled -> (булево)

Флаг для включения ответов «Неприменимо» к вопросу.

Тип вопроса -> (строка)

Тип вопроса.

Свойства типа вопроса -> (структура помеченного объединения)

Свойства типа вопроса. Текстовые вопросы не требуют определения свойств типа вопроса.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: Numeric, SingleSelect.

Числовой -> (структура)

Свойства числового вопроса.

Минимальное значение -> (целое число)

Минимальное значение ответа.

Максимальное значение -> (целое число)

Максимальное значение ответа.

Варианты -> (список)

Варианты оценки числового вопроса.

(структура)

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

Минимальное значение -> (целое число)

Минимальное значение ответа в варианте.

Максимальное значение -> (целое число)

Максимальное значение ответа в варианте.

Оценка -> (целое число)

Оценка, присвоенная значениям ответов в диапазоне вариантов.

AutomaticFail -> (булево)

Флаг для обозначения варианта как автоматического отказа. Если выбран ответ с автоматическим отказом, общая оценка получает 0 баллов.

Автоматизация -> (структура помеченного объединения)

Свойства автоматизации числового вопроса.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: PropertyValue.

Значение свойства -> (структура)

Значение свойства автоматизации.

Метка -> (строка)

Метка свойства автоматизации.

Один выбор -> (структура)

Свойства числового вопроса.

Варианты -> (список)

Варианты ответов вопроса с одним выбором.

(структура)

Информация об автоматической настройке в вопросах с одним выбором.

RefId -> (строка)

Идентификатор варианта ответа. Идентификатор должен быть уникальным в рамках вопроса.

Текст -> (строка)

Заголовок варианта ответа.

Оценка -> (целое число)

Оценка, присвоенная варианту ответа.

AutomaticFail -> (булево)

Флаг для обозначения варианта как автоматического отказа. Если выбран ответ с автоматическим отказом, общая оценка получает 0 баллов.

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

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

Автоматизация -> (структура)

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

Варианты -> (список)

Варианты автоматизации вопроса с одним выбором.

(структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: RuleCategory.

Категория правил -> (структура)

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

Категория -> (строка)

Имя категории, определенное в Правилах.

Условие -> (строка)

Условие для применения варианта автоматизации. Если условие равно PRESENT, то вариант применяется, если данные контакта включают категорию. Аналогично, если условие равно NOT_PRESENT, то вариант применяется, если данные контакта не включают категорию.

OptionRefId -> (строка)

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

DefaultOptionRefId -> (строка)

Идентификатор варианта ответа по умолчанию, когда ни один из вариантов автоматизации не соответствует критериям.

Вес -> (вещественное число)

Весовой коэффициент оценки раздела.

Вопрос -> (структура)

Информация о вопросе.

Заголовок -> (строка)

Заголовок вопроса.

Инструкции -> (строка)

Инструкции раздела.

RefId -> (строка)

Идентификатор вопроса. Идентификатор должен быть уникальным в рамках формы оценки.

NotApplicableEnabled -> (булево)

Флаг для включения ответов «Неприменимо» к вопросу.

Тип вопроса -> (строка)

Тип вопроса.

Свойства типа вопроса -> (структура помеченного объединения)

Свойства типа вопроса. Текстовые вопросы не требуют определения свойств типа вопроса.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: Numeric, SingleSelect.

Числовой -> (структура)

Свойства числового вопроса.

Минимальное значение -> (целое число)

Минимальное значение ответа.

Максимальное значение -> (целое число)

Максимальное значение ответа.

Варианты -> (список)

Варианты оценки числового вопроса.

(структура)

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

Минимальное значение -> (целое число)

Минимальное значение ответа в варианте.

Максимальное значение -> (целое число)

Максимальное значение ответа в варианте.

Оценка -> (целое число)

Оценка, присвоенная значениям ответов в диапазоне вариантов.

AutomaticFail -> (булево)

Флаг для обозначения варианта как автоматического отказа. Если выбран ответ с автоматическим отказом, общая оценка получает 0 баллов.

Автоматизация -> (структура помеченного объединения)

Свойства автоматизации числового вопроса.

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: PropertyValue.

Значение свойства -> (структура)

Значение свойства автоматизации.

Метка -> (строка)

Метка свойства автоматизации.

Один выбор -> (структура)

Свойства числового вопроса.

Варианты -> (список)

Варианты ответов вопроса с одним выбором.

(структура)

Информация об автоматической настройке в вопросах с одним выбором.

RefId -> (строка)

Идентификатор варианта ответа. Идентификатор должен быть уникальным в рамках вопроса.

Текст -> (строка)

Заголовок варианта ответа.

Оценка -> (целое число)

Оценка, присвоенная варианту ответа.

AutomaticFail -> (булево)

Флаг для обозначения варианта как автоматического отказа. Если выбран ответ с автоматическим отказом, общая оценка получает 0 баллов.

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

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

Автоматизация -> (структура)

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

Варианты -> (список)

Варианты автоматизации вопроса с одним выбором.

(структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Должно быть задано только одно из следующих ключевых значений верхнего уровня: RuleCategory.

Категория правил -> (структура)

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

Категория -> (строка)

Имя категории, определенное в Правилах.

Условие -> (строка)

Условие для применения варианта автоматизации. Если условие равно PRESENT, то вариант применяется, если данные контакта включают категорию. Аналогично, если условие равно NOT_PRESENT, то вариант применяется, если данные контакта не включают категорию.

OptionRefId -> (строка)

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

DefaultOptionRefId -> (строка)

Идентификатор варианта ответа по умолчанию, когда ни один из вариантов автоматизации не соответствует критериям.

Вес -> (вещественное число)

Весовой коэффициент оценки раздела.

Синтаксис JSON:

[
  {
    "Section": {
      "Title": "string",
      "RefId": "string",
      "Instructions": "string",
      "Items": [
        {
          "Section": {
            "Title": "string",
            "RefId": "string",
            "Instructions": "string",
            "Items": ,
            "Weight": double
          },
          "Question": {
            "Title": "string",
            "Instructions": "string",
            "RefId": "string",
            "NotApplicableEnabled": true|false,
            "QuestionType": "TEXT"|"SINGLESELECT"|"NUMERIC",
            "QuestionTypeProperties": {
              "Numeric": {
                "MinValue": integer,
                "MaxValue": integer,
                "Options": [
                  {
                    "MinValue": integer,
                    "MaxValue": integer,
                    "Score": integer,
                    "AutomaticFail": true|false
                  }
                  ...
                ],
                "Automation": {
                  "PropertyValue": {
                    "Label": "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"
                  }
                }
              },
              "SingleSelect": {
                "Options": [
                  {
                    "RefId": "string",
                    "Text": "string",
                    "Score": integer,
                    "AutomaticFail": true|false
                  }
                  ...
                ],
                "DisplayAs": "DROPDOWN"|"RADIO",
                "Automation": {
                  "Options": [
                    {
                      "RuleCategory": {
                        "Category": "string",
                        "Condition": "PRESENT"|"NOT_PRESENT",
                        "OptionRefId": "string"
                      }
                    }
                    ...
                  ],
                  "DefaultOptionRefId": "string"
                }
              }
            },
            "Weight": double
          }
        }
        ...
      ],
      "Weight": double
    },
    "Question": {
      "Title": "string",
      "Instructions": "string",
      "RefId": "string",
      "NotApplicableEnabled": true|false,
      "QuestionType": "TEXT"|"SINGLESELECT"|"NUMERIC",
      "QuestionTypeProperties": {
        "Numeric": {
          "MinValue": integer,
          "MaxValue": integer,
          "Options": [
            {
              "MinValue": integer,
              "MaxValue": integer,
              "Score": integer,
              "AutomaticFail": true|false
            }
            ...
          ],
          "Automation": {
            "PropertyValue": {
              "Label": "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"
            }
          }
        },
        "SingleSelect": {
          "Options": [
            {
              "RefId": "string",
              "Text": "string",
              "Score": integer,
              "AutomaticFail": true|false
            }
            ...
          ],
          "DisplayAs": "DROPDOWN"|"RADIO",
          "Automation": {
            "Options": [
              {
                "RuleCategory": {
                  "Category": "string",
                  "Condition": "PRESENT"|"NOT_PRESENT",
                  "OptionRefId": "string"
                }
              }
              ...
            ],
            "DefaultOptionRefId": "string"
          }
        }
      },
      "Weight": double
    }
  }
  ...
]

--scoring-strategy (структура)

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

Режим -> (строка)

Режим оценки формы оценки.

Состояние -> (строка)

Состояние оценки формы оценки.

Краткая синтаксическая запись:

Mode=string,Status=string

Синтаксис JSON:

{
  "Mode": "QUESTION_ONLY"|"SECTION_ONLY",
  "Status": "ENABLED"|"DISABLED"
}

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если он не предоставлен, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

--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
  • таблица
  • 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.

Вывод

EvaluationFormId -> (строка)

Уникальный идентификатор формы оценки.

EvaluationFormArn -> (строка)

Amazon Resource Name (ARN) для ресурса оценки контакта.

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

Версия обновленного ресурса формы оценки.

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

Spec-Zone.ru

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