Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

describe-evaluation-form

Описание

Описывает форму оценки в указанном экземпляре Amazon Connect. Если свойство версии не указано, описывается последняя версия формы оценки.

См. также: AWS API Documentation

Синтаксис

  describe-evaluation-form
--instance-id <value>
--evaluation-form-id <value>
[--evaluation-form-version <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 Resource Name (ARN) экземпляра.

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

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

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

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

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

Вывод

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

Информация о форме оценки.

EvaluationFormId -> (строка)

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

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

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

Locked -> (булево)

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

EvaluationFormArn -> (строка)

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

Title -> (строка)

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

Description -> (строка)

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

Status -> (строка)

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

Items -> (список)

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

(структура помеченного союза)

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

Примечание

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

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

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

Title -> (строка)

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

RefId -> (строка)

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

Instructions -> (строка)

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

Items -> (список)

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

(структура помеченного союза)

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

Примечание

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

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

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

Title -> (строка)

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

RefId -> (строка)

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

Instructions -> (строка)

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

Weight -> (двойное)

Вес оценки раздела.

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

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

Title -> (строка)

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

Instructions -> (строка)

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

RefId -> (строка)

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

NotApplicableEnabled -> (булево)

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

QuestionType -> (строка)

Тип вопроса.

QuestionTypeProperties -> (структура помеченного союза)

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

Примечание

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

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

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

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

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

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

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

Options -> (список)

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

(структура)

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

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

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

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

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

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

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

AutomaticFail -> (булево)

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

Automation -> (структура помеченного союза)

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

Примечание

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

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

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

Label -> (строка)

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

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

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

Options -> (список)

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

(структура)

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

RefId -> (строка)

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

Text -> (строка)

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

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

Оценка, назначенная варианту ответа.

AutomaticFail -> (булево)

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

DisplayAs -> (строка)

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

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

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

Options -> (список)

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

(структура помеченного союза)

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

Примечание

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

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

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

Category -> (строка)

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

Condition -> (строка)

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

OptionRefId -> (строка)

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

DefaultOptionRefId -> (строка)

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

Weight -> (двойное)

Вес оценки раздела.

Weight -> (двойное)

Вес оценки раздела.

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

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

Title -> (строка)

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

Instructions -> (строка)

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

RefId -> (строка)

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

NotApplicableEnabled -> (булево)

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

QuestionType -> (строка)

Тип вопроса.

QuestionTypeProperties -> (структура помеченного союза)

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

Примечание

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

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

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

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

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

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

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

Options -> (список)

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

(структура)

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

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

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

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

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

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

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

AutomaticFail -> (булево)

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

Automation -> (структура помеченного союза)

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

Примечание

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

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

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

Label -> (строка)

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

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

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

Options -> (список)

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

(структура)

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

RefId -> (строка)

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

Text -> (строка)

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

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

Оценка, назначенная варианту ответа.

AutomaticFail -> (булево)

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

DisplayAs -> (строка)

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

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

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

Options -> (список)

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

(структура помеченного союза)

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

Примечание

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

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

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

Category -> (строка)

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

Condition -> (строка)

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

OptionRefId -> (строка)

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

DefaultOptionRefId -> (строка)

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

Weight -> (двойное)

Вес оценки раздела.

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

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

Mode -> (строка)

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

Status -> (строка)

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

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

Метка времени создания формы оценки.

CreatedBy -> (строка)

Amazon Resource Name (ARN) пользователя, создавшего форму оценки.

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

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

LastModifiedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который последний раз обновлял форму оценки.

Tags -> (карта)

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

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

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

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

Spec-Zone.ru

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