APIs für berechnete Attribute - Amazon Connect

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.

APIs für berechnete Attribute

Sie können die folgenden APIs für berechnete Attribute von Kundenprofilen verwenden

CreateCalculatedAttributeDefinition

CreateCalculatedAttributeDefinition

Erstellen Sie ein neues berechnetes Attribut. Dazu ist ein vorhandener Objekttyp in der Domäne erforderlich. Sie können Attribute, die Sie aus einem einzelnen Quellobjekt abrufen möchten, und die mathematischen Operationen, die auf sie insgesamt angewendet werden sollen, sowie den Zeitraum und die Anzahl der Objekte definieren.

Nach der Erstellung werden neue Objektdaten, die in Kundenprofile aufgenommen wurden, in das berechnete Attribut aufgenommen, das mithilfe der GetCalculatedAttributeForProfile API für ein Profil abgerufen werden kann. Durch die Definition eines berechneten Attributs wird es für alle Profile innerhalb einer Domain verfügbar. Jedes berechnete Attribut kann nur auf ein ObjectType und höchstens zwei Felder aus diesem Feld verweisen ObjectType.

Anforderung

POST /domains/DomainName/calculated-attributes/CalculatedAttributeName
{ "CalculatedAttributeName": "string", "DisplayName": "string", "Description": "string", "AttributeDetails": { "Attributes": [ { "Name": "string" } ... ], "Expression": "string", }, "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE", "Conditions": { "Range": { "Value": "number", "Units": "string" }, "ObjectCount": "number", "Threshold": { "Value": "string", "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO" } }, "Tags": {} }

Antwort

{ "CalculatedAttributeName": "string", "DisplayName": "string", "Description": "string", "AttributeDetails": { "Attributes": [ { "Name": "string" } ... ], "Expression": "string", }, "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE" "Conditions": { "Range": { "Value": "number", "Units": "string" }, "ObjectCount": "number", "Threshold": { "Value": "string", "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO" } }, "CreatedAt": number, "LastUpdatedAt": number, "Tags": {} }

Hauptteil der Anfrage

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • DisplayName

    Der Anzeigename des berechneten Attributs.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Erforderlich: Nein

  • Beschreibung

    Die Beschreibung des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 1000 Zeichen.

    • Required: No

  • AttributeDetails

    Einzelheiten zu den in der Definition verwendeten Attributen und den mathematischen Operationen zwischen den Attributen. Sehen Sie sich die folgenden Komponenten an:

    • Attribute

      Eine Liste von Attributelementen, die im mathematischen Ausdruck angegeben sind.

      • AttributeItem

        Die Details eines einzelnen Attributelements, das im mathematischen Ausdruck angegeben ist.

        • Name

          • Der Name eines Attributs, das in einem Profilobjekttyp definiert ist.

          • Typ: Zeichenfolge

    • Expression

      Mathematischer Ausdruck, der für Attributelemente in der Attributliste ausgeführt wird. Jedes Element im Ausdruck sollte der Struktur von\ "{folgenObjectTypeName. AttributeName}\“.

      • Beispiel: {ObjA.AttributeA} - {ObjA.AttributeB}

      • Typ: Zeichenfolge

      • Wir unterstützen nur die folgenden mathematischen Operationen: + - * /

      • Sobald eine berechnete Attributdefinition erstellt wurde, können Sie keine Änderungen am Ausdruck vornehmen

  • Bedingungen

    Definiert die Kriterien und den Schwellenwert für die aggregierte Berechnung von Attributen.

    • Typ: Bedingungsobjekt

      • Bereich

      • ObjectCount

      • Schwellenwert

  • Bereich

    Der relative Zeitraum, über den Daten in der Aggregation enthalten sind.

    • Typ: Range-Objekt

      • Wert: Die Zeitdauer der angegebenen Einheiten

      • Einheit: Zeiteinheit

        • Gültige Werte: Tage

    • Erforderlich: Ja

    • Anfänglicher Geltungsbereich: Maximal 366 Tage

  • ObjectCount

    Die Anzahl der Profilobjekte, die für das berechnete Attribut verwendet wurden.

    • Typ: Zahl

    • Bereich: 1 bis 100

    • Required: No

  • Schwellenwert

    Die Vergleichslogik zur Generierung eines berechneten Attributs „Wahr/Falsch“.

    • Typ: Threshold-Objekt

      • Wert

        • Der Wert des Schwellenwerts

        • Typ: Zeichenfolge

        • Required: No

      • Operator

        • Der Operator des Schwellenwerts

        • Typ: ENUM

        • Zulässige Werte:

          • GRÖSSER ALS

          • KLEINER_ALS

          • GLEICH_WIE

          • NICHT_GLEICH_

    • Required: No

  • Statistik

    Der Aggregationsvorgang, der für das berechnete Attribut ausgeführt werden soll.

    • Typ: ENUM

    • Zulässige Werte:

      • ERSTES_VORKOMMEN

      • LETZTES_EREIGNIS

      • COUNT

      • SUM

      • MINIMUM

      • MAXIMAL

      • DURCHSCHNITTLICH

      • MAXIMALES VORKOMMEN

UpdateCalculatedAttributeDefinition

UpdateCalculatedAttributeDefinition

Aktualisieren Sie eine berechnete Attributdefinition. Aktualisierungen beschränken sich auf den Anzeigenamen, die Beschreibung, den Zeitraum, die Anzahl der Objekte und den Schwellenwert. Diese API unterstützt teilweise Aktualisierungen, sodass nur die Parameter enthalten sein müssen, die aktualisiert werden müssen.

Beachten Sie bei der Aktualisierung der Bedingungen, dass eine Erhöhung des Datumsbereichs eines berechneten Attributs nicht dazu führt, dass historische Daten berücksichtigt werden, die über dem aktuellen Zeitraum liegen.

Anforderung

PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName
{ "DisplayName": "string", "Description": "string", "Conditions": { "Range": { "Value": "number", "Units": "string" }, "ObjectCount": "number", "Threshold": { "Value": "string", "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO" } } }

Antwort

{ "CalculatedAttributeName": "string", "DisplayName": "string", "Description": "string", "AttributeDetails": { "Attributes": [ { "Name": "string" } ... ], "Expression": "string", }, "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE" "Conditions": { "Range": { "Value": "number", "Units": "string" }, "ObjectCount": "number", "Threshold": { "Value": "string", "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO" } }, "CreatedAt": number, "LastUpdatedAt": number, "Tags": {} }

Hauptteil der Anfrage

  • DisplayName

    Der Anzeigename des berechneten Attributs.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Erforderlich: Nein

  • Beschreibung

    Die Beschreibung des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 1000 Zeichen.

    • Required: No

  • Bedingungen

    Definiert die Kriterien und den Schwellenwert für die Aggregation von berechneten Attributen.

    • Typ: Bedingungsobjekt

      • Bereich

      • ObjectCount

      • Schwellenwert

  • Bereich

    Der relative Zeitraum, über den Daten in der Aggregation enthalten sind.

    • Typ: Range-Objekt

      • Wert: Die Zeitdauer der angegebenen Einheiten

      • Einheit: Zeiteinheit

        • Gültige Werte: Tage

    • Erforderlich: Ja

    • Anfänglicher Geltungsbereich: Maximal 366 Tage

  • ObjectCount

    Die Anzahl der Profilobjekte, die für das berechnete Attribut verwendet wurden.

    • Typ: Zahl

    • Bereich: 1 bis 100

    • Required: No

  • Schwellenwert

    Die Vergleichslogik zur Generierung eines berechneten Attributs „Wahr/Falsch“.

    • Typ: Threshold-Objekt

      • Wert

        • Der Wert des Schwellenwerts

        • Typ: Zeichenfolge

        • Required: No

      • Operator

        • Der Operator des Schwellenwerts

        • Typ: ENUM

        • Zulässige Werte:

          • GRÖSSER ALS

          • KLEINER_ALS

          • GLEICH_WIE

          • NICHT_GLEICH_

    • Required: No

GetCalculatedAttributeDefinition

GetCalculatedAttributeDefinition

Ruft eine berechnete Attributdefinition ab.

Anforderung

GET /domains/DomainName/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort

{ "CalculatedAttributeName": "string", "DisplayName": "string", "Description": "string", "AttributeDetails": { "Attributes": [ { "Name": "string" } ... ], "Expression": "string", }, "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE" "Conditions": { "Range": { "Value": "number", "Units": "string" }, "ObjectCount": "number", "Threshold": { "Value": "string", "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO" } }, "CreatedAt": number, "LastUpdatedAt": number, "Tags": {} }

URI-Anforderungsparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

DeleteCalculatedAttributeDefinition

DeleteCalculatedAttributeDefinition

Löscht eine bestehende Definition eines berechneten Attributs. Beachten Sie, dass das Löschen eines berechneten Standardattributs möglich ist. Nach dem Löschen können Sie diese Aktion jedoch nicht mehr rückgängig machen und müssen es mithilfe der CreateCalculatedAttributeDefinition API selbst neu erstellen, wenn Sie es wieder haben möchten.

Anforderung

DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort

The response does not have a response body.

URI-Anforderungsparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

ListCalculatedAttributeDefinitions

ListCalculatedAttributeDefinitions

Ruft alle berechneten Attributdefinitionen für eine Domäne ab.

Anforderung

GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken

Anforderungstext

The request does not have a request body.

Antwort

{ "Items": [ { "CalculatedAttributeName": "string", "DisplayName": "string", "Description": "string", "CreatedAt": "timestamp", "LastUpdatedAt": "timestamp" }, ... ], "NextToken": "string" }

URI-Anforderungsparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • MaxResults

    Die maximale Anzahl von Objekten, die pro Seite zurückgegeben werden.

    • Gültiger Bereich: Mindestwert 1. Maximalwert von 100

  • NextToken

    Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.

    • Längenbeschränkungen: Minimale Länge von 1. Die maximale Länge beträgt 1024

GetCalculatedAttributeForProfile

GetCalculatedAttributeForProfile

Initiiert die Berechnung und ruft das Ergebnis eines einzelnen berechneten Attributs für ein einzelnes Profil ab.

Anforderung

GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName

Anforderungstext

The request does not have a request body.

Antwort

{ "Name": "string", "DisplayName": "string", "Value": "string", "IsDataPatrial": "string" }

URI-Anforderungsparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • CalculatedAttributeName

    Der eindeutige (pro Domain) Name des berechneten Attributs.

    • Typ: Zeichenfolge

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

ListCalculatedAttributesForProfile

ListCalculatedAttributesForProfile

Initiiert die Berechnung und ruft die Ergebnisse aller berechneten Attribute für ein einzelnes Profil ab.

Anforderung

GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken

Anforderungstext

The request does not have a request body.

Antwort

{ "Items": [ { "CalculatedAttributeName": "string", "DisplayName": "string", "Value": "string", "IsDataPartial" : "string" }, ... ], "NextToken": "string" }

URI-Anforderungsparameter

  • DomainName

    Der eindeutige Name der Domain.

    • Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 64 Zeichen.

    • Pattern: ^[a-zA-Z0-9_-]+$

    • Erforderlich: Ja

  • ProfileId

    • Pattern: [a-f0-9]{32}

    • Erforderlich: Ja

  • MaxResults

    Die maximale Anzahl von Objekten, die pro Seite zurückgegeben werden.

    • Gültiger Bereich: Mindestwert 1. Maximalwert von 100

  • NextToken

    Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.

    • Längenbeschränkungen: Minimale Länge von 1. Die maximale Länge beträgt 1024