CreateCampaign - Amazon Personalize
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateCampaign

Wichtig

Es fallen Kampagnenkosten an, solange sie aktiv ist. Um unnötige Kosten zu vermeiden, stellen Sie sicher, dass Sie die Kampagne löschen, wenn Sie fertig sind. Informationen zu den Kampagnenkosten finden Sie unter Amazon Personalize Personalize-Preise.

Erstellt eine Kampagne, die eine Lösungsversion bereitstellt. Wenn ein Kunde die GetPersonalizedRankingAPIs GetRecommendationsund aufruft, wird in der Anfrage eine Kampagne angegeben.

Mindestens bereitgestelltes TPS und automatische Skalierung

Wichtig

Ein Hoch erhöht minProvisionedTPS Ihre Kosten. Wir empfehlen, mit 1 für zu beginnen minProvisionedTPS (Standard). Verfolgen Sie Ihre Nutzung anhand von CloudWatch Amazon-Metriken und erhöhen Sie minProvisionedTPS diese bei Bedarf.

Wenn Sie eine Amazon Personalize Personalize-Kampagne erstellen, können Sie die Mindestanzahl an bereitgestellten Transaktionen pro Sekunde (minProvisionedTPS) für die Kampagne angeben. Dies ist der grundlegende Transaktionsdurchsatz für die von Amazon Personalize bereitgestellte Kampagne. Es legt die Mindestabrechnungsgebühr für die Kampagne fest, solange sie aktiv ist. Eine Transaktion ist eine einzelne GetRecommendations oder eine GetPersonalizedRanking Anfrage. Die Standardeinstellung minProvisionedTPS ist 1.

Steigt Ihr TPS über den Wert hinausminProvisionedTPS, skaliert Amazon Personalize die bereitgestellte Kapazität automatisch nach oben und unten, aber niemals darunter. minProvisionedTPS Bei der Erhöhung der Kapazität kommt es zu einer kurzen Zeitverzögerung, die zum Verlust von Transaktionen führen kann. Wenn Ihr Traffic abnimmt, kehrt die Kapazität auf die zurückminProvisionedTPS.

Ihnen wird das bereitgestellte Mindest-TPS oder, falls Ihre Anfragen das TPS überschreitenminProvisionedTPS, das tatsächliche TPS in Rechnung gestellt. Der tatsächliche TPS ist die Gesamtzahl der von Ihnen gestellten Empfehlungsanfragen. Wir empfehlen, mit einem niedrigen Wert zu beginnenminProvisionedTPS, Ihre Nutzung anhand von CloudWatch Amazon-Metriken zu verfolgen und den Wert dann bei minProvisionedTPS Bedarf zu erhöhen.

Weitere Informationen zu den Kampagnenkosten finden Sie unter Amazon Personalize Personalize-Preise.

Status

Eine Kampagne kann sich in einem der folgenden Zustände befinden:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -oder- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Rufen Sie an, um den Kampagnenstatus zu erfahren DescribeCampaign.

Anmerkung

Warten Sie, bis status die Kampagne gestartet ist, ACTIVE bevor Sie die Kampagne um Empfehlungen bitten.

Verbundene APIs

Anforderungssyntax

{
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "name": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

campaignConfig

Die Konfigurationsdetails einer Kampagne.

Typ: CampaignConfig Objekt

Erforderlich: Nein

minProvisionedTPS

Gibt die angeforderte Mindestanzahl bereitgestellter Transaktionen (Empfehlungen) pro Sekunde an, die Amazon Personalize unterstützt. Ein Hoch erhöht minProvisionedTPS Ihre Rechnung. Wir empfehlen, mit 1 für zu beginnen minProvisionedTPS (Standard). Verfolgen Sie Ihre Nutzung anhand von CloudWatch Amazon-Metriken und erhöhen Sie minProvisionedTPS diese bei Bedarf.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1.

Erforderlich: Nein

name

Ein Name für die neue Kampagne. Der Kampagnenname muss in Ihrem Konto eindeutig sein.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 63 Zeichen.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Erforderlich: Ja

solutionVersionArn

Der Amazon-Ressourcenname (ARN) des trainierten Modells, das mit der Kampagne eingesetzt werden soll. Um die neueste Lösungsversion Ihrer Lösung anzugeben, geben Sie den ARN Ihrer Lösung im SolutionArn/$LATEST Format an. Sie müssen dieses Format verwenden, wenn Sie True in der syncWithLatestSolutionVersion auf einstellen CampaignConfig.

Um ein Modell bereitzustellen, das nicht die neueste Lösungsversion Ihrer Lösung ist, geben Sie den ARN der Lösungsversion an.

Weitere Informationen zu automatischen Kampagnen-Updates finden Sie unter Automatische Kampagnen-Updates aktivieren.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Erforderlich: Ja

tags

Eine Liste von Tags, die auf die Kampagne angewendet werden sollen.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 200 Elemente.

Erforderlich: Nein

Antwortsyntax

{
   "campaignArn": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

campaignArn

Der Amazon-Ressourcennamen (ARN) der Kampagne.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Fehler

InvalidInputException

Geben Sie einen gültigen Wert für das Feld oder den Parameter an.

HTTP Status Code: 400

LimitExceededException

Das Limit für die Anzahl der Anfragen pro Sekunde wurde überschritten.

HTTP Status Code: 400

ResourceAlreadyExistsException

Die angegebene Ressource ist bereits vorhanden.

HTTP Status Code: 400

ResourceInUseException

Die angegebene Ressource wird verwendet.

HTTP Status Code: 400

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

HTTP Status Code: 400

TooManyTagsException

Sie haben die maximale Anzahl von Tags überschritten, die Sie auf diese Ressource anwenden können.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: