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

DescribeDashboard

Stellt eine Zusammenfassung für ein Dashboard bereit.

Anforderungssyntax

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

AliasName

Der Aliasname.

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

Pattern: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

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

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

VersionNumber

Die Versionsnummer für das Dashboard. Wenn keine Versionsnummer übergeben wird, wird die zuletzt veröffentlichte Dashboard-Version beschrieben.

Gültiger Bereich: Der Mindestwert ist 1.

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 Status
Content-type: application/json

{
   "Dashboard": { 
      "Arn": "string",
      "CreatedTime": number,
      "DashboardId": "string",
      "LastPublishedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "Version": { 
         "Arn": "string",
         "CreatedTime": number,
         "DataSetArns": [ "string" ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Sheets": [ 
            { 
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   },
   "RequestId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.

Status

Der HTTP-Status dieser Anforderung.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Dashboard

Informationen über das Armaturenbrett.

Typ: Dashboard Objekt

RequestId

DieAWSAnforderungs-ID für diese Operation.

Type: String

Fehler

Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unterHäufige Fehler.

AccessDeniedException

Sie haben keinen Zugriff auf diese Komponente. Die bereitgestellten Anmeldeinformationen konnten nicht überprüft werden. Sie sind möglicherweise nicht berechtigt, die Anforderung auszuführen. Stellen Sie sicher, dass Ihr Konto für die Nutzung von Amazon autorisiert ist QuickSight -Service, dass Ihre -Richtlinien die korrekten Berechtigungen besitzen und dass Sie die richtigen Zugriffsschlüssel verwenden.

HTTP-Statuscode: 401

InternalFailureException

Es ist ein interner Fehler aufgetreten.

HTTP-Statuscode: 500

InvalidParameterValueException

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

HTTP-Statuscode: 400

ResourceNotFoundException

Mindestens eine Ressource kann nicht gefunden werden.

HTTP-Statuscode: 404

ThrottlingException

Der Zugriff wird gedrosselt

HTTP-Statuscode: 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-Statuscode: 403

Weitere Informationen finden Sie unter:

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