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.
CreateDashboard
Erstellt ein Dashboard aus einer Vorlage. Informationen zum Erstellen einer Vorlage finden Sie unter der API-Operation
CreateTemplate
.
Ein Dashboard ist eine Entität bei Amazon QuickSight das identifiziert Amazon QuickSight Berichte, die aus Analysen erstellt wurden. Sie können Amazon teilen QuickSight Dashboards. Mit den richtigen Berechtigungen können Sie aus den Dashboards geplante E-Mail-Berichte erstellen. Wenn Sie die richtigen Berechtigungen haben, können Sie ein Dashboard aus einer Vorlage erstellen, die sich in einem anderenAWSKonto.
Anforderungssyntax
POST /accounts/AwsAccountId
/dashboards/DashboardId
HTTP/1.1
Content-type: application/json
{
"DashboardPublishOptions": {
"AdHocFilteringOption": {
"AvailabilityStatus": "string
"
},
"ExportToCSVOption": {
"AvailabilityStatus": "string
"
},
"SheetControlsOption": {
"VisibilityState": "string
"
}
},
"Name": "string
",
"Parameters": {
"DateTimeParameters": [
{
"Name": "string
",
"Values": [ number
]
}
],
"DecimalParameters": [
{
"Name": "string
",
"Values": [ number
]
}
],
"IntegerParameters": [
{
"Name": "string
",
"Values": [ number
]
}
],
"StringParameters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
]
},
"Permissions": [
{
"Actions": [ "string
" ],
"Principal": "string
"
}
],
"SourceEntity": {
"SourceTemplate": {
"Arn": "string
",
"DataSetReferences": [
{
"DataSetArn": "string
",
"DataSetPlaceholder": "string
"
}
]
}
},
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"ThemeArn": "string
",
"VersionDescription": "string
"
}
URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
- AwsAccountId
-
Die ID derAWSKonto, in dem Sie das Dashboard erstellen möchten.
Längenbeschränkungen: Feste Länge von 12.
Pattern:
^[0-9]{12}$
Erforderlich lich lich Ja
- DashboardId
-
Die ID für das Dashboard, die ebenfalls der -IAM-Richtlinie hinzugefügt wird.
Längenbeschränkungen: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.
Pattern:
[\w\-]+
Erforderlich lich lich Ja
Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
- Name
-
Der Anzeigename des Dashboards.
Type: String
Längenbeschränkungen: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.
Erforderlich lich lich Ja
- SourceEntity
-
Die Entität, die Sie beim Erstellen des Dashboards als Quelle verwenden. In :
SourceEntity
geben Sie den Objekttyp an, den Sie als Quelle verwenden. Sie können ein Dashboard nur aus einer Vorlage erstellen.SourceTemplate
-Entität. Wenn Sie ein Dashboard aus einer Analyse erstellen müssen, konvertieren Sie die Analyse zunächst in eine Vorlage, indem Sie dieCreateTemplate
API-Operation. FürSourceTemplate
geben Sie den Amazon-Ressourcenname (ARN) der Quellvorlage an. DieSourceTemplate
ARN kann beliebige enthaltenAWSKonto und irgendein Amazon QuickSight-unterstütztAWS-Region.Verwenden der
DataSetReferences
Entität innerhalbSourceTemplate
, um die Ersatz-Datensätze für die im Original aufgeführten Platzhalter aufzulisten. Das Schema in jedem Datensatz muss mit seinem Platzhalter übereinstimmen.Typ: DashboardSourceEntity Objekt
Erforderlich lich lich Ja
- DashboardPublishOptions
-
Optionen zum Veröffentlichen des Dashboards bei der Erstellung:
-
AvailabilityStatus
zumAdHocFilteringOption
- Dieser Status kann eines der Folgenden seinENABLED
oderDISABLED
. Wenn diese Eigenschaft festgelegt istDISABLED
, Amazon QuickSight deaktiviert den linken Filterbereich im veröffentlichten Dashboard, der für die (einmalige) Ad-hoc-Filterung verwendet werden kann. Dieser Option istENABLED
standardmäßig in der Standard- -
AvailabilityStatus
zumExportToCSVOption
- Dieser Status kann eines der Folgenden seinENABLED
oderDISABLED
. Die visuelle Option zum Exportieren von Daten in das CSV-Format ist nicht aktiviert, wenn diese Einstellung aufDISABLED
. Dieser Option istENABLED
standardmäßig in der Standard- -
VisibilityState
zumSheetControlsOption
- Dieser Sichtbarkeitsstatus kann entwederCOLLAPSED
oderEXPANDED
. Dieser Option istCOLLAPSED
standardmäßig in der Standard-
Typ: DashboardPublishOptions Objekt
Erforderlich lich lich Nein
-
- Parameters
-
Die Parameter für die Erstellung des Dashboards, die Sie verwenden möchten, um die Standardeinstellungen außer Kraft zu setzen. Ein Dashboard kann jede Art von Parametern haben, und einige Parameter akzeptieren möglicherweise mehrere Werte.
Typ: Parameters Objekt
Erforderlich lich lich Nein
- Permissions
-
Eine Struktur mit den Berechtigungen des Dashboards. Sie können diese Struktur zum Erteilen von Berechtigungen verwenden, indem Sie eine Liste mit IAM-Aktionsinformationen für jeden Principal-ARN bereitstellen.
Wenn Sie keine Berechtigungen angeben möchten, lassen Sie die Berechtigungsliste weg.
Type: Array vonResourcePermissionObjekte
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 64 Elemente.
Erforderlich lich lich Nein
- Tags
-
Enthält eine Zuordnung der Schlüssel-Wert-Paare für das oder die Ressourcen-Tags, die dem Dashboard zugewiesen sind.
Type: Array vonTagObjekte
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 200 Elemente.
Erforderlich lich lich Nein
- ThemeArn
-
Der Amazon-Ressourcenname (ARN) des Themas, das für dieses Dashboard verwendet wird. Wenn Sie einen Wert für dieses Feld hinzufügen, wird der Wert überschrieben, der in der Quellentität verwendet wird. Die Themen-ARN muss in derselben vorhanden seinAWSKonto, in dem Sie das Dashboard erstellen.
Type: String
Erforderlich lich lich Nein
- VersionDescription
-
Eine Beschreibung für die erste Version des Dashboards, die erstellt wird.
Type: String
Längenbeschränkungen: Mindestlänge 1. Maximale Länge von 512.
Erforderlich lich lich Nein
Antwortsyntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"DashboardId": "string",
"RequestId": "string",
"VersionArn": "string"
}
Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.
- Status
-
Der HTTP-Status der Anforderung.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
- Arn
-
Die ARN des Dashboards.
Type: String
- CreationStatus
-
Der Status der Dashray-Erstellungsanfrage.
Type: String
Zulässige Werte:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DashboardId
-
Die ID für das Dashboard.
Type: String
Längenbeschränkungen: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.
Pattern:
[\w\-]+
- RequestId
-
DieAWSAnforderungscode für diese Operation.
Type: String
- VersionArn
-
Der ARN des Dashboards, einschließlich der Versionsnummer der ersten Version, die erstellt wird.
Type: String
Fehler
Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unterHäufige Fehler.
- ConflictException
-
Das Aktualisieren oder Löschen einer Ressource kann zu einem inkonsistenten Zustand führen.
HTTP Status code: 409
- InternalFailureException
-
Es ist ein interner Fehler aufgetreten.
HTTP Status code: 500
- InvalidParameterValueException
-
Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.
HTTP Status code: 400
- ResourceExistsException
-
Die angegebene Ressource ist bereits vorhanden.
HTTP Status code: 409
- ResourceNotFoundException
-
Mindestens eine Ressource kann nicht gefunden werden.
HTTP Status code: 404
- ThrottlingException
-
Der Zugriff wird gedrosselt
HTTP Status code: 429
- UnsupportedUserEditionException
-
Dieser Fehler zeigt an, dass Sie eine Operation bei Amazon durchführen QuickSightAbonnement, bei dem die Edition keine Unterstützung für diesen Vorgang enthält. Amazon QuickSight verfügt derzeit über eine Standard Edition und eine Enterprise Edition. Nicht jede Operation und Funktion ist in jeder Version verfügbar ist.
HTTP Status code: 403
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: