create-rule
Описание
Создаёт правило для указанного экземпляра Amazon Connect.
Используйте язык функций правил для кодирования условий правила.
См. также: Документацию API AWS
Синтаксис
create-rule
--instance-id <value>
--name <value>
--trigger-event-source <value>
--function <value>
--actions <value>
--publish-status <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 (строка)
--name (строка)
--trigger-event-source (структура)
Источник события для запуска правила.
EventSourceName -> (строка)
IntegrationAssociationId -> (строка)
Сокращённый синтаксис:
EventSourceName=string,IntegrationAssociationId=string
Синтаксис JSON:
{
"EventSourceName": "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnRealTimeChatAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|"OnMetricDataUpdate"|"OnCaseCreate"|"OnCaseUpdate"|"OnSlaBreach",
"IntegrationAssociationId": "string"
}
--function (строка)
--actions (список)
Список действий, которые будут выполнены при запуске правила.
(структура)
Информация об действии, которое выполняется при запуске правила.
ActionType -> (строка)
TaskAction -> (структура)
Информация о действии задачи. Это поле необходимо, если TriggerEventSource имеет одно из следующих значений: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name -> (строка)
Description -> (строка)
ContactFlowId -> (строка)
References -> (карта)
Информация о ссылке, когда referenceType является URL. В противном случае, null. (Поддерживает внедрение переменных в поле Value).
key -> (строка)
value -> (структура)
Хорошо сформированные данные о контакте, используемые агентами для завершения запроса контакта. Вы можете иметь до 4096 байт UTF-8 по всем ссылкам для контакта.
Value -> (строка)
Type -> (строка)
DATE должен быть типа отметки времени эпохи.Status -> (строка)
Arn -> (строка)
StatusReason -> (строка)
EventBridgeAction -> (структура)
Информация об действии EventBridge.
Поддерживается только для TriggerEventSource значений: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name -> (строка)
AssignContactCategoryAction -> (структура)
Информация о действии категории контактов.
Поддерживается только для TriggerEventSource значений: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction -> (структура)
Информация об отправке уведомления.
Поддерживается только для TriggerEventSource значений: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod -> (строка)
Subject -> (строка)
EMAIL. Поддерживает внедрение переменных. Для получения дополнительной информации см. справку по JSONPath в руководстве администратора Amazon Connect.Content -> (строка)
ContentType -> (строка)
Recipient -> (структура)
Получатель уведомления.
UserTags -> (карта)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, {“Tags”: {“key1”:”value1”, “key2”:”value2”} }. Пользователи Amazon Connect со специфицированными тегами будут уведомлены.
key -> (строка)
value -> (строка)
UserIds -> (список)
Список идентификаторов пользователей. Поддерживает внедрение переменных $.ContactLens.ContactEvaluation.Agent.AgentId для источника событий OnContactEvaluationSubmit.
(строка)
CreateCaseAction -> (структура)
Информация о действии создания дела.
Поддерживается только для TriggerEventSource значений: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable .
Fields -> (список)
Массив объектов с данными Field ID и Value.
(структура)
Объект для значений поля дела.
Id -> (строка)
Value -> (структура)
Объединение потенциальных типов значений поля.
BooleanValue -> (булево)
DoubleValue -> (число с плавающей точкой)
EmptyValue -> (структура)
StringValue -> (строка)
TemplateId -> (строка)
UpdateCaseAction -> (структура)
Информация о действии обновления дела.
Поддерживается только для TriggerEventSource значений: OnCaseCreate | OnCaseUpdate .
Fields -> (список)
Массив объектов с данными Field ID и Value.
(структура)
Объект для значений поля дела.
Id -> (строка)
Value -> (структура)
Объединение потенциальных типов значений поля.
BooleanValue -> (булево)
DoubleValue -> (число с плавающей точкой)
EmptyValue -> (структура)
StringValue -> (строка)
AssignSlaAction -> (структура)
Информация об действии назначения SLA.
SlaAssignmentType -> (строка)
CaseSlaConfiguration -> (структура)
Настройка SLA для назначения SLA дела.
Name -> (строка)
Type -> (строка)
FieldId -> (строка)
TargetFieldValues -> (список)
Представляет список целевых значений поля для указанного в CaseSlaConfiguration fieldId. SLA считается выполненным, если хотя бы одно из этих целевых значений поля соответствует фактическому значению поля.
(структура)
Объект для хранения объединения значений поля.
BooleanValue -> (булево)
DoubleValue -> (число с плавающей точкой)
EmptyValue -> (структура)
StringValue -> (строка)
TargetSlaMinutes -> (целое число)
EndAssociatedTasksAction -> (структура)
Информация о действии завершения связанных задач.
Поддерживается только для TriggerEventSource значений: OnCaseUpdate .
SubmitAutoEvaluationAction -> (структура)
Информация об действии отправки автоматической оценки.
EvaluationFormId -> (строка)
Синтаксис JSON:
[
{
"ActionType": "CREATE_TASK"|"ASSIGN_CONTACT_CATEGORY"|"GENERATE_EVENTBRIDGE_EVENT"|"SEND_NOTIFICATION"|"CREATE_CASE"|"UPDATE_CASE"|"ASSIGN_SLA"|"END_ASSOCIATED_TASKS"|"SUBMIT_AUTO_EVALUATION",
"TaskAction": {
"Name": "string",
"Description": "string",
"ContactFlowId": "string",
"References": {"string": {
"Value": "string",
"Type": "URL"|"ATTACHMENT"|"CONTACT_ANALYSIS"|"NUMBER"|"STRING"|"DATE"|"EMAIL"|"EMAIL_MESSAGE",
"Status": "AVAILABLE"|"DELETED"|"APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
"Arn": "string",
"StatusReason": "string"
}
...}
},
"EventBridgeAction": {
"Name": "string"
},
"AssignContactCategoryAction": {
},
"SendNotificationAction": {
"DeliveryMethod": "EMAIL",
"Subject": "string",
"Content": "string",
"ContentType": "PLAIN_TEXT",
"Recipient": {
"UserTags": {"string": "string"
...},
"UserIds": ["string", ...]
}
},
"CreateCaseAction": {
"Fields": [
{
"Id": "string",
"Value": {
"BooleanValue": true|false,
"DoubleValue": double,
"EmptyValue": {
},
"StringValue": "string"
}
}
...
],
"TemplateId": "string"
},
"UpdateCaseAction": {
"Fields": [
{
"Id": "string",
"Value": {
"BooleanValue": true|false,
"DoubleValue": double,
"EmptyValue": {
},
"StringValue": "string"
}
}
...
]
},
"AssignSlaAction": {
"SlaAssignmentType": "CASES",
"CaseSlaConfiguration": {
"Name": "string",
"Type": "CaseField",
"FieldId": "string",
"TargetFieldValues": [
{
"BooleanValue": true|false,
"DoubleValue": double,
"EmptyValue": {
},
"StringValue": "string"
}
...
],
"TargetSlaMinutes": long
}
},
"EndAssociatedTasksAction": {
},
"SubmitAutoEvaluationAction": {
"EvaluationFormId": "string"
}
}
...
]
--publish-status (строка)
Статус публикации правила.
Возможные значения:
DRAFTPUBLISHED
--client-token (строка)
--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 (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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком 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.
Вывод
RuleArn -> (string)
RuleId -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.