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.
# Berechnete Attribute von Amazon Connect Connect-Kundenprofilen APIs
Sie können das folgende berechnete Attribut „Kundenprofile“ verwenden APIs
------
#### [ CreateCalculatedAttributeDefinition ]
**CreateCalculatedAttributeDefinition**
Erstellen eines neuen berechneten Attributs. Hierfür ist ein vorhandener Objekttyp in der Domain erforderlich. Sie können Attribute, die Sie aus einem einzelnen Quellobjekt abrufen möchten sowie die mathematischen Operationen, die insgesamt angewendet werden sollen, den Zeitraum und die Anzahl der Objekte definieren.
Nach der Erstellung werden neue Objektdaten, die in Customer Profiles aufgenommen werden, in das berechnete Attribut mit einbezogen, das dann mithilfe der `GetCalculatedAttributeForProfile`-API für ein Profil abgerufen werden kann. Um auch Verlaufsdaten zu verwenden, setzen Sie den Wert `UseHistoricalData` auf „true“. Die Felder `Readiness` und `Status` in der API-Antwort enthalten Informationen zum Status der Aufnahme von Verlaufsdaten in das berechnete Attribut.
Sobald ein berechnetes Attribut definiert wurde, 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": {}
}
```
**Anforderungstext**
+ **CalculatedAttributeName**
Der eindeutige (pro Domain) Name des berechneten Attributs.
+ Typ: Zeichenfolge
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
+ Pattern: `^[a-zA-Z0-9_-]+$`
+ Erforderlich: Ja
+ **DisplayName**
Der Anzeigename des berechneten Attributs.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 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 beträgt 1 Zeichen. Höchstlänge = 1 000 Zeichen.
+ Erforderlich: Nein
+ **UseHistoricalData**
Gibt an, ob Verlaufsdaten, die vor der Erstellung des berechneten Attributs erfasst wurden, in die Berechnungen einbezogen werden sollen.
+ Typ: Boolescher Wert
+ Erforderlich: Nein
+ **AttributeDetails**
Einzelheiten zu den in der Definition verwendeten Attributen und den mathematischen Operationen zwischen den Attributen. Beachten Sie die folgenden Komponenten:
+ **Attribute**
Eine Liste von Attributelementen, die im mathematischen Ausdruck angegeben sind.
+ **AttributeItem**
Die Details zu einem einzelnen Attributelement, 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 ausschließlich die folgenden mathematischen Operationen: `+ - * /`
+ Nach der Erstellung einer berechneten Attributdefinition kann der Ausdruck nicht mehr geändert werden
+ **Bedingungen**
Definiert die Kriterien und den Schwellenwert für die Aggregation von berechneten Attributen.
+ Typ: Bedingungsobjekt
+ Bereich
+ ObjectCount
+ Threshold
+ **Bereich**
Der relative Zeitraum, während dem Daten in der Aggregation berücksichtigt werden.
+ Typ: Range-Objekt
+ Value: Der Zeitraum für die angegebenen Einheiten. `ValueRange` überschreibt „Value“.
+ Typ: Ganzzahl
+ Erforderlich: Nein
+ ValueRange: Eine Struktur, mit der Kunden ein relatives Zeitfenster angeben können, über das Daten in das berechnete Attribut aufgenommen werden. Verwenden Sie positive Zahlen, um anzuzeigen, dass der Endpunkt in der Vergangenheit liegt, und negative Zahlen, um anzuzeigen, dass er in der future liegt. ValueRangeüberschreibt den Wert.
+ Typ: ValueRange
+ Erforderlich: Nein
+ Starten
+ Die Anfangszeit, zu der Objekte aufgenommen werden. Verwenden Sie positive Zahlen, um anzugeben, dass der Startpunkt in der Vergangenheit liegt, und negative Zahlen, um anzugeben, dass er in der Zukunft liegt.
+ Typ: Ganzzahl
+ Erforderlich: Ja
+ Ende
+ Die Endzeit, zu der Objekte aufgenommen werden. Verwenden Sie positive Zahlen, um anzugeben, dass der Startpunkt in der Vergangenheit liegt, und negative Zahlen, um anzugeben, dass er in der Zukunft liegt.
+ Typ: Ganzzahl
+ Erforderlich: Ja
+ TimestampSource: Ein Ausdruck, der das Feld in Ihrem JSON-Objekt angibt, aus dem das Datum analysiert werden soll. Der Ausdruck sollte der Struktur von\\ "{ObjectTypeNamefolgen. }\\“. Wenn Ihr Objekttyp beispielsweise ist MyType und die Quell-JSON ist`{"generatedAt": {"timestamp": "1737587945945"}}`, dann TimestampSource sollte es so sein`"{MyType.generatedAt.timestamp}"`.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
+ Erforderlich: Nein
+ TimestampFormat: Das Format des Zeitstempelfeldes in Ihrem JSON-Objekt ist angegeben. Dieser Wert sollte einer von EPOCHMILLI (für Unix-Epochenzeitstempel mit second/millisecond Ebenengenauigkeit) oder ISO\_8601 (entspricht dem ISO\_8601-Format mit Ebenengenauigkeit, mit einem optionalen Offset von Z oder im Format second/millisecond HH:MM oder HHMM.) sein. Wenn Ihr Objekttyp beispielsweise ist und die JSON-Quelle ist, dann sollte es auch so sein. MyType `{"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}},` TimestampFormat `"ISO_8601"`
+ Einheit: Zeiteinheit
+ Zulässige Werte: Days
+ Erforderlich: Ja
+ Erforderlich: Ja
+ Anfänglicher Geltungsbereich: Maximal 366 Tage
+ **ObjectCount**
Die Anzahl der für das berechnete Attribut verwendeten Profilobjekte.
+ Typ: Zahl
+ Range: 1 bis 100
+ Erforderlich: Nein
+ **Threshold**
Die Vergleichslogik zur Generierung eines true/false berechneten Attributs.
+ Typ: Threshold-Objekt
+ Wert
+ Der Schwellenwert.
+ Typ: Zeichenfolge
+ Erforderlich: Nein
+ Operator
+ Der Operator des Schwellenwerts
+ Typ: ENUM
+ Zulässige Werte:
+ GREATER\_THAN
+ LESS\_THAN
+ EQUAL\_TO
+ NOT\_EQUAL\_TO
+ Erforderlich: Nein
+ **Statistik**
Der für das berechnete Attribut auszuführende Aggregationsvorgang.
+ Typ: ENUM
+ Zulässige Werte:
+ FIRST\_OCCURRENCE
+ LAST\_OCCURRENCE
+ COUNT
+ SUM
+ MINIMUM
+ MAXIMUM
+ AVERAGE
+ MAX\_OCCURRENCE
------
#### [ UpdateCalculatedAttributeDefinition ]
**UpdateCalculatedAttributeDefinition**
Aktualisieren der Definition eines berechneten Attributs. Aktualisierungen sind auf den Anzeigenamen, die Beschreibung, den Zeitraum, die Anzahl der Objekte und den Schwellenwert beschränkt. Diese API unterstützt teilweise Aktualisierungen, sodass nur die zu aktualisierenden Parameter gesendet werden.
**Anmerkung**
Beachten Sie bei der Aktualisierung der Bedingungen Folgendes:
Eine Erhöhung des Datumsbereichs eines berechneten Attributs löst keine Berücksichtigung von Verlaufsdaten außerhalb des aktuellen Datumsbereichs.
TimestampSource und TimestampFormat kann nicht aktualisiert werden, nachdem eine berechnete Attributdefinition erstellt wurde.
**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": {}
}
```
**Anforderungstext**
+ **DisplayName**
Der Anzeigename des berechneten Attributs.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 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 beträgt 1 Zeichen. Höchstlänge = 1 000 Zeichen.
+ Erforderlich: Nein
+ **Bedingungen**
Definiert die Kriterien und den Schwellenwert für die Aggregation von berechneten Attributen.
+ Typ: Bedingungsobjekt
+ Bereich
+ ObjectCount
+ Threshold
+ **Bereich**
Der relative Zeitraum, während dem Daten in der Aggregation berücksichtigt werden.
+ Typ: Range-Objekt
+ Wert: Der Zeitraum für die angegebenen Einheiten
+ Typ: Ganzzahl
+ Erforderlich: Nein
+ ValueRange: Eine Struktur, mit der Kunden ein relatives Zeitfenster angeben können, über das Daten in das berechnete Attribut aufgenommen werden. Verwenden Sie positive Zahlen, um anzuzeigen, dass der Endpunkt in der Vergangenheit liegt, und negative Zahlen, um anzuzeigen, dass er in der future liegt. ValueRangeüberschreibt den Wert.
+ Typ: ValueRange
+ Erforderlich: Nein
+ Starten
+ Die Anfangszeit, zu der Objekte aufgenommen werden. Verwenden Sie positive Zahlen, um anzugeben, dass der Startpunkt in der Vergangenheit liegt, und negative Zahlen, um anzugeben, dass er in der Zukunft liegt.
+ Typ: Ganzzahl
+ Erforderlich: Ja
+ Ende
+ Die Endzeit, zu der Objekte aufgenommen werden. Verwenden Sie positive Zahlen, um anzugeben, dass der Startpunkt in der Vergangenheit liegt, und negative Zahlen, um anzugeben, dass er in der Zukunft liegt.
+ Typ: Ganzzahl
+ Erforderlich: Ja
+ Einheit: Zeiteinheit
+ Zulässige Werte: Days
+ Erforderlich: Ja
+ Erforderlich: Ja
+ Anfänglicher Geltungsbereich: Maximal 366 Tage
+ **ObjectCount**
Die Anzahl der für das berechnete Attribut verwendeten Profilobjekte.
+ Typ: Zahl
+ Range: 1 bis 100
+ Erforderlich: Nein
+ **Threshold**
Die Vergleichslogik zum Generieren eines true/false berechneten Attributs.
+ Typ: Threshold-Objekt
+ Wert
+ Der Schwellenwert.
+ Typ: Zeichenfolge
+ Erforderlich: Nein
+ Operator
+ Der Operator des Schwellenwerts
+ Typ: ENUM
+ Zulässige Werte:
+ GREATER\_THAN
+ LESS\_THAN
+ EQUAL\_TO
+ NOT\_EQUAL\_TO
+ Erforderlich: Nein
------
#### [ GetCalculatedAttributeDefinition ]
**GetCalculatedAttributeDefinition**
Abrufen der Definition eines berechneten Attributs.
**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": {
"Unit": "string",
"Value": number
"ValueRange"
{
"Start": number
"End": number
},
"TimestampFormat": "string",
"TimestampSource": "string"
},
"ObjectCount": "number",
"Threshold": {
"Value": "string",
"Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
}
},
"UseHistoricalData" boolean,
"Status": "PREPARING" | "IN_PROGRESS" | "COMPLETED" | "FAILED",
"Readiness": {
"ProgressPercentage": number,
"Message": "string",
},
"CreatedAt": number,
"LastUpdatedAt": number,
"Tags": {}
}
```
**URI-Anfrageparameter**
+ **DomainName**
Der eindeutige Name der Domain.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 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 beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
+ Pattern: `^[a-zA-Z0-9_-]+$`
+ Erforderlich: Ja
------
#### [ DeleteCalculatedAttributeDefinition ]
**DeleteCalculatedAttributeDefinition**
Löschen der Definition eines vorhandenen berechneten Attributs. Das Löschen eines berechneten Standardattributs ist zwar möglich, jedoch kann dieser Vorgang nicht rückgängig gemacht werden. Sie müssten das Attribut mithilfe der `CreateCalculatedAttributeDefinition`-API bei Bedarf selbst neu erstellen.
**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-Anfrageparameter**
+ **DomainName**
Der eindeutige Name der Domain.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 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 beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
+ Pattern: `^[a-zA-Z0-9_-]+$`
+ Erforderlich: Ja
------
#### [ ListCalculatedAttributeDefinitions ]
**ListCalculatedAttributeDefinitions**
Abrufen aller berechneten Attributdefinitionen für eine Domain.
**Anforderung**
```
GET /domains/{{DomainName}}/calculated-attributes?max-results=MaxResults&next-token=NextToken
```
**Anforderungstext**
```
The request does not have a request body.
```
**Antwort**
```
{
"Items": [
{
"UseHistoricalData": boolean,
"ReadinessStatus": PREPARING | IN_PROGRESS | COMPLETED | FAILED,
"CalculatedAttributeName": "string",
"CreatedAt": number,
"Description": "string",
"DisplayName": "string",
"LastUpdatedAt": number,
"Tags": {
"string" : "string"
}
}
],
"NextToken": "string"
}
```
**URI-Anfrageparameter**
+ **DomainName**
Der eindeutige Name der Domain.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
+ Pattern: `^[a-zA-Z0-9_-]+$`
+ Erforderlich: Ja
+ **MaxResults**
Die maximale Anzahl der zurückgegebenen Objekte pro Seite.
+ Gültiger Bereich: Mindestwert 1. Maximalwert 100
+ **NextToken**
Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 024 Zeichen.
------
#### [ 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",
"IsDataPartial": "string",
"LastObjectTimestamp" : number
}
```
**URI-Anfrageparameter**
+ **DomainName**
Der eindeutige Name der Domain.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 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 beträgt 1 Zeichen. Maximale Länge beträgt 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",
"LastObjectTimestamp" : number
},
...
],
"NextToken": "string"
}
```
**URI-Anfrageparameter**
+ **DomainName**
Der eindeutige Name der Domain.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
+ Pattern: `^[a-zA-Z0-9_-]+$`
+ Erforderlich: Ja
+ **ProfileId**
+ Pattern: `[a-f0-9]{32}`
+ Erforderlich: Ja
+ **MaxResults**
Die maximale Anzahl der zurückgegebenen Objekte pro Seite.
+ Gültiger Bereich: Mindestwert 1. Maximalwert 100
+ **NextToken**
Das Paginierungstoken aus dem vorherigen ListCalculatedAttributeDefinition API-Aufruf.
+ Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 1 024 Zeichen.
------