describe-rule
Описание
Описывает правило для указанного экземпляра Amazon Connect.
См. также: Документация API AWS
Синтаксис
describe-rule
--instance-id <value>
--rule-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 (строка)
--rule-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
- текст
- таблица
- 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.
Вывод
Правило -> (структура)
Информация о правиле.
Имя -> (строка)
RuleId -> (строка)
RuleArn -> (строка)
TriggerEventSource -> (структура)
Источник событий для запуска правила.
EventSourceName -> (строка)
IntegrationAssociationId -> (строка)
Функция -> (строка)
Действия -> (список)
Список действий, которые выполняются при срабатывании правила.
(структура)
Информация о действии, выполняемом при срабатывании правила.
ActionType -> (строка)
TaskAction -> (структура)
Информация о действии задачи. Это поле обязательно, если TriggerEventSource имеет одно из следующих значений: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Имя -> (строка)
Описание -> (строка)
ContactFlowId -> (строка)
Ссылки -> (карта)
Информация о ссылке, когда referenceType равно URL. В противном случае null. (Поддерживает инъекцию переменных в поле Value.)
ключ -> (строка)
значение -> (структура)
Данные контакта в корректном формате, используемые агентами для выполнения запроса контакта. Общий объем данных всех ссылок для контакта может составлять до 4096 байт UTF-8.
Значение -> (строка)
Тип -> (строка)
DATE должен быть типа отметки времени эпохи.Статус -> (строка)
Arn -> (строка)
Причина статуса -> (строка)
EventBridgeAction -> (структура)
Информация о действии EventBridge.
Поддерживается только для значений TriggerEventSource: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Имя -> (строка)
AssignContactCategoryAction -> (структура)
Информация о действии категории контакта.
Поддерживается только для значений TriggerEventSource: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction -> (структура)
Информация о действии отправки уведомления.
Поддерживается только для значений TriggerEventSource: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Способ доставки -> (строка)
Тема -> (строка)
EMAIL. Поддерживает инъекцию переменных. Для получения дополнительной информации см. справку JSONPath в Руководстве администратора Amazon Connect.Содержание -> (строка)
Тип контента -> (строка)
Получатель -> (структура)
Получатель уведомления.
Метки пользователей -> (карта)
Метки, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Метки”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }. Пользователи Amazon Connect со специфицированными метками будут уведомлены.
ключ -> (строка)
значение -> (строка)
Идентификаторы пользователей -> (список)
Список идентификаторов пользователей. Поддерживает инъекцию переменных $.ContactLens.ContactEvaluation.Agent.AgentId для источника событий OnContactEvaluationSubmit.
(строка)
CreateCaseAction -> (структура)
Информация о действии создания кейса.
Поддерживается только для значений TriggerEventSource: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Поля -> (список)
Массив объектов с данными Field ID и Value.
(структура)
Объект для значений полей кейса.
Идентификатор -> (строка)
Значение -> (структура)
Объединение возможных типов значений поля.
BooleanValue -> (булево)
DoubleValue -> (двойное)
EmptyValue -> (структура)
StringValue -> (строка)
TemplateId -> (строка)
UpdateCaseAction -> (структура)
Информация о действии обновления кейса.
Поддерживается только для значений TriggerEventSource: OnCaseCreate | OnCaseUpdate.
Поля -> (список)
Массив объектов с данными Field ID и значение.
(структура)
Объект для значений полей кейса.
Идентификатор -> (строка)
Значение -> (структура)
Объединение возможных типов значений поля.
BooleanValue -> (булево)
DoubleValue -> (двойное)
EmptyValue -> (структура)
StringValue -> (строка)
AssignSlaAction -> (структура)
Информация о действии назначения SLA.
SlaAssignmentType -> (строка)
CaseSlaConfiguration -> (структура)
Настройка SLA для назначения Case SLA.
Имя -> (строка)
Тип -> (строка)
FieldId -> (строка)
TargetFieldValues -> (список)
Список целевых значений поля для указанного в CaseSlaConfiguration fieldId. SLA считается выполненным, если хотя бы одно из этих целевых значений поля совпадает с фактическим значением поля.
(структура)
Объект для хранения объединения значений поля.
BooleanValue -> (булево)
DoubleValue -> (двойное)
EmptyValue -> (структура)
StringValue -> (строка)
TargetSlaMinutes -> (целое)
EndAssociatedTasksAction -> (структура)
Информация о действии завершения связанных задач.
Поддерживается только для значений TriggerEventSource: OnCaseUpdate.
SubmitAutoEvaluationAction -> (структура)
Информация о действии отправки автоматизированной оценки.
EvaluationFormId -> (строка)
PublishStatus -> (строка)
CreatedTime -> (метка времени)
LastUpdatedTime -> (метка времени)
LastUpdatedBy -> (строка)
Метки -> (карта)
Метки, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Метки”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.