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

UpdateCampaign

Aktualisiert eine Kampagne, um eine neu trainierte Lösungsversion mit einer vorhandenen Kampagne bereitzustellen, die Ihrer Kampagne zu ändern oder die Konfiguration Ihrer Kampagne zu ändern. minProvisionedTPS Beispielsweise können Sie für eine bestehende Kampagne enableMetadataWithRecommendations den Wert auf „true“ setzen.

Um eine Kampagne so zu aktualisieren, dass sie automatisch mit der neuesten Lösungsversion gestartet wird, geben Sie Folgendes an:

  • Geben Sie für den SolutionVersionArn Parameter den Amazon-Ressourcennamen (ARN) Ihrer Lösung im SolutionArn/$LATEST Format an.

  • Stellen Sie im campaignConfig syncWithLatestSolutionVersion auf eintrue.

Um eine Kampagne zu aktualisieren, muss der Kampagnenstatus AKTIV oder CREATE FAILED lauten. Überprüfen Sie den Kampagnenstatus mithilfe der DescribeCampaignOperation.

Anmerkung

Sie können immer noch Empfehlungen von einer Kampagne erhalten, während ein Update läuft. Die Kampagne verwendet die vorherige Lösungsversion und Kampagnenkonfiguration, um Empfehlungen zu generieren, bis der aktuelle Status der Kampagnenaktualisierung lautetActive.

Weitere Informationen zum Aktualisieren einer Kampagne, einschließlich Codebeispielen, finden Sie unter Kampagne aktualisieren. Weitere Informationen zu Kampagnen finden Sie unter Kampagne erstellen.

Anforderungssyntax

{
   "campaignArn": "string",
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "solutionVersionArn": "string"
}

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

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:.*:.*:.+

Erforderlich: Ja

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

solutionVersionArn

Der Amazon-Ressourcenname (ARN) eines neuen Modells, das bereitgestellt 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 eingestellt haben 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: 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

Derselbe Kampagnen-ARN wie in der Anfrage angegeben.

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

ResourceInUseException

Die angegebene Ressource wird verwendet.

HTTP Status Code: 400

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

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: