UpdateDashboard - Amazon QuickSight
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere 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.

UpdateDashboard

Aktualisiert ein Dashboard in einerAWSKonto.

Anmerkung

Durch das Aktualisieren eines Dashboards wird eine neue Dashboard-Version erstellt, die neue Version wird jedoch nicht sofort veröffentlicht. Sie können die veröffentlichte Version eines Dashboards mit der Status eines Dashboards aktualisieren. UpdateDashboardPublishedVersion API-Operation.

Anforderungssyntax

PUT /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" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

AwsAccountId

Die ID derAWSKonto, das das Dashboard enthält, das Sie aktualisieren.

Längenbeschränkungen: Feste Länge von 12.

Pattern: ^[0-9]{12}$

Erforderlich: Ja

DashboardId

Die ID für das Dashboard.

Längenbeschränkungen: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.

Pattern: [\w\-]+

Erforderlich: 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: Ja

SourceEntity

Die Entität, die Sie als Quelle verwenden, wenn Sie das Dashboard aktualisieren. In :SourceEntitygeben Sie den Objekttyp an, den Sie als Quelle verwenden. Sie können ein Dashboard nur aus einer Vorlage aktualisieren, also verwenden Sie eineSourceTemplate-Entität. Wenn Sie ein Dashboard aus einer Analyse aktualisieren müssen, konvertieren Sie die Analyse zunächst in eine Vorlage, indem Sie die CreateTemplate API-Operation. FürSourceTemplategeben Sie den Amazon-Ressourcenname (ARN) der Quellvorlage an. DieSourceTemplateARN kann beliebige enthaltenAWSKonto und irgendein Amazon QuickSight-unterstütztAWS-Region.

Verwenden derDataSetReferencesEntitä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: Ja

DashboardPublishOptions

Optionen zum Veröffentlichen des Dashboards bei der Erstellung:

  • AvailabilityStatuszumAdHocFilteringOption- Dieser Status kann sowohlENABLEDoderDISABLED. Wenn diese Eigenschaft ist aufDISABLED, Amazon QuickSight deaktiviert den linken Filterbereich im veröffentlichten Dashboard, der für die (einmalige) Ad-hoc-Filterung verwendet werden kann. Dieser Option istENABLEDstandardmäßig.

  • AvailabilityStatuszumExportToCSVOption- Dieser Status kann sowohlENABLEDoderDISABLED. Die visuelle Option zum Exportieren von Daten in das CSV-Format ist nicht aktiviert, wenn diese Einstellung aufDISABLED. Dieser Option istENABLEDstandardmäßig.

  • VisibilityStatezumSheetControlsOption- Dieser Sichtbarkeitsstatus kann entwederCOLLAPSEDoderEXPANDED. Dieser Option istCOLLAPSEDstandardmäßig.

Typ: DashboardPublishOptions Objekt

Erforderlich: Nein

Parameters

Eine Struktur, die die Parameter des Dashboards enthält. Dies sind Parameter-Überschreibungen für ein Dashboard. Ein Dashboard kann jede Art von Parametern haben, und einige Parameter akzeptieren möglicherweise mehrere Werte.

Typ: Parameters Objekt

Erforderlich: Nein

ThemeArn

Der Amazon-Ressourcenname (ARN) des Themes, das für dieses Dashboard verwendet wird. Wenn Sie einen Wert für dieses Feld hinzufügen, wird der Wert überschrieben, der Entität ursprünglich zugeordnet war. Der Theme-ARN muss in derselben Eigenschaft vorhanden seinAWSKonto, in dem Sie das Dashboard erstellen.

Type: String

Erforderlich: Nein

VersionDescription

Eine Beschreibung für die erste Version des Dashboards, die gerade erstellt wird.

Type: String

Längenbeschränkungen: Mindestlänge 1. Maximale Länge von 512.

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "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.

Arn

Der Amazon-Ressourcenname (ARN) der Ressource.

Type: String

CreationStatus

Der Erstellungsstatus der Anfrage.

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

DieAWSAnforderungs-ID für diese Operation.

Type: String

Status

Der HTTP-Status der Anforderung.

Type: Ganzzahl

VersionArn

Der ARN des Dashboards, einschließlich der Versionsnummer.

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.

HTTStatus Code: 409

InternalFailureException

Es ist ein interner Fehler aufgetreten.

HTTStatus Code: 500

InvalidParameterValueException

Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.

HTTStatus Code: 400

LimitExceededException

Ein Limit wurde überschritten.

HTTStatus Code: 409

ResourceNotFoundException

Mindestens eine Ressource kann nicht gefunden werden.

HTTStatus Code: 404

ThrottlingException

Der Zugriff wird gedrosselt

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

HTTStatus Code: 403

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: