update-recommender-configuration

Описание

Обновляет конфигурацию Amazon Pinpoint для модели рекомендаций.

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

Синтаксис

  update-recommender-configuration
--recommender-id <value>
--update-recommender-configuration <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]

Параметры

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

Уникальный идентификатор конфигурации модели рекомендаций. Этот идентификатор отображается как Идентификатор рекомендаций на консоли Amazon Pinpoint.

--update-recommender-configuration (структура)

Указывает параметры конфигурации Amazon Pinpoint для получения и обработки данных рекомендаций из модели рекомендаций.

Атрибуты -> (словарь)

Словарь пар «ключ-значение», определяющий 1-10 пользовательских атрибутов или атрибутов конечной точки в зависимости от значения свойства RecommendationProviderIdType. Каждый из этих атрибутов временно хранит рекомендованный элемент, полученный из модели рекомендаций и отправленный в функцию AWS Lambda для дополнительной обработки. Каждый атрибут может использоваться как переменная сообщения в шаблоне сообщения.

В словаре ключ — это имя пользовательского атрибута, а значение — это пользовательское отображаемое имя для этого атрибута. Отображаемое имя отображается в Поиске атрибутов редактора шаблонов на консоли Amazon Pinpoint. На эти имена наложены следующие ограничения:

Имя атрибута должно начинаться с буквы или цифры и может содержать до 50 символов. Символами могут быть буквы, цифры, символ подчеркивания (_) или дефисы (-). Имена атрибутов чувствительны к регистру и должны быть уникальными.
Отображаемое имя атрибута должно начинаться с буквы или цифры и может содержать до 25 символов. Символами могут быть буквы, цифры, пробелы, символ подчеркивания (_) или дефисы (-).

Этот объект необходим, если конфигурация вызывает функцию AWS Lambda (RecommendationTransformerUri) для обработки данных рекомендаций. В противном случае не включайте этот объект в свой запрос.

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

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

Описание -> (строка)

Пользовательское описание конфигурации для модели рекомендаций. Описание может содержать до 128 символов. Символами могут быть буквы, цифры, пробелы или следующие символы: _ ; () , ‐.

Имя -> (строка)

Пользовательское имя конфигурации для модели рекомендаций. Имя должно начинаться с буквы или цифры и может содержать до 128 символов. Символами могут быть буквы, цифры, пробелы, символ подчеркивания (_) или дефисы (-).

RecommendationProviderIdType -> (строка)

Тип идентификатора Amazon Pinpoint, который нужно связать с уникальными идентификаторами пользователей в модели рекомендаций. Это значение позволяет модели использовать данные атрибутов и событий, специфичные для определенной конечной точки или пользователя в приложении Amazon Pinpoint. Допустимые значения:

PINPOINT_ENDPOINT_ID — связывает каждого пользователя в модели с определенной конечной точкой в Amazon Pinpoint. Данные коррелируются на основе идентификаторов конечных точек в Amazon Pinpoint. Это значение по умолчанию.
PINPOINT_USER_ID — связывает каждого пользователя в модели с определенным пользователем и конечной точкой в Amazon Pinpoint. Данные коррелируются на основе идентификаторов пользователей в Amazon Pinpoint. Если вы укажете это значение, определение конечной точки в Amazon Pinpoint должно указывать как идентификатор пользователя (UserId), так и идентификатор конечной точки. В противном случае сообщения не будут отправлены на конечную точку пользователя.

RecommendationProviderRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на получение данных рекомендаций из модели рекомендаций.

RecommendationProviderUri -> (строка)

Идентификатор ресурса Amazon (ARN) модели рекомендаций для получения данных рекомендаций. Это значение должно совпадать с ARN кампании Amazon Personalize.

RecommendationTransformerUri -> (строка)

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

RecommendationsDisplayName -> (строка)

Пользовательское отображаемое имя стандартного атрибута конечной точки или пользователя (RecommendationItems), который временно хранит рекомендованные элементы для каждой конечной точки или пользователя в зависимости от значения свойства RecommendationProviderIdType. Это значение необходимо, если конфигурация не вызывает функцию AWS Lambda (RecommendationTransformerUri) для выполнения дополнительной обработки данных рекомендаций.

Это имя отображается в Поиске атрибутов редактора шаблонов на консоли Amazon Pinpoint. Длина имени может составлять до 25 символов. Символами могут быть буквы, цифры, пробелы, символ подчеркивания (_) или дефисы (-). Ограничения на значения атрибутов не распространяются.

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

Количество рекомендованных элементов для извлечения из модели для каждой конечной точки или пользователя в зависимости от значения свойства RecommendationProviderIdType. Это число определяет количество рекомендованных элементов, доступных для использования в переменных сообщения. Минимальное значение — 1. Максимальное значение — 5. Значение по умолчанию — 5.

Чтобы использовать несколько рекомендованных элементов и пользовательских атрибутов с переменными сообщений, необходимо использовать функцию AWS Lambda (RecommendationTransformerUri) для выполнения дополнительной обработки данных рекомендаций.

Сокращенный синтаксис:

Attributes={KeyName1=string,KeyName2=string},Description=string,Name=string,RecommendationProviderIdType=string,RecommendationProviderRoleArn=string,RecommendationProviderUri=string,RecommendationTransformerUri=string,RecommendationsDisplayName=string,RecommendationsPerMessage=integer

Синтаксис JSON:

{
  "Attributes": {"string": "string"
    ...},
  "Description": "string",
  "Name": "string",
  "RecommendationProviderIdType": "string",
  "RecommendationProviderRoleArn": "string",
  "RecommendationProviderUri": "string",
  "RecommendationTransformerUri": "string",
  "RecommendationsDisplayName": "string",
  "RecommendationsPerMessage": integer
}

--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
таблица
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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

Предоставляет информацию о настройках Amazon Pinpoint для извлечения и обработки данных из модели рекомендаций.

Атрибуты -> (отображение)

Отображение, определяющее 1-10 пользовательских конечных точек или атрибутов пользователей, в зависимости от значения свойства RecommendationProviderIdType. Каждый из этих атрибутов временно хранит рекомендованный элемент, который извлекается из модели рекомендаций и отправляется в функцию AWS Lambda для дополнительной обработки. Каждый атрибут может использоваться как переменная сообщения в шаблоне сообщения.

Это значение равно null, если конфигурация не вызывает функцию AWS Lambda (RecommendationTransformerUri) для выполнения дополнительной обработки данных рекомендаций.

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

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

CreationDate -> (строка)

Дата создания конфигурации для модели рекомендаций в формате расширенного ISO 8601.

Описание -> (строка)

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

Id -> (строка)

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

LastModifiedDate -> (строка)

Дата последнего изменения конфигурации модели рекомендаций в формате расширенного ISO 8601.

Имя -> (строка)

Пользовательское имя конфигурации для модели рекомендаций.

RecommendationProviderIdType -> (строка)

Тип идентификатора Amazon Pinpoint, связанный с уникальными идентификаторами пользователей в модели рекомендаций. Это значение позволяет модели использовать данные атрибутов и событий, специфичные для определённой конечной точки или пользователя в приложении Amazon Pinpoint. Возможные значения:

PINPOINT_ENDPOINT_ID - Каждый пользователь в модели связан с определённой конечной точкой в Amazon Pinpoint. Данные коррелируются на основе идентификаторов конечных точек в Amazon Pinpoint. Это значение по умолчанию.
PINPOINT_USER_ID - Каждый пользователь в модели связан с определённым пользователем и конечной точкой в Amazon Pinpoint. Данные коррелируются на основе идентификаторов пользователей в Amazon Pinpoint. Если это значение указано, определение конечной точки в Amazon Pinpoint должно указывать как идентификатор пользователя (UserId), так и идентификатор конечной точки. В противном случае сообщения не будут отправлены на конечную точку пользователя.

RecommendationProviderRoleArn -> (строка)

Amazon Resource Name (ARN) роли AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на извлечение данных рекомендаций из модели рекомендаций.

RecommendationProviderUri -> (строка)

Amazon Resource Name (ARN) модели рекомендаций, из которой Amazon Pinpoint извлекает данные рекомендаций. Это ARN кампании Amazon Personalize.

RecommendationTransformerUri -> (строка)

Имя или Amazon Resource Name (ARN) функции AWS Lambda, которую Amazon Pinpoint вызывает для выполнения дополнительной обработки данных рекомендаций, извлечённых из модели рекомендаций.

RecommendationsDisplayName -> (строка)

Пользовательское отображаемое имя стандартного атрибута конечной точки или пользователя (RecommendationItems), который временно хранит рекомендованные элементы для каждой конечной точки или пользователя, в зависимости от значения свойства RecommendationProviderIdType. Это имя отображается в Поиске атрибутов редактора шаблонов в консоли Amazon Pinpoint.

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

Количество рекомендованных элементов, извлекаемых из модели для каждой конечной точки или пользователя, в зависимости от значения свойства RecommendationProviderIdType. Это число определяет количество рекомендованных элементов, доступных для использования в переменных сообщений.