Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

describe-contact-evaluation

Описание

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

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

Синтаксис

  describe-contact-evaluation
--instance-id <value>
--evaluation-id <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. Вы можете найти ID экземпляра в Amazon Resource Name (ARN) экземпляра.

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

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

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

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

  • включить
  • выключить
  • автоматически

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

Оценка -> (структура)

Информация о форме оценки, заполненной для определённого контакта.

EvaluationId -> (строка)

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

EvaluationArn -> (строка)

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

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

Метаданные об оценке контакта.

ContactId -> (строка)

Идентификатор контакта в данном экземпляре Amazon Connect.

EvaluatorArn -> (строка)

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

ContactAgentId -> (строка)

Идентификатор агента, который выполнял контакт.

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

Общая оценка контакта.

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

Процентный балл для элемента в оценке контакта.

NotApplicable -> (булево)

Флаг для обозначения элемента как не применимого для оценки.

AutomaticFail -> (булево)

Флаг, обозначающий элемент как автоматический провал. Если элемент или дочерний элемент получает ответ "автоматический провал", этот флаг будет истинным.

Answers -> (массив)

Массив идентификаторов вопросов к значению ответа.

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

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

Информация об ответах на оценку контакта.

Value -> (структура с маркированным объединением)

Значение ответа в оценке контакта.

Примечание

Это структура с маркированным объединением. Только один из следующих ключей верхнего уровня может быть установлен: StringValue, NumericValue, NotApplicable.

StringValue -> (строка)

Строковое значение ответа в оценке контакта.

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

Числовое значение ответа в оценке контакта.

NotApplicable -> (булево)

Флаг для обозначения вопроса как неприменимого.

SystemSuggestedValue -> (структура с маркированным объединением)

Предложенное системой значение ответа в оценке контакта.

Примечание

Это структура с маркированным объединением. Только один из следующих ключей верхнего уровня может быть установлен: StringValue, NumericValue, NotApplicable.

StringValue -> (строка)

Строковое значение ответа в оценке контакта.

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

Числовое значение ответа в оценке контакта.

NotApplicable -> (булево)

Флаг для обозначения вопроса как неприменимого.

Notes -> (массив)

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

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

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

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

Value -> (строка)

Заметка для элемента (раздела или вопроса) в оценке контакта.

Примечание

Хотя заметка в оценке может содержать до 3072 символов, также существует ограничение на общее количество символов для всех заметок в оценке вместе взятых. Предполагая, что в оценке отправляется N вопросов, максимальное ограничение символов для всех заметок вместе взятых равно N x 1024.

Status -> (строка)

Статус оценки контакта.

Scores -> (массив)

Массив идентификаторов элементов (разделов или вопросов) к значению оценки.

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

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

Информация об оценках элемента оценки контакта (раздела или вопроса).

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

Процентный балл для элемента в оценке контакта.

NotApplicable -> (булево)

Флаг для обозначения элемента как не применимого для оценки.

AutomaticFail -> (булево)

Флаг, обозначающий элемент как автоматический провал. Если элемент или дочерний элемент получает ответ "автоматический провал", этот флаг будет истинным.

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

Временная метка создания оценки.

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

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

Tags -> (массив)

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

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

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

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

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

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

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

EvaluationFormId -> (строка)

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

EvaluationFormArn -> (строка)

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

Title -> (строка)

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

Description -> (строка)

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

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

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

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

Spec-Zone.ru

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