Spec-Zone.ru › AWS CLI v2

[ aws . personalize ]

create-campaign

Описание

Предупреждение

Вы понесете расходы на кампанию, пока она активна. Чтобы избежать ненужных затрат, удалите кампанию по завершении. Сведения о затратах на кампании см. в разделе Цены Amazon Personalize .

Создает кампанию, которая развертывает версию решения. При вызове клиентом API GetRecommendations и GetPersonalizedRanking в запросе указывается кампания.

Минимальное предоставленное значение TPS и автоматическое масштабирование

Предупреждение

Высокое значение minProvisionedTPS увеличит ваши затраты. Рекомендуется начинать с 1 для minProvisionedTPS (значение по умолчанию). Отслеживайте использование с помощью метрик Amazon CloudWatch и увеличивайте minProvisionedTPS по мере необходимости.

При создании кампании Amazon Personalize вы можете указать минимальное предоставленное значение транзакций в секунду (minProvisionedTPS ) для кампании. Это базовый пропускной транзакций для кампании, предоставленный Amazon Personalize. Он задает минимальную плату за кампанию во время ее активности. Транзакция — это один запрос на GetRecommendations или GetPersonalizedRanking. Значение по умолчанию minProvisionedTPS составляет 1.

Если значение TPS превысит значение minProvisionedTPS , Amazon Personalize автоматически масштабирует предоставленную емкость вверх и вниз, но никогда не ниже значения minProvisionedTPS . Есть небольшая задержка при увеличении емкости, которая может привести к потере транзакций. При уменьшении трафика емкость возвращается к значению minProvisionedTPS .

Вам взимается плата за минимальное предоставленное значение TPS или, если ваши запросы превышают значение minProvisionedTPS , фактическое значение TPS. Фактическое значение TPS — общее количество запросов на рекомендации. Рекомендуется начинать с низкого minProvisionedTPS , отслеживать использование с помощью метрик Amazon CloudWatch и затем увеличивать minProvisionedTPS по мере необходимости.

Дополнительные сведения о затратах на кампании см. в разделе Цены Amazon Personalize .

Статус

Кампания может находиться в одном из следующих состояний:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -или- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

Чтобы получить статус кампании, вызовите DescribeCampaign .

Примечание

Подождите, пока status кампании будет ACTIVE , прежде чем запрашивать у кампании рекомендации.

Связанные API

  • ListCampaigns
  • DescribeCampaign
  • UpdateCampaign
  • DeleteCampaign

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

Резюме

  create-campaign
--name <value>
--solution-version-arn <value>
[--min-provisioned-tps <value>]
[--campaign-config <value>]
[--tags <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]

Параметры

--name (строка)

Имя новой кампании. Имя кампании должно быть уникальным в рамках вашей учетной записи.

--solution-version-arn (строка)

Amazon Resource Name (ARN) обученной модели, подлежащей развертыванию с кампанией. Чтобы указать последнюю версию решения вашей модели, укажите ARN вашей модели в формате SolutionArn/$LATEST. Вам необходимо использовать этот формат, если вы зададите syncWithLatestSolutionVersion значение True в CampaignConfig .

Чтобы развернуть модель, которая не является последней версией решения вашей модели, укажите ARN версии решения.

Дополнительные сведения об автоматическом обновлении кампаний см. в разделе Включение автоматического обновления кампаний .

--min-provisioned-tps (целое число)

Указывает запрашиваемое минимальное предоставленное значение транзакций (рекомендаций) в секунду, которое Amazon Personalize будет поддерживать. Высокое значение minProvisionedTPS увеличит ваш счет. Рекомендуется начинать с 1 для minProvisionedTPS (значение по умолчанию). Отслеживайте использование с помощью метрик Amazon CloudWatch и увеличивайте minProvisionedTPS по мере необходимости.

--campaign-config (структура)

Детали конфигурации кампании.

itemExplorationConfig -> (отображение)

Указывает гиперпараметры конфигурации исследования пунктов, включая explorationWeight и explorationItemAgeCutOff , которые вы хотите использовать для настройки объема исследования пунктов Amazon Personalize при рекомендации пунктов. Предоставляйте данные itemExplorationConfig только в том случае, если ваше решение использует шаблон User-Personalization.

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

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

enableMetadataWithRecommendations -> (булево)

Включено ли метаданные с рекомендациями для кампании. Если включено, вы можете указать столбцы из набора данных Items в своем запросе на рекомендации. Amazon Personalize возвращает эти данные для каждого пункта в ответе на рекомендации. Сведения о включении метаданных для кампании см. в разделе Включение метаданных в рекомендации для кампании .

Если вы включите метаданные в рекомендации, вы понесете дополнительные расходы. Дополнительные сведения см. в разделе Цены Amazon Personalize .

syncWithLatestSolutionVersion -> (булево)

Обновляется ли кампания автоматически для использования последней версии решения (обученной модели) решения. Если вы укажете значение True , вам необходимо указать ARN вашей модели для параметра SolutionVersionArn. Он должен быть в формате SolutionArn/$LATEST. Значение по умолчанию — False, и вам необходимо вручную обновить кампанию для развертывания последней версии решения.

Дополнительные сведения об автоматическом обновлении кампаний см. в разделе Включение автоматического обновления кампаний .

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

itemExplorationConfig={KeyName1=string,KeyName2=string},enableMetadataWithRecommendations=boolean,syncWithLatestSolutionVersion=boolean

Синтаксис JSON:

{
  "itemExplorationConfig": {"string": "string"
    ...},
  "enableMetadataWithRecommendations": true|false,
  "syncWithLatestSolutionVersion": true|false
}

--tags (список)

Список тегов для применения к кампании.

(структура)

Дополнительные метаданные, которые вы применяете к ресурсам, чтобы помочь вам категоризировать и упорядочить их. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Дополнительные сведения см. в разделе Добавление тегов к ресурсам Amazon Personalize .

tagKey -> (строка)

Одна часть пары «ключ-значение», составляющей тег. Ключ — это общее метка, которая действует как категория для более конкретных значений тега.

tagValue -> (строка)

Необязательная часть пары «ключ-значение», составляющей тег. Значение служит описателем в категории тега (ключ).

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

tagKey=string,tagValue=string ...

Синтаксис JSON:

[
  {
    "tagKey": "string",
    "tagValue": "string"
  }
  ...
]

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

Вывод

campaignArn -> (строка)

Amazon Resource Name (ARN) кампании.

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

Spec-Zone.ru

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