Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

update-rule

Описание

Обновляет правило для указанного экземпляра Amazon Connect.

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

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

Синтаксис

  update-rule
--rule-id <value>
--instance-id <value>
--name <value>
--function <value>
--actions <value>
--publish-status <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]

Параметры

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

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

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

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

--name (строка)

Название правила. Вы можете изменить название только если TriggerEventSource имеет одно из следующих значений: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

--function (строка)

Условие правила.

--actions (список)

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

(структура)

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

ActionType -> (строка)

Тип действия, создающего правило.

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

Информация о действии задачи. Это поле обязательно, если TriggerEventSource имеет одно из следующих значений: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Name -> (строка)

Название. Поддерживает инъекцию переменных. Дополнительную информацию см. в справке JSONPath в руководстве администратора Amazon Connect.

Description -> (строка)

Описание. Поддерживает инъекцию переменных. Дополнительную информацию см. в справке JSONPath в руководстве администратора Amazon Connect.

ContactFlowId -> (строка)

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

References -> (массив)

Информация о ссылке, когда referenceType равно URL. В противном случае, null. (Поддерживает инъекцию переменных в поле Value.)

key -> (строка)

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

Отформатированные данные о контакте, используемые агентами для завершения запроса на контакт. Вы можете иметь до 4096 байтов UTF-8 для всех ссылок на контакт.

Value -> (строка)

Действительное значение для ссылки. Например, для ссылки URL, отформатированный URL-адрес, отображаемый агенту в Панели управления контактами (CCP).

Type -> (строка)

Тип ссылки. DATE должен быть типа отметки времени эпохи.

Status -> (строка)

Статус типа ссылки на вложение.

Arn -> (строка)

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

Содержание уведомления. Поддерживает инъекцию переменных. Дополнительную информацию см. в справке JSONPath в руководстве администратора Amazon Connect.

ContentType -> (строка)

Формат типа содержимого.

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

Получатель уведомления.

UserTags -> (массив)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Теги”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }. Пользователи 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 -> (строка)

Тип назначения SLA.

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

Настройка SLA для назначения SLA к делу.

Name -> (строка)

Название SLA.

Type -> (строка)

Тип SLA для CaseSlaAssignmentType.

FieldId -> (строка)

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

TargetFieldValues -> (список)

Представляет список целевых значений поля для указанного в CaseSlaConfiguration fieldId. SLA считается выполненным, если хотя бы одно из этих целевых значений поля совпадает с фактическим значением поля.

(структура)

Объект для хранения объединения значений полей.

BooleanValue -> (логическое)

Тип значения логического типа.

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

Тип значения двойного типа.

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

Пустое значение.

StringValue -> (строка)

Тип значения строки.

TargetSlaMinutes -> (длинное)

Целевое время в минутах, в течение которого SLA должно быть выполнено.

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

Статус публикации правила.

Возможные значения:

  • DRAFT
  • PUBLISHED

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

Вывод

Нет

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

Spec-Zone.ru

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