create-recommender-configuration

Описание

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

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

Синтаксис

  create-recommender-configuration
--create-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]

Параметры

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

Description -> (строка)

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

Id -> (строка)

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

LastModifiedDate -> (строка)

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

Name -> (строка)

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

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. Это число определяет, сколько рекомендованных элементов доступно для использования в переменных сообщения.